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

Plugin annotation

@Fixer(
 id = "psr4ify"
)

Hierarchy

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

1 file declares its use of PSR4

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

File

src/Plugin/DMU/Fixer/PSR4.php, line 16

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Fixer

class PSR4 extends FixerBase {

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

    /** @var \Pharborist\Objects\ClassNode $class */
    $class = $this->target
      ->getIndexer('class')
      ->get($this->configuration['source']);
    $ns = substr($this->configuration['destination'], 0, strrpos($this->configuration['destination'], '\\'));
    $doc = RootNode::create($ns);
    $ns = $doc
      ->getNamespace($ns);
    WhitespaceNode::create("\n")
      ->appendTo($ns);
    $import = [];
    if ($parent = $class
      ->getExtends()) {
      $import[] = $parent
        ->getAbsolutePath();
    }
    $interfaces = $class
      ->getImplementList();
    if ($interfaces) {
      foreach ($interfaces
        ->getItems() as $interface) {
        $import[] = $interface
          ->getAbsolutePath();
      }
    }
    foreach ($class
      ->getMethods() as $method) {
      foreach ($method
        ->getParameters() as $parameter) {
        $type_hint = $parameter
          ->getTypeHint();
        if ($type_hint instanceof NameNode) {
          $import[] = $type_hint
            ->getAbsolutePath();
        }
      }
    }
    foreach (array_unique($import) as $i) {
      Parser::parseSnippet('use ' . ltrim($i, '\\') . ';')
        ->appendTo($ns);
      WhitespaceNode::create("\n")
        ->appendTo($ns);
    }
    WhitespaceNode::create("\n")
      ->appendTo($ns);
    $class
      ->remove()
      ->appendTo($ns);
    $search_for = [
      'Drupal\\' . $this->target
        ->id(),
      '\\',
    ];
    $replace_with = [
      'src',
      '/',
    ];
    $path = str_replace($search_for, $replace_with, $this->configuration['destination']) . '.php';
    file_put_contents($this->target
      ->getPath($path), $doc
      ->getText());
  }

}

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
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
PSR4::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
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.