You are here

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

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

Plugin annotation


@Converter(
 id = "user_hooks",
 description = @Translation("Alters implementations of hook_user_insert(), hook_user_presave(), and hook_user_update()."),
 hook = {
   "hook_user_insert",
   "hook_user_presave",
   "hook_user_update"
 }
)

Hierarchy

Expanded class hierarchy of UserHooks

File

src/Plugin/DMU/Converter/UserHooks.php, line 25

Namespace

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

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('string_translation'), $container
      ->get('logger.factory')
      ->get('drupalmoduleupgrader'), $container
      ->get('plugin.manager.drupalmoduleupgrader.rewriter')
      ->createInstance('_rewriter:user'));
  }

  /**
   * {@inheritdoc}
   */
  public function convert(TargetInterface $target) {
    $indexer = $target
      ->getIndexer('function');
    $hooks = array_filter($this->pluginDefinition['hook'], [
      $indexer,
      'has',
    ]);
    foreach ($hooks as $hook) {

      /** @var \Pharborist\Functions\FunctionDeclarationNode $function */
      $function = $indexer
        ->get($hook);

      // The $edit parameter is defunct in Drupal 8, but we'll leave it in
      // there as an empty array to prevent errors, and move it to the back
      // of the line.

      /** @var \Pharborist\Functions\ParameterNode $edit */
      $edit = $function
        ->getParameterList()
        ->shift()
        ->setReference(FALSE)
        ->setValue(NullNode::create());
      $function
        ->appendParameter($edit);

      // Slap a FIXME on the hook implementation, informing the developer that
      // $edit and $category are dead.
      $comment = $function
        ->getDocComment();
      $comment_text = $comment ? $comment
        ->getCommentText() : '';
      if ($comment_text) {
        $comment_text .= "\n\n";
      }
      $comment_text .= <<<'END'
@FIXME
The $edit and $category parameters are gone in Drupal 8. They have been left
here in order to prevent 'undefined variable' errors, but they will never
actually be passed to this hook. You'll need to modify this function and
remove every reference to them.
END;
      $function
        ->setDocComment(DocCommentNode::create($comment_text));
      $this
        ->rewriteFunction($this->rewriter, $function
        ->getParameterAtIndex(0), $target);
      $target
        ->save($function);
    }
  }

}

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
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::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.
UserHooks::$rewriter protected property
UserHooks::convert public function Performs required conversions. Overrides ConverterInterface::convert
UserHooks::create public static function Creates an instance of the plugin. Overrides PluginBase::create
UserHooks::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct