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

Plugin annotation

@Indexer(
 id = "constant"
)

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\ArrayIndexer
        • class \Drupal\drupalmoduleupgrader\Plugin\DMU\Indexer\Constants implements IndexerUsageInterface

File

src/Plugin/DMU/Indexer/Constants.php, line 22

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Indexer

class Constants extends ArrayIndexer implements IndexerUsageInterface {

  /**
   * {@inheritdoc}
   */
  public function addFile($path) {
    Parser::parseFile($path)
      ->find(Filter::isInstanceOf('\\Pharborist\\Constants\\ConstantNode', '\\Pharborist\\Functions\\DefineNode', '\\Pharborist\\Constants\\ConstantDeclarationNode'))
      ->each([
      $this,
      'add',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function add(NodeInterface $node) {
    if ($node instanceof DefineNode) {
      list($key, $value) = $node
        ->getArguments();
      if ($key instanceof StringNode && $value instanceof ScalarNode) {
        $this->elements[$key
          ->toValue()] = $value
          ->toValue();
      }
    }
    elseif ($node instanceof ConstantDeclarationNode) {
      $value = $node
        ->getValue();
      if ($value instanceof ScalarNode) {
        $this->elements[(string) $node
          ->getName()] = $value
          ->toValue();
      }
    }
    elseif ($node instanceof ConstantNode) {
      $this->db
        ->insert($this->table)
        ->fields([
        'id' => (string) $node
          ->getConstantName(),
        // Hardcoding file name, as file name resolution is unavailable due
        // to changes upstream in Pharborist.
        'file' => 'foo.module',
      ])
        ->execute();
    }
    else {
      throw new \InvalidArgumentException('Unexpected node type (expected DefineNode, ConstantDeclarationNode, or ConstantNode).');
    }
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
ArrayIndexer::$elements	protected	property
ArrayIndexer::get	final public	function	Overrides IndexerInterface::get
ArrayIndexer::getAll	final public	function	Overrides IndexerBase::getAll
ArrayIndexer::getMultiple	final public	function	Overrides IndexerBase::getMultiple
ArrayIndexer::hasAll	final public	function	Overrides IndexerBase::hasAll
ArrayIndexer::hasAny	final public	function	Overrides IndexerBase::hasAny
Constants::add	public	function	Overrides IndexerBase::add
Constants::addFile	public	function	Overrides IndexerInterface::addFile
Constants::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::getFields	public	function	Overrides IndexerInterface::getFields	2
IndexerBase::getQuery	public	function	Overrides IndexerInterface::getQuery	1
IndexerBase::has	public	function	Overrides IndexerInterface::has	1
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.