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

Plugin annotation

@Fixer(
 id = "implement_hook"
)

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\ImplementHook implements ContainerFactoryPluginInterface

1 file declares its use of ImplementHook

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

File

src/Plugin/DMU/Fixer/ImplementHook.php, line 17

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Fixer

class ImplementHook extends FixerBase implements ContainerFactoryPluginInterface {
  protected $moduleHandler;
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $module_handler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('module_handler'));
  }

  /**
   * {@inheritdoc}
   */
  public function execute() {
    $this->moduleHandler
      ->loadInclude($this->configuration['module'], 'php', 'api');
    $hook = $this->configuration['hook'];
    $function = FunctionDeclarationNode::create($this->target
      ->id() . '_' . $hook);
    $function
      ->setDocComment(DocCommentNode::create('Implements hook_' . $hook));
    $reflector = new \ReflectionFunction('hook_' . $hook);
    $function
      ->matchReflector($reflector);
    $module = $this->target
      ->getPath('.module');
    $doc = $this->target
      ->open($module)
      ->append($function);
    $this->target
      ->save($doc);
  }

}

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.
ImplementHook::$moduleHandler	protected	property
ImplementHook::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ImplementHook::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
ImplementHook::__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.