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

Base class for fixers, containing a lot of helpful utilities.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\drupalmoduleupgrader\FixerBase implements FixerInterface

9 files declare their use of FixerBase

CreateClass.php in src/Plugin/DMU/Fixer/CreateClass.php

Define.php in src/Plugin/DMU/Fixer/Define.php

Delete.php in src/Plugin/DMU/Fixer/Delete.php

FormCallbackToMethod.php in src/Plugin/DMU/Fixer/FormCallbackToMethod.php

HookToYAML.php in src/Plugin/DMU/Fixer/HookToYAML.php

... See full list

File

src/FixerBase.php, line 11

Namespace

Drupal\drupalmoduleupgrader

abstract class FixerBase extends CorePluginBase implements FixerInterface {

  /**
   * @var \Drupal\drupalmoduleupgrader\TargetInterface
   */
  protected $target;

  /**
   * {@inheritdoc}
   */
  public function setTarget(TargetInterface $target) {
    $this->target = $target;
  }
  protected function getUnaliasedPath($path) {
    return preg_replace('/^~/', $this->target
      ->getBasePath(), $path);
  }

  /**
   * Returns if a node uses a specific trait anywhere in its lineage.
   *
   * @param \Pharborist\NodeInterface $node
   *
   * @return bool
   */
  protected function usesTrait($trait, NodeInterface $node) {
    $hierarchy = class_parents($node);
    array_unshift($hierarchy, get_class($node));
    $traits = [];
    foreach ($hierarchy as $parent) {
      $this
        ->collectTraits($parent, $traits);
    }
    return in_array($trait, $traits);
  }
  private function collectTraits($class, array &$all_traits = []) {
    $traits = class_uses($class);
    foreach ($traits as $trait) {
      $this
        ->collectTraits($trait, $traits);
    }
    $all_traits += $traits;
  }

}

Members

Name	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
ExecutableInterface::execute	public	function	Executes the plugin.	20
FixerBase::$target	protected	property
FixerBase::collectTraits	private	function
FixerBase::getUnaliasedPath	protected	function
FixerBase::setTarget	public	function	Sets the target module to operate on. Overrides FixerInterface::setTarget
FixerBase::usesTrait	protected	function	Returns if a node uses a specific trait anywhere in its lineage.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.