You are here

class Node in Freelinking 4.0.x

Same name and namespace in other branches
  1. 8.3 src/Plugin/freelinking/Node.php \Drupal\freelinking\Plugin\freelinking\Node

Node ID freelinking plugin.

Allows for a link link [[node:<nid>]], [[n:<nid>]], or [[node:<nid>]] to be expanded to a link to the node with the title associated with that node ID. A "could not find nid" message is displayed if the node could not be found.

Plugin annotation


@Freelinking(
  id = "nid",
  title = @Translation("Node ID"),
  weight = 0,
  hidden = false,
  settings = {  }
)

Hierarchy

Expanded class hierarchy of Node

1 file declares its use of Node
NodeTest.php in tests/src/Unit/Plugin/freelinking/NodeTest.php

File

src/Plugin/freelinking/Node.php, line 27

Namespace

Drupal\freelinking\Plugin\freelinking
View source
class Node extends FreelinkingPluginBase implements ContainerFactoryPluginInterface {

  /**
   * Entity Type Manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Initialize method.
   *
   * @param array $configuration
   *   The configuration array.
   * @param string $plugin_id
   *   The plugin identifier.
   * @param array $plugin_definition
   *   The plugin definition array.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entityTypeManager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entityTypeManager;
  }

  /**
   * {@inheritdoc}
   */
  public function getIndicator() {
    return '/(n(id|ode)?)$/A';
  }

  /**
   * {@inheritdoc}
   */
  public function getTip() {
    return $this
      ->t('Click to view a local node');
  }

  /**
   * {@inheritdoc}
   */
  public function buildLink(array $target) {

    // Failover.
    $link = [
      '#theme' => 'freelink_error',
      '#plugin' => 'nid',
    ];

    // Attempt to load the node by the node ID provided by target destination.
    $node = $this->entityTypeManager
      ->getStorage('node')
      ->load($target['dest']);
    if (NULL !== $node && $node instanceof NodeInterface) {

      // Get target.
      if ($target['language']
        ->getId() !== $node
        ->language()
        ->getId()) {
        $node = $node
          ->getTranslation($target['language']
          ->getId());
      }
      $link = [
        '#type' => 'link',
        '#title' => isset($target['text']) ? $target['text'] : $node
          ->label(),
        '#url' => Url::fromRoute('entity.node.canonical', [
          'node' => $node
            ->id(),
        ], [
          'language' => $target['language'],
        ]),
        '#attributes' => [
          'title' => isset($target['tooltip']) ? $target['tooltip'] : $this
            ->getTip(),
        ],
      ];
    }
    else {

      // Save some processing by generating the translation link for failover later.
      $link['#message'] = $this
        ->t('Invalid node ID @nid', [
        '@nid' => $target['dest'],
      ]);
    }
    return $link;
  }

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

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FreelinkingPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
FreelinkingPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 6
FreelinkingPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration 1
FreelinkingPluginBase::getFailoverPluginId public function Get the failover plugin ID (if applicable). Overrides FreelinkingPluginInterface::getFailoverPluginId 1
FreelinkingPluginBase::isHidden public function Determine if the plugin is built-in (always on). Overrides FreelinkingPluginInterface::isHidden
FreelinkingPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
FreelinkingPluginBase::settingsForm public function Plugin configuration form. Overrides FreelinkingPluginInterface::settingsForm 6
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
Node::$entityTypeManager protected property Entity Type Manager.
Node::buildLink public function Build a link with the plugin. Overrides FreelinkingPluginInterface::buildLink
Node::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Node::getIndicator public function A regular expression string to indicate what to replace for this plugin. Overrides FreelinkingPluginInterface::getIndicator
Node::getTip public function Provides tips for this freelinking plugin. Overrides FreelinkingPluginInterface::getTip
Node::__construct public function Initialize method. Overrides PluginBase::__construct
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 2
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. 4
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.