You are here

Home » API reference » Drupal 7 to 8/9 Module Upgrader 8 » EntityHooks.php

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

Plugin annotation


@Converter(
 id = "entity_hooks",
 description = @Translation("Rewrites various entity-related hooks."),
 hook = {
   "hook_comment_delete",
   "hook_comment_insert",
   "hook_comment_presave",
   "hook_comment_update",
   "hook_node_access",
   "hook_node_access_records",
   "hook_node_access_records_alter",
   "hook_node_delete",
   "hook_node_grants",
   "hook_node_grants_alter",
   "hook_node_insert",
   "hook_node_presave",
   "hook_node_revision_delete",
   "hook_node_search_result",
   "hook_node_submit",
   "hook_node_update",
   "hook_node_update_index",
   "hook_node_validate",
   "hook_taxonomy_term_delete",
   "hook_taxonomy_term_insert",
   "hook_taxonomy_term_presave",
   "hook_taxonomy_term_update",
   "hook_user_delete",
   "hook_user_logout"
 },
 dependencies = { "plugin.manager.drupalmoduleupgrader.rewriter" }
)

Hierarchy

Expanded class hierarchy of EntityHooks

File

src/Plugin/DMU/Converter/EntityHooks.php, line 44

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Converter
View source 
class EntityHooks extends ConverterBase {

  /**
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $rewriters;
  public function __construct(array $configuration, $plugin_id, $plugin_definition, TranslationInterface $translator, LoggerInterface $log, PluginManagerInterface $rewriters) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $translator, $log);
    $this->rewriters = $rewriters;
  }

  /**
   * {@inheritdoc}
   */
  public function convert(TargetInterface $target, $hook = NULL, $index = 0, $rewriter_id = NULL) {
    $indexer = $target
      ->getIndexer('function');
    if (isset($hook)) {
      if ($indexer
        ->has($hook)) {
        if (empty($rewriter_id)) {

          // Extract the entity type from the hook (e.g. 'hook_node_delete').
          preg_match('/^hook_(.+)_[a-z]+$/', $hook, $matches);
          $rewriter_id = '_rewriter:' . $matches[1];
        }
        $rewriter = $this->rewriters
          ->createInstance($rewriter_id);
        $this
          ->rewriteFunction($rewriter, $indexer
          ->get($hook)
          ->getParameterAtIndex($index), $target);
      }
    }
    else {
      $this
        ->convert($target, 'hook_comment_delete');
      $this
        ->convert($target, 'hook_comment_insert');
      $this
        ->convert($target, 'hook_comment_presave');
      $this
        ->convert($target, 'hook_comment_update');
      $this
        ->convert($target, 'hook_node_access');
      $this
        ->convert($target, 'hook_node_access', 2, '_rewriter:account');
      $this
        ->convert($target, 'hook_node_access_records', 0, '_rewriter:node');
      $this
        ->convert($target, 'hook_node_access_records_alter', 1, '_rewriter:node');
      $this
        ->convert($target, 'hook_node_delete');
      $this
        ->convert($target, 'hook_node_grants', 0, '_rewriter:account');
      $this
        ->convert($target, 'hook_node_grants_alter', 1, '_rewriter:account');
      $this
        ->convert($target, 'hook_node_insert');
      $this
        ->convert($target, 'hook_node_presave');
      $this
        ->convert($target, 'hook_node_revision_delete');
      $this
        ->convert($target, 'hook_node_search_result');
      $this
        ->convert($target, 'hook_node_submit');
      $this
        ->convert($target, 'hook_node_submit', 2, 'form_state');
      $this
        ->convert($target, 'hook_node_update');
      $this
        ->convert($target, 'hook_node_update_index');
      $this
        ->convert($target, 'hook_node_validate');
      $this
        ->convert($target, 'hook_node_validate', 2, 'form_state');
      $this
        ->convert($target, 'hook_taxonomy_term_delete');
      $this
        ->convert($target, 'hook_taxonomy_term_insert');
      $this
        ->convert($target, 'hook_taxonomy_term_presave');
      $this
        ->convert($target, 'hook_taxonomy_term_update');
      $this
        ->convert($target, 'hook_user_delete');
      $this
        ->convert($target, 'hook_user_logout');
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConverterBase::buildFixMe protected function Builds a FIXME notice using either the text in the plugin definition, or passed-in text.
ConverterBase::DOC_COMMENT constant
ConverterBase::executeHook protected function Executes the target module's implementation of the specified hook, and returns the result.
ConverterBase::implement protected function Creates an empty implementation of a hook.
ConverterBase::isExecutable public function Returns if this conversion applies to the target module. If FALSE, the convert() method will not be called. Overrides ConverterInterface::isExecutable 4
ConverterBase::LINE_COMMENT constant
ConverterBase::parse protected function Parses a generated class into a syntax tree.
ConverterBase::rewriteFunction protected function Parametrically rewrites a function.
ConverterBase::write public function Writes a file to the target module's directory.
ConverterBase::writeClass public function Writes a class to the target module's PSR-4 root.
ConverterBase::writeInfo protected function Writes out arbitrary data in YAML format.
ConverterBase::writeService protected function Writes a service definition to the target module's services.yml file.
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
EntityHooks::$rewriters protected property
EntityHooks::convert public function Performs required conversions. Overrides ConverterInterface::convert
EntityHooks::__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::$log protected property
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
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.