class views_plugin_argument_default_variable in Variable 7.2

Default argument plugin to provide a variable value.

Hierarchy

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

1 string reference to 'views_plugin_argument_default_variable'

variable_views_views_plugins in variable_views/variable_views.module

Implements hook_views_plugins()

File

variable_views/includes/views_plugin_argument_default_variable.inc, line 10

Contains the php code argument default plugin.

class views_plugin_argument_default_variable extends views_plugin_argument_default {
  function option_definition() {
    $options = parent::option_definition();
    $options['variable'] = array(
      'default' => '',
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['variable'] = array(
      '#type' => 'select',
      '#title' => t('Variable value'),
      '#options' => _variable_views_variable_list(),
      '#default_value' => $this->options['variable'],
      '#description' => t('Select a variable whose value will be retrieved at run time.'),
    );
  }
  function convert_options(&$options) {
    if (!isset($options['variable']) && isset($this->argument->options['default_argument_variable'])) {
      $options['variable'] = $this->argument->options['default_argument_variable'];
    }
  }

  /**
   * Only let users with PHP block visibility permissions set/modify this
   * default plugin.
   */
  function access() {
    return user_access('administer site configuration');
  }
  function get_argument() {
    return variable_get_value($this->options['variable']);
  }

}

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_default::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_default::init	public	function	Initialize this plugin with the view and the argument it is linked to.	1
views_plugin_argument_default::options_submit	public	function	Provide the default form form for submitting options. Overrides views_plugin::options_submit	1
views_plugin_argument_default::options_validate	public	function	Provide the default form form for validating options. Overrides views_plugin::options_validate
views_plugin_argument_default_variable::access		function	Only let users with PHP block visibility permissions set/modify this default plugin. Overrides views_plugin_argument_default::access
views_plugin_argument_default_variable::convert_options		function	Convert options from the older style. Overrides views_plugin_argument_default::convert_options
views_plugin_argument_default_variable::get_argument		function	Return the default argument. Overrides views_plugin_argument_default::get_argument
views_plugin_argument_default_variable::options_form		function	Provide the default form for setting options. Overrides views_plugin_argument_default::options_form
views_plugin_argument_default_variable::option_definition		function	Retrieve the options when this is a new access control plugin. Overrides views_plugin_argument_default::option_definition