class views_plugin_argument_default in Views (for Drupal 7) 6.2

The fixed argument default handler; also used as the base.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_default

Related topics

Views' argument default plugins

Allow specialized methods of filling in arguments when they aren't provided.

1 string reference to 'views_plugin_argument_default'

views_views_plugins in includes/plugins.inc

Implementation of hook_views_plugins

File

plugins/views_plugin_argument_default.inc, line 20

Contains the fixed argument default plugin.

class views_plugin_argument_default extends views_plugin {
  var $option_name = 'default_argument_fixed';

  /**
   * 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) {
    $form[$this->option_name] = array(
      '#type' => 'textfield',
      '#title' => t('Default argument'),
      '#default_value' => $this
        ->get_argument(),
      '#process' => array(
        'views_process_dependency',
      ),
      '#dependency' => array(
        'radio:options[default_action]' => array(
          'default',
        ),
        'radio:options[default_argument_type]' => array(
          $this->id,
        ),
      ),
      '#dependency_count' => 2,
    );

    // Only do this if using one simple standard form gadget
    $this
      ->check_access($form);
  }

  /**
   * 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 default argument type, this setting will be lost and you will NOT be able to get it back.') . '</strong>';
    }
  }

  /**
   * Return the default argument.
   */
  function get_argument() {
    return isset($this->argument->options[$this->option_name]) ? $this->argument->options[$this->option_name] : '';
  }

}

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_default::$option_name		property		3
views_plugin_argument_default::access		function	Determine if the administrator has the privileges to use this plugin	1
views_plugin_argument_default::argument_form		function		4
views_plugin_argument_default::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_default::get_argument		function	Return the default argument.	5
views_plugin_argument_default::init		function	Initialize this plugin with the view and the argument it is linked to. Overrides views_plugin::init