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

Plugin annotation

@Converter(
 id = "hook_node_prepare",
 description = @Translation("Converts hook_node_prepare() into hook_ENTITY_TYPE_prepare_form()."),
 hook = "hook_node_prepare",
 dependencies = { "plugin.manager.drupalmoduleupgrader.rewriter" }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\drupalmoduleupgrader\PluginBase implements ContainerFactoryPluginInterface
      • class \Drupal\drupalmoduleupgrader\ConverterBase implements ConverterInterface
        • class \Drupal\drupalmoduleupgrader\Plugin\DMU\Converter\HookNodePrepare

File

src/Plugin/DMU/Converter/HookNodePrepare.php, line 20

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Converter

class HookNodePrepare 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) {

    /** @var \Pharborist\Functions\FunctionDeclarationNode $function */
    $function = $target
      ->getIndexer('function')
      ->get('hook_node_prepare');

    // foo_node_prepare() --> foo_node_prepare_form().
    $function
      ->setName($function
      ->getName() . '_form');

    // The first parameter is a node, so rewrite the function accordingly.
    $this->rewriters
      ->createInstance('_entity:node')
      ->rewrite($function
      ->getParameterAtIndex(0));

    // Create the $operation parameter.
    $function
      ->appendParameter(ParameterNode::create('operation'));

    // Create the $form_state parameter.
    $form_state = ParameterNode::create('form_state')
      ->setTypeHint('\\Drupal\\Core\\Form\\FormStateInterface');
    $function
      ->appendParameter($form_state);
    $target
      ->save($function);
  }

}

Members

Name	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
HookNodePrepare::$rewriters	protected	property
HookNodePrepare::convert	public	function	Performs required conversions. Overrides ConverterInterface::convert
HookNodePrepare::__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.