class Node

Validate whether an argument is an acceptable node.

Plugin annotation


@Plugin(
  id = "node",
  module = "node",
  title = @Translation("Content")
)

Hierarchy

Expanded class hierarchy of Node

47 string references to 'Node'
comment_token_info in drupal/core/modules/comment/comment.tokens.inc
Implements hook_token_info().
field_views_field_default_views_data in drupal/core/modules/field/field.views.inc
Default views data implementation for a field.
file_field_views_data_views_data_alter in drupal/core/modules/file/file.views.inc
Implements hook_field_views_data_views_data_alter().
forum_views_data in drupal/core/modules/forum/forum.views.inc
Implements hook_views_data().
image_field_views_data_views_data_alter in drupal/core/modules/image/image.views.inc
Implements hook_field_views_data_views_data_alter().

... See full list

File

drupal/core/modules/node/lib/Drupal/node/Plugin/views/argument_validator/Node.php, line 23
Definition of Drupal\node\Plugin\views\argument_validator\Node.

Namespace

Drupal\node\Plugin\views\argument_validator
View source
class Node extends ArgumentValidatorPluginBase {
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['types'] = array(
      'default' => array(),
    );
    $options['access'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['access_op'] = array(
      'default' => 'view',
    );
    $options['nid_type'] = array(
      'default' => 'nid',
    );
    return $options;
  }
  public function buildOptionsForm(&$form, &$form_state) {
    $types = node_type_get_types();
    $options = array();
    foreach ($types as $type => $info) {
      $options[$type] = check_plain(t($info->name));
    }
    $form['types'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Content types'),
      '#options' => $options,
      '#default_value' => $this->options['types'],
      '#description' => t('Choose one or more content types to validate with.'),
    );
    $form['access'] = array(
      '#type' => 'checkbox',
      '#title' => t('Validate user has access to the content'),
      '#default_value' => $this->options['access'],
    );
    $form['access_op'] = array(
      '#type' => 'radios',
      '#title' => t('Access operation to check'),
      '#options' => array(
        'view' => t('View'),
        'update' => t('Edit'),
        'delete' => t('Delete'),
      ),
      '#default_value' => $this->options['access_op'],
      '#states' => array(
        'visible' => array(
          ':input[name="options[validate][options][node][access]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $form['nid_type'] = array(
      '#type' => 'select',
      '#title' => t('Filter value format'),
      '#options' => array(
        'nid' => t('Node ID'),
        'nids' => t('Node IDs separated by , or +'),
      ),
      '#default_value' => $this->options['nid_type'],
    );
  }
  public function submitOptionsForm(&$form, &$form_state, &$options = array()) {

    // filter trash out of the options so we don't store giant unnecessary arrays
    $options['types'] = array_filter($options['types']);
  }
  public function validateArgument($argument) {
    $types = $this->options['types'];
    switch ($this->options['nid_type']) {
      case 'nid':
        if (!is_numeric($argument)) {
          return FALSE;
        }
        $node = node_load($argument);
        if (!$node) {
          return FALSE;
        }
        if (!empty($this->options['access'])) {
          if (!node_access($this->options['access_op'], $node)) {
            return FALSE;
          }
        }

        // Save the title() handlers some work.
        $this->argument->validated_title = check_plain($node
          ->label());
        if (empty($types)) {
          return TRUE;
        }
        return isset($types[$node->type]);
      case 'nids':
        $nids = new stdClass();
        $nids->value = array(
          $argument,
        );
        $nids = $this
          ->breakPhrase($argument, $nids);
        if ($nids->value == array(
          -1,
        )) {
          return FALSE;
        }
        $test = drupal_map_assoc($nids->value);
        $titles = array();
        $nodes = node_load_multiple($nids->value);
        foreach ($nodes as $node) {
          if ($types && empty($types[$node->type])) {
            return FALSE;
          }
          if (!empty($this->options['access'])) {
            if (!node_access($this->options['access_op'], $node)) {
              return FALSE;
            }
          }
          $titles[] = check_plain($node
            ->label());
          unset($test[$node->nid]);
        }
        $this->argument->validated_title = implode($nids->operator == 'or' ? ' + ' : ', ', $titles);

        // If this is not empty, we did not find a nid.
        return empty($test);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ArgumentValidatorPluginBase::$argument protected property The argument handler instance associated with this plugin.
ArgumentValidatorPluginBase::access public function Determine if the administrator has the privileges to use this plugin 1
ArgumentValidatorPluginBase::checkAccess protected function If we don't have access to the form but are showing it anyway, ensure that the form is safe and cannot be changed from user input.
ArgumentValidatorPluginBase::processSummaryArguments public function Process the summary arguments for displaying. 2
ArgumentValidatorPluginBase::setArgument public function Sets the parent argument this plugin is associated with.
ArgumentValidatorPluginBase::validateOptionsForm public function Provide the default form form for validating options Overrides PluginBase::validateOptionsForm
ContainerFactoryPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
Node::buildOptionsForm public function Provide the default form for setting options. Overrides ArgumentValidatorPluginBase::buildOptionsForm
Node::defineOptions protected function Retrieve the options when this is a new access control plugin Overrides ArgumentValidatorPluginBase::defineOptions
Node::submitOptionsForm public function Provide the default form form for submitting options Overrides ArgumentValidatorPluginBase::submitOptionsForm
Node::validateArgument public function Overrides ArgumentValidatorPluginBase::validateArgument
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::init public function Initialize the plugin. 8
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::query public function Add anything to the query that we might need to. 13
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct