class views_plugin_argument_default_raw in Views (for Drupal 7) 6.3

Default argument plugin to use the raw value from the URL.

Hierarchy

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

1 string reference to 'views_plugin_argument_default_raw'

views_views_plugins in includes/plugins.inc

Implementation of hook_views_plugins

File

plugins/views_plugin_argument_default_raw.inc, line 10

Contains the raw value argument default plugin.

class views_plugin_argument_default_raw extends views_plugin_argument_default {
  function option_definition() {
    $options = parent::option_definition();
    $options['index'] = array(
      'default' => '',
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {

    // Using range(1, 10) will create an array keyed 0-9, which allows arg() to
    // properly function since it is also zero-based.
    $form['index'] = array(
      '#type' => 'select',
      '#title' => t('Path component'),
      '#default_value' => $this->options['index'],
      '#options' => range(1, 10),
      '#description' => t('The numbering starts from 1, e.g. on the page admin/structure/types, the 3rd path component is "types".'),
    );
  }
  function get_argument() {
    if ($arg = arg($this->options['index'])) {
      return $arg;
    }
  }

}

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_default::access		function	Determine if the administrator has the privileges to use this plugin	1
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::convert_options		function	Convert options from the older style.	4
views_plugin_argument_default::init		function	Initialize this plugin with the view and the argument it is linked to.
views_plugin_argument_default::options_submit		function	Provide the default form form for submitting options Overrides views_plugin::options_submit	1
views_plugin_argument_default::options_validate		function	Provide the default form form for validating options Overrides views_plugin::options_validate
views_plugin_argument_default_raw::get_argument		function	Return the default argument. Overrides views_plugin_argument_default::get_argument
views_plugin_argument_default_raw::options_form		function	Provide the default form for setting options. Overrides views_plugin_argument_default::options_form
views_plugin_argument_default_raw::option_definition		function	Retrieve the options when this is a new access control plugin Overrides views_plugin_argument_default::option_definition