Node.php

Same filename in this branch
  1. 10 core/modules/node/src/Entity/Node.php
  2. 10 core/modules/node/src/Plugin/views/field/Node.php
  3. 10 core/modules/node/src/Plugin/views/wizard/Node.php
  4. 10 core/modules/node/src/Plugin/migrate/source/d6/Node.php
  5. 10 core/modules/node/src/Plugin/migrate/source/d7/Node.php
Same filename in other branches
  1. 9 core/modules/node/src/Entity/Node.php
  2. 9 core/modules/node/src/Plugin/views/field/Node.php
  3. 9 core/modules/node/src/Plugin/views/wizard/Node.php
  4. 9 core/modules/node/src/Plugin/views/argument_default/Node.php
  5. 9 core/modules/node/src/Plugin/migrate/source/d6/Node.php
  6. 9 core/modules/node/src/Plugin/migrate/source/d7/Node.php
  7. 8.9.x core/modules/node/src/Entity/Node.php
  8. 8.9.x core/modules/node/src/Plugin/views/field/Node.php
  9. 8.9.x core/modules/node/src/Plugin/views/wizard/Node.php
  10. 8.9.x core/modules/node/src/Plugin/views/argument_default/Node.php
  11. 8.9.x core/modules/node/src/Plugin/migrate/source/d6/Node.php
  12. 8.9.x core/modules/node/src/Plugin/migrate/source/d7/Node.php
  13. 11.x core/modules/node/src/Entity/Node.php
  14. 11.x core/modules/node/src/Plugin/views/field/Node.php
  15. 11.x core/modules/node/src/Plugin/views/wizard/Node.php
  16. 11.x core/modules/node/src/Plugin/views/argument_default/Node.php
  17. 11.x core/modules/node/src/Plugin/migrate/source/d6/Node.php
  18. 11.x core/modules/node/src/Plugin/migrate/source/d7/Node.php

Namespace

Drupal\node\Plugin\views\argument_default

File

core/modules/node/src/Plugin/views/argument_default/Node.php

View source
<?php

namespace Drupal\node\Plugin\views\argument_default;

use Drupal\Core\Cache\Cache;
use Drupal\Core\Cache\CacheableDependencyInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\views\Attribute\ViewsArgumentDefault;
use Drupal\views\Plugin\views\argument_default\ArgumentDefaultPluginBase;
use Drupal\node\NodeInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Default argument plugin to extract a node.
 */
class Node extends ArgumentDefaultPluginBase implements CacheableDependencyInterface {
    
    /**
     * The route match.
     *
     * @var \Drupal\Core\Routing\RouteMatchInterface
     */
    protected $routeMatch;
    
    /**
     * Constructs a new Node instance.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin ID for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   The route match.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->routeMatch = $route_match;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('current_route_match'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getArgument() {
        // Get the node object from current route.
        $node = $this->routeMatch
            ->getParameter('node') ?? $this->routeMatch
            ->getParameter('node_preview');
        if ($node instanceof NodeInterface) {
            return $node->id();
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheMaxAge() {
        return Cache::PERMANENT;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        return [
            'url',
        ];
    }

}

Classes

Title Deprecated Summary
Node Default argument plugin to extract a node.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.