class views_plugin_argument_validate in Views (for Drupal 7) 6.3

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 {

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

  /**
   * Retrieve the options when this is a new access
   * control plugin
   */
  function option_definition() {
    return array();
  }

  /**
   * Provide the default form for setting options.
   */
  function options_form(&$form, &$form_state) {
  }

  /**
   * Provide the default form form for validating options
   */
  function options_validate(&$form, &$form_state) {
  }

  /**
   * Provide the default form form for submitting options
   */
  function options_submit(&$form, &$form_state) {
  }

  /**
   * Convert options from the older style.
   *
   * In Views 3, the method of storing default argument options has changed
   * and each plugin now gets its own silo. This method can be used to
   * move arguments from the old style to the new style. See
   * views_plugin_argument_default_fixed for a good example of this method.
   */
  function convert_options(&$options) {
  }

  /**
   * Determine if the administrator has the privileges to use this plugin
   */
  function access() {
    return TRUE;
  }

  /**
   * 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.
   *
   * This is only called by child objects if specified in the options_form(),
   * so it will not always be used.
   */
  function check_access(&$form, $option_name) {
    if (!$this
      ->access()) {
      $form[$option_name]['#disabled'] = TRUE;
      $form[$option_name]['#value'] = $form[$this->option_name]['#default_value'];
      $form[$option_name]['#description'] .= ' <strong>' . t('Note: you do not have permission to modify this. If you change the default argument type, this setting will be lost and you will NOT be able to get it back.') . '</strong>';
    }
  }
  function validate_argument($arg) {
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_object::$definition		property	Handler's definition
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.	6
views_object::destroy		function		2
views_object::export_option		function		1
views_object::export_options		function
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::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::unpack_translatable		function	Unpack a single option definition.
views_object::unpack_translatables		function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults		function
views_plugin::$display		property	The current used views display.
views_plugin::$plugin_type		property	The plugin type of this plugin, for example style or query.
views_plugin::$view		property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions		function	Provide a list of additional theme functions for the theme information page
views_plugin::query		function	Add anything to the query that we might need to.	7
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::access		function	Determine if the administrator has the privileges to use this plugin	1
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::convert_options		function	Convert options from the older style.	4
views_plugin_argument_validate::init		function	Initialize this plugin with the view and the argument it is linked to.
views_plugin_argument_validate::options_form		function	Provide the default form for setting options. Overrides views_plugin::options_form	4
views_plugin_argument_validate::options_submit		function	Provide the default form form for submitting options Overrides views_plugin::options_submit	3
views_plugin_argument_validate::options_validate		function	Provide the default form form for validating options Overrides views_plugin::options_validate
views_plugin_argument_validate::option_definition		function	Retrieve the options when this is a new access control plugin Overrides views_object::option_definition	4
views_plugin_argument_validate::validate_argument		function		5