src/applications/search/index/PhabricatorIndexEngineExtension.php

   1 <?php
   2
   3 abstract class PhabricatorIndexEngineExtension extends Phobject {
   4
   5   private $parameters;
   6   private $forceFullReindex;
   7
   8   public function setParameters(array $parameters) {
   9     $this->parameters = $parameters;
  10     return $this;
  11   }
  12
  13   public function getParameter($key, $default = null) {
  14     return idx($this->parameters, $key, $default);
  15   }
  16
  17   final public function getExtensionKey() {
  18     return $this->getPhobjectClassConstant('EXTENSIONKEY');
  19   }
  20
  21   final protected function getViewer() {
  22     return PhabricatorUser::getOmnipotentUser();
  23   }
  24
  25   abstract public function getExtensionName();
  26
  27   abstract public function shouldIndexObject($object);
  28
  29   abstract public function indexObject(
  30     PhabricatorIndexEngine $engine,
  31     $object);
  32
  33   public function getIndexVersion($object) {
  34     return null;
  35   }
  36
  37   final public static function getAllExtensions() {
  38     return id(new PhutilClassMapQuery())
  39       ->setAncestorClass(__CLASS__)
  40       ->setUniqueMethod('getExtensionKey')
  41       ->execute();
  42   }
  43
  44   final public function shouldForceFullReindex() {
  45     return $this->getParameter('force');
  46   }
  47
  48 }