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

Plugin annotation

@Fixer(
 id = "notify"
)

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\Notify uses NodeCollectorTrait

1 file declares its use of Notify

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

File

src/Plugin/DMU/Fixer/Notify.php, line 15

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Fixer

class Notify extends FixerBase {
  use NodeCollectorTrait;

  /**
   * {@inheritdoc}
   */
  public function execute() {
    foreach ($this
      ->getObjects() as $node) {
      $comment = $this
        ->getComment($node);
      if ($comment) {
        $comment .= "\n\n";
      }
      $this
        ->setComment($node, $comment . $this->configuration['note']);
    }
    $this->target
      ->save();
  }
  protected function getComment(NodeInterface $node) {
    if ($this
      ->supportsDocComments($node)) {

      /** @var \Pharborist\DocCommentTrait $node */
      $comment = $node
        ->getDocComment() ?: DocCommentNode::create('');
      return $comment
        ->getCommentText();
    }
    else {
      return '';
    }
  }
  protected function setComment(NodeInterface $node, $comment_text) {
    if ($this
      ->supportsDocComments($node)) {

      /** @var \Pharborist\DocCommentTrait $node */
      $node
        ->setDocComment(DocCommentNode::create($comment_text));
    }
    else {
      LineCommentBlockNode::create($comment_text)
        ->insertBefore($node
        ->getStatement());
    }
  }

  /**
   * Returns if a node supports doc comments by importing DocCommentTrait
   * anywhere in its lineage.
   *
   * @param \Pharborist\NodeInterface $node
   *
   * @return bool
   */
  protected function supportsDocComments(NodeInterface $node) {
    return $this
      ->usesTrait('Pharborist\\DocCommentTrait', $node);
  }

}

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.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
NodeCollectorTrait::getObjects	protected	function
Notify::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute	1
Notify::getComment	protected	function
Notify::setComment	protected	function
Notify::supportsDocComments	protected	function	Returns if a node supports doc comments by importing DocCommentTrait anywhere in its lineage.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.