You are here

Home » API reference » Drupal 7 to 8/9 Module Upgrader 8 » IndexerBase.php

abstract class IndexerBase in Drupal 7 to 8/9 Module Upgrader 8

Base class for indexers.

Hierarchy

Expanded class hierarchy of IndexerBase

3 files declare their use of IndexerBase
Classes.php in src/Plugin/DMU/Indexer/Classes.php
FunctionCalls.php in src/Plugin/DMU/Indexer/FunctionCalls.php
Functions.php in src/Plugin/DMU/Indexer/Functions.php

File

src/IndexerBase.php, line 15

Namespace

Drupal\drupalmoduleupgrader
View source 
abstract class IndexerBase extends CorePluginBase implements IndexerInterface, ContainerFactoryPluginInterface {

  /**
   * @var \Drupal\Core\Database\Connection
   */
  protected $db;

  /**
   * @var TargetInterface
   */
  protected $target;

  /**
   * @var string
   */
  protected $table;
  public function __construct(array $configuration, $plugin_id, $plugin_definition, DatabaseConnection $db, TargetInterface $target = NULL) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->db = $db;
    if ($target) {
      $this
        ->bind($target);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('database'));
  }

  /**
   * {@inheritdoc}
   */
  public function bind(TargetInterface $module) {
    $this->target = $module;
    $this->table = $module
      ->id() . '__' . $this
      ->getPluginId();
    $schema = $this->db
      ->schema();
    if ($schema
      ->tableExists($this->table)) {
      $this
        ->clear();
    }
    else {
      $schema
        ->createTable($this->table, [
        'fields' => $this
          ->getFields(),
      ]);
    }
    $this
      ->build();
  }

  /**
   * {@inheritdoc}
   */
  public function build() {

    /** @var \Symfony\Component\Finder\SplFileInfo $file */
    foreach ($this->target
      ->getFinder() as $file) {
      $this
        ->addFile($file
        ->getPathname());
    }
  }

  /**
   * {@inheritdoc}
   */
  public function clear() {
    $this->db
      ->truncate($this->table)
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function destroy() {
    $this->db
      ->schema()
      ->dropTable($this->table);
  }

  /**
   * {@inheritdoc}
   */
  public function has($identifier) {
    return (bool) $this
      ->getQuery()
      ->condition('id', $identifier)
      ->countQuery()
      ->execute()
      ->fetchField();
  }

  /**
   * {@inheritdoc}
   */
  public function hasAny(array $identifiers) {
    return $this
      ->has($identifiers);
  }

  /**
   * {@inheritdoc}
   */
  public function hasAll(array $identifiers) {
    $count = $this
      ->getQuery()
      ->condition('id', $identifiers)
      ->countQuery()
      ->execute()
      ->fetchField();
    return $count == sizeof(array_unique($identifiers));
  }

  /**
   * {@inheritdoc}
   */
  public function add(NodeInterface $node) {
    $this->db
      ->insert($this->table)
      ->fields([
      'id' => (string) $node
        ->getName(),
      'file' => $node
        ->getFilename(),
    ])
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function deleteFile($path) {
    $this->db
      ->delete($this->table)
      ->condition('file', $path)
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function delete($identifier) {
    $this->db
      ->delete($this->table)
      ->condition('id', $identifier)
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function getMultiple(array $identifiers) {
    return new NodeCollection(array_filter(array_map([
      $this,
      'get',
    ], $identifiers)));
  }

  /**
   * {@inheritdoc}
   */
  public function getAll() {
    return $this
      ->getMultiple($this
      ->getQuery([
      'id',
    ])
      ->distinct()
      ->execute()
      ->fetchCol());
  }

  /**
   * {@inheritdoc}
   */
  public function getFields() {
    return [
      'id' => [
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
      ],
      'file' => [
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getQuery(array $fields = []) {
    return $this->db
      ->select($this->table)
      ->fields($this->table, $fields);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
IndexerBase::$db protected property
IndexerBase::$table protected property
IndexerBase::$target protected property
IndexerBase::add public function Overrides IndexerInterface::add 3
IndexerBase::bind public function Overrides IndexerInterface::bind
IndexerBase::build public function Overrides IndexerInterface::build 1
IndexerBase::clear public function Overrides IndexerInterface::clear
IndexerBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
IndexerBase::delete public function Overrides IndexerInterface::delete 1
IndexerBase::deleteFile public function Overrides IndexerInterface::deleteFile
IndexerBase::destroy public function Overrides IndexerInterface::destroy
IndexerBase::getAll public function Overrides IndexerInterface::getAll 1
IndexerBase::getFields public function Overrides IndexerInterface::getFields 2
IndexerBase::getMultiple public function Overrides IndexerInterface::getMultiple 2
IndexerBase::getQuery public function Overrides IndexerInterface::getQuery 1
IndexerBase::has public function Overrides IndexerInterface::has 1
IndexerBase::hasAll public function Overrides IndexerInterface::hasAll 2
IndexerBase::hasAny public function Overrides IndexerInterface::hasAny 2
IndexerBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
IndexerInterface::addFile public function 4
IndexerInterface::get public function 4
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.