class views_plugin_argument_validate in Views (for Drupal 7) 6.2

Base argument validator plugin to provide basic functionality.

Hierarchy

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

Related topics

Views' argument validate plugins

Allow specialized methods of validating arguments.

Views' argument validate plugins

Allow specialized methods of validating arguments.

1 string reference to 'views_plugin_argument_validate'

views_views_plugins in includes/plugins.inc

Implementation of hook_views_plugins

File

plugins/views_plugin_argument_validate.inc, line 21

Contains the base argument validator plugin.

class views_plugin_argument_validate extends views_plugin {
  var $option_name = 'validate_argument';

  /**
   * Initialize this plugin with the view and the argument
   * it is linked to.
   */
  function init(&$view, &$argument, $id = NULL) {
    $this->view =& $view;
    $this->argument =& $argument;
    $this->id = $id;
  }

  /**
   * Determine if the administrator has the privileges to use this
   * plugin
   */
  function access() {
    return TRUE;
  }
  function argument_form(&$form, &$form_state) {
  }

  /**
   * 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.
   */
  function check_access(&$form) {
    if (!$this
      ->access()) {
      $form[$this->option_name]['#disabled'] = TRUE;
      $form[$this->option_name]['#value'] = $form[$this->option_name]['#default_value'];
      $form[$this->option_name]['#description'] .= ' <strong>' . t('Note: you do not have permission to modify this. If you change the validator, this setting will be lost and you will NOT be able to get it back.') . '</strong>';
    }
  }

  /**
   * Return the validate argument.
   */
  function get_argument() {
    return isset($this->argument->options[$this->option_name]) ? $this->argument->options[$this->option_name] : '';
  }
  function validate_form(&$form, &$form_state) {
  }
  function validate_argument($arg) {
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_object::$options		property	Except for displays, options for the object will be held here.	1
views_object::construct		function	Views handlers use a special construct function so that we can more easily construct them with variable arguments.	5
views_object::destroy		function		2
views_object::options		function	Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.	1
views_object::option_definition		function	Information about options for all kinds of purposes will be held here.	9
views_object::set_default_options		function	Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition		function	Let the handler know what its full definition is.
views_object::unpack_options		function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::_set_option_defaults		function		1
views_plugin::additional_theme_functions		function	Provide a list of additional theme functions for the theme information page
views_plugin::options_form		function	Provide a form to edit options for this plugin.	5
views_plugin::options_submit		function	Handle any special handling on the validate form.	3
views_plugin::options_validate		function	Validate the options form.	3
views_plugin::query		function	Add anything to the query that we might need to.	3
views_plugin::theme_functions		function	Provide a full list of possible theme templates used by this style.
views_plugin::validate		function	Validate that the plugin is correct and can be saved.	2
views_plugin_argument_validate::$option_name		property		3
views_plugin_argument_validate::access		function	Determine if the administrator has the privileges to use this plugin	2
views_plugin_argument_validate::argument_form		function
views_plugin_argument_validate::check_access		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::get_argument		function	Return the validate argument.
views_plugin_argument_validate::init		function	Initialize this plugin with the view and the argument it is linked to. Overrides views_plugin::init
views_plugin_argument_validate::validate_argument		function		5
views_plugin_argument_validate::validate_form		function		4