class Classes in Drupal 7 to 8/9 Module Upgrader 8

Plugin annotation

@Indexer(
 id = "class"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\drupalmoduleupgrader\IndexerBase implements ContainerFactoryPluginInterface, IndexerInterface
      • class \Drupal\drupalmoduleupgrader\Plugin\DMU\Indexer\Classes implements IndexerUsageInterface

4 files declare their use of Classes

ClassesTest.php in tests/src/Unit/Plugin/DMU/Indexer/ClassesTest.php

CreateClassTest.php in tests/src/Unit/Plugin/DMU/Fixer/CreateClassTest.php

PSR4Test.php in tests/src/Unit/Plugin/DMU/Analyzer/PSR4Test.php

TestsTest.php in tests/src/Unit/Plugin/DMU/Analyzer/TestsTest.php

File

src/Plugin/DMU/Indexer/Classes.php, line 19

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Indexer

class Classes extends IndexerBase implements IndexerUsageInterface {

  /**
   * {@inheritdoc}
   */
  public function addFile($path) {
    $doc = Parser::parseFile($path);
    $doc
      ->find(Filter::isInstanceOf('\\Pharborist\\Objects\\ClassNode'))
      ->each([
      $this,
      'add',
    ]);
    $doc
      ->find(Filter::isInstanceOf('\\Pharborist\\Objects\\NewNode'))
      ->each([
      $this,
      'add',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function add(NodeInterface $node) {
    $fields = [
      'file' => $node
        ->getFilename(),
      'type' => get_class($node),
    ];
    if ($node instanceof ClassNode) {
      $fields['id'] = (string) $node
        ->getName();
      $fields['parent'] = (string) $node
        ->getExtends();
    }
    elseif ($node instanceof NewNode) {
      $fields['id'] = (string) $node
        ->getClassName();
    }
    else {
      throw new \InvalidArgumentException('Unexpected node type (expected ClassNode or NewNode).');
    }
    $this->db
      ->insert($this->table)
      ->fields($fields)
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function get($identifier) {
    $file = $this
      ->getQuery([
      'file',
    ])
      ->condition('id', $identifier)
      ->execute()
      ->fetchField();
    return $this->target
      ->open($file)
      ->find(Filter::isClass($identifier))
      ->get(0);
  }

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

  /**
   * {@inheritdoc}
   */
  public function getUsages($identifier) {
    $files = $this
      ->getQuery([
      'file',
    ])
      ->distinct()
      ->condition('id', $identifier)
      ->condition('type', 'Pharborist\\Objects\\NewNode')
      ->execute()
      ->fetchCol();
    $usages = new NodeCollection();
    foreach ($files as $file) {
      $this->target
        ->open($file)
        ->find(Filter::isInstanceOf('\\Pharborist\\Objects\\NewNode'))
        ->filter(function (NewNode $node) use ($identifier) {
        return $node
          ->getClassName() == $identifier;
      })
        ->addTo($usages);
    }
    return $usages;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Classes::add	public	function	Overrides IndexerBase::add
Classes::addFile	public	function	Overrides IndexerInterface::addFile
Classes::get	public	function	Overrides IndexerInterface::get
Classes::getFields	public	function	Overrides IndexerBase::getFields
Classes::getUsages	public	function	Overrides IndexerUsageInterface::getUsages
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::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::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
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.