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

Plugin annotation

@Fixer(
 id = "create_class"
)

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\CreateClass

1 file declares its use of CreateClass

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

File

src/Plugin/DMU/Fixer/CreateClass.php, line 18

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Fixer

class CreateClass extends FixerBase {

  /**
   * @var \Symfony\Component\Filesystem\Filesystem
   */
  protected $fs;
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->fs = new Filesystem();
  }
  public function execute() {
    $ns = $this
      ->extractNS($this->configuration['class']);
    $class = $this
      ->extractLocal($this->configuration['class']);
    $doc = RootNode::create($ns);
    $ns = $doc
      ->getNamespace($ns);
    Token::newline()
      ->insertBefore($ns);
    Token::newline()
      ->appendTo($ns);
    $class = ClassNode::create($class);
    if ($parent = $this->configuration['parent']) {
      Parser::parseSnippet('use ' . ltrim($parent, '\\') . ';')
        ->appendTo($ns)
        ->after(Token::newline());
      $class
        ->setExtends($this
        ->extractLocal($parent));
    }
    $interfaces = (array) $this->configuration['interfaces'];
    foreach ($interfaces as $interface) {
      Parser::parseSnippet('use ' . ltrim($interface, '\\') . ';')
        ->appendTo($ns)
        ->after(Token::newline());
    }
    $class
      ->setImplements(array_map([
      $this,
      'extractLocal',
    ], $interfaces));
    if (isset($this->configuration['doc'])) {
      $class
        ->setDocComment(DocCommentNode::create($this->configuration['doc']));
    }
    $class
      ->appendTo($ns)
      ->before(Token::newline());
    $destination = $this
      ->getUnaliasedPath($this->configuration['destination']);
    $dir = substr($destination, 0, strrpos($destination, '/'));
    $this->fs
      ->mkdir($dir);
    file_put_contents($destination, $doc
      ->getText());

    // Need to store the class' local name as its index identifier because
    // \Pharborist\Filter::isClass() doesn't support lookup by qualified path.
    $this->target
      ->getIndexer('class')
      ->addFile($destination);
  }
  protected function extractLocal($path) {
    return substr($path, strrpos($path, '\\') + 1);
  }
  protected function extractNS($path) {
    $path = ltrim($path, '\\');
    return substr($path, 0, strrpos($path, '\\'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CreateClass::$fs	protected	property
CreateClass::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
CreateClass::extractLocal	protected	function
CreateClass::extractNS	protected	function
CreateClass::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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.
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.