class views_plugin_argument_validate_node in Views (for Drupal 7) 7.3

Validate whether an argument is an acceptable node.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_validate
      • class \views_plugin_argument_validate_node

1 string reference to 'views_plugin_argument_validate_node'

node_views_plugins in modules/node.views.inc

Implements hook_views_plugins().

File

modules/node/views_plugin_argument_validate_node.inc, line 11

Definition of views_plugin_argument_validate_node.

class views_plugin_argument_validate_node extends views_plugin_argument_validate {

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $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;
  }

  /**
   * {@inheritdoc}
   */
  public function options_form(&$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'],
      '#dependency' => array(
        'edit-options-validate-options-node-access' => array(
          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'],
    );
  }

  /**
   * {@inheritdoc}
   */
  public function options_submit(&$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']);
  }

  /**
   * {@inheritdoc}
   */
  public function convert_options(&$options) {
    if (!isset($options['types']) && !empty($this->argument->options['validate_argument_node_type'])) {
      $options['types'] = isset($this->argument->options['validate_argument_node_type']) ? $this->argument->options['validate_argument_node_type'] : array();
      $options['access'] = !empty($this->argument->options['validate_argument_node_access']);
      $options['access_op'] = isset($this->argument->options['validate_argument_node_access_op']) ? $this->argument->options['validate_argument_node_access_op'] : 'view';
      $options['nid_type'] = isset($this->argument->options['validate_argument_nid_type']) ? $this->argument->options['validate_argument_nid_type'] : array();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function validate_argument($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->title);
        if (empty($types)) {
          return TRUE;
        }
        return isset($types[$node->type]);
        break;
      case 'nids':
        $nids = new stdClass();
        $nids->value = array(
          $argument,
        );
        $nids = views_break_phrase($argument, $nids);
        if ($nids->value == array(
          -1,
        )) {
          return FALSE;
        }
        $test = drupal_map_assoc($nids->value);
        $titles = array();
        $result = db_query("SELECT * FROM {node} WHERE nid IN (:nids)", array(
          ':nids' => $nids->value,
        ));
        foreach ($result 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->title);
          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

Name	Modifiers	Type	Description	Overrides
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::construct	public	function	Views handlers use a special construct function.	4
views_object::destroy	public	function	Destructor.	2
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::query	public	function	Add anything to the query that we might need to.	7
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin::validate	public	function	Validate that the plugin is correct and can be saved.	3
views_plugin_argument_validate::access	public	function	Determine if the administrator has the privileges to use this plugin.	1
views_plugin_argument_validate::check_access	public	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.
views_plugin_argument_validate::init	public	function	Initialize this plugin with the view and the argument it is linked to.	1
views_plugin_argument_validate::options_validate	public	function	Provide the default form form for validating options. Overrides views_plugin::options_validate
views_plugin_argument_validate::process_summary_arguments	public	function	Process the summary arguments for displaying.	2
views_plugin_argument_validate_node::convert_options	public	function	Convert options from the older style. Overrides views_plugin_argument_validate::convert_options
views_plugin_argument_validate_node::options_form	public	function	Provide the default form for setting options. Overrides views_plugin_argument_validate::options_form
views_plugin_argument_validate_node::options_submit	public	function	Provide the default form form for submitting options Overrides views_plugin_argument_validate::options_submit
views_plugin_argument_validate_node::option_definition	public	function	Retrieve the options when this is a new access control plugin. Overrides views_plugin_argument_validate::option_definition
views_plugin_argument_validate_node::validate_argument	public	function	Overrides views_plugin_argument_validate::validate_argument