Validate whether an argument is numeric or not. More...

Inheritance diagram for views_plugin_argument_validate_numeric:

Public Member Functions
	validate_argument ($argument)
	init (&$view, &$argument, $options)
	Initialize this plugin with the view and the argument it is linked to.
	option_definition ()
	Retrieve the options when this is a new access control plugin.
	options_form (&$form, &$form_state)
	Provide the default form for setting options.
	options_validate (&$form, &$form_state)
	Provide the default form form for validating options.
	options_submit (&$form, &$form_state, &$options=array())
	Provide the default form form for submitting options.
	options_submit (&$form, &$form_state)
	Handle any special handling on the validate form.
	convert_options (&$options)
	Convert options from the older style.
	access ()
	Determine if the administrator has the privileges to use this plugin.
	check_access (&$form, $option_name)
	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.
	process_summary_arguments (&$args)
	Process the summary arguments for displaying.
	query ()
	Add anything to the query that we might need to.
	theme_functions ()
	Provide a full list of possible theme templates used by this style.
	additional_theme_functions ()
	Provide a list of additional theme functions for the theme information page.
	validate ()
	Validate that the plugin is correct and can be saved.
	summary_title ()
	Returns the summary of the settings in the display.
	plugin_title ()
	Return the human readable name of the display.
	construct ()
	Views handlers use a special construct function so that we can more easily construct them with variable arguments.
	options (&$options)
	Set default options on this object.
	set_default_options ()
	Set default options.
	_set_option_defaults (&$storage, $options, $level=0)
	unpack_options (&$storage, $options, $definition=NULL, $all=TRUE, $check=TRUE, $localization_keys=array())
	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
	set_definition ($definition)
	Let the handler know what its full definition is.
	destroy ()
	export_options ($indent, $prefix)
	export_option ($indent, $prefix, $storage, $option, $definition, $parents)
	unpack_translatables (&$translatable, $parents=array())
	Unpacks each handler to store translatable texts.
	unpack_translatable (&$translatable, $storage, $option, $definition, $parents, $keys=array())
	Unpack a single option definition.
Public Attributes
	$view = NULL
	$display = NULL
	$plugin_type = NULL
	The plugin type of this plugin, for example style or query.
	$options = array()
	Except for displays, options for the object will be held here.
	$definition

Detailed Description

Validate whether an argument is numeric or not.

Definition at line 12 of file views_plugin_argument_validate_numeric.inc.

Member Function Documentation

views_plugin_argument_validate::access ( ) [inherited]

Determine if the administrator has the privileges to use this plugin.

Reimplemented in views_plugin_argument_validate_php.

Definition at line 69 of file views_plugin_argument_validate.inc.

Referenced by views_plugin_argument_validate::check_access().

{ return TRUE; }

views_plugin::additional_theme_functions ( ) [inherited]

Provide a list of additional theme functions for the theme information page.

Definition at line 518 of file plugins.inc.

References views_theme_functions().

Referenced by views_plugin_display::options_form().

                                        {
    $funcs = array();
    if (!empty($this->definition['additional themes'])) {
      foreach ($this->definition['additional themes'] as $theme => $type) {
        $funcs[] = views_theme_functions($theme, $this->view, $this->display);
      }
    }
    return $funcs;
  }

views_plugin_argument_validate::check_access	(	&$	form,
		$	option_name
	)			`[inherited]`

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.

Definition at line 78 of file views_plugin_argument_validate.inc.

References views_plugin_argument_validate::access().

Referenced by views_plugin_argument_validate_php::options_form().

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

views_object::construct ( ) [inherited]

Views handlers use a special construct function so that we can more easily construct them with variable arguments.

Definition at line 54 of file base.inc.

References views_object::set_default_options().

{ $this->set_default_options(); }

views_plugin_argument_validate::convert_options ( &$ options ) [inherited]

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.

Reimplemented in views_plugin_argument_validate_node, views_plugin_argument_validate_taxonomy_term, views_plugin_argument_validate_user, and views_plugin_argument_validate_php.

Definition at line 64 of file views_plugin_argument_validate.inc.

Referenced by views_plugin_argument_validate::init().

{ }

views_plugin_argument_validate::init	(	&$	view,
		&$	argument,
		$	options
	)			`[inherited]`

Initialize this plugin with the view and the argument it is linked to.

Reimplemented in views_plugin_argument_validate_taxonomy_term.

Definition at line 27 of file views_plugin_argument_validate.inc.

References views_object::$options, views_plugin_argument_validate::convert_options(), views_object::options(), and views_object::unpack_options().

                                              {
    $this->view = &$view;
    $this->argument = &$argument;

    $this->convert_options($options);
    $this->unpack_options($this->options, $options);
  }

views_plugin_argument_validate::option_definition ( ) [inherited]

Retrieve the options when this is a new access control plugin.

Reimplemented from views_object.

Reimplemented in views_plugin_argument_validate_node, views_plugin_argument_validate_taxonomy_term, views_plugin_argument_validate_user, and views_plugin_argument_validate_php.

Definition at line 39 of file views_plugin_argument_validate.inc.

{ return array(); }

views_object::options ( &$ options ) [inherited]

Set default options on this object.

Called by the constructor in a complex chain to deal with backward compatibility.

Reimplemented in views_plugin_style_default.

Definition at line 60 of file base.inc.

{ }

views_plugin_argument_validate::options_form	(	&$	form,
		&$	form_state
	)			`[inherited]`

Provide the default form for setting options.

Reimplemented from views_plugin.

Reimplemented in views_plugin_argument_validate_node, views_plugin_argument_validate_taxonomy_term, views_plugin_argument_validate_user, and views_plugin_argument_validate_php.

Definition at line 44 of file views_plugin_argument_validate.inc.

{ }

views_plugin_argument_validate::options_submit	(	&$	form,
		&$	form_state,
		&$	options = `array()`
	)			`[inherited]`

Provide the default form form for submitting options.

Reimplemented in views_plugin_argument_validate_node, views_plugin_argument_validate_taxonomy_term, and views_plugin_argument_validate_user.

Definition at line 54 of file views_plugin_argument_validate.inc.

{ }

views_plugin::options_submit	(	&$	form,
		&$	form_state
	)			`[inherited]`

Handle any special handling on the validate form.

Reimplemented in views_plugin_access, views_plugin_access_role, views_plugin_display, views_plugin_display_attachment, views_plugin_display_block, views_plugin_display_extender, views_plugin_display_feed, views_plugin_display_page, views_plugin_exposed_form_input_required, views_plugin_pager, views_plugin_query, views_plugin_row, and views_plugin_row_fields.

Definition at line 501 of file plugins.inc.

{ }

views_plugin_argument_validate::options_validate	(	&$	form,
		&$	form_state
	)			`[inherited]`

Provide the default form form for validating options.

Reimplemented from views_plugin.

Definition at line 49 of file views_plugin_argument_validate.inc.

{ }

views_plugin::plugin_title ( ) [inherited]

Return the human readable name of the display.

This appears on the ui beside each plugin and beside the settings link.

Definition at line 548 of file plugins.inc.

                          {
    if (isset($this->definition['short title'])) {
      return check_plain($this->definition['short title']);
    }
    return check_plain($this->definition['title']);
  }

views_plugin_argument_validate::process_summary_arguments ( &$ args ) [inherited]

Process the summary arguments for displaying.

Some plugins alter the argument so it uses something else interal. For example the user validation set's the argument to the uid, for a faster query. But there are use cases where you want to use the old value again, for example the summary.

Reimplemented in views_plugin_argument_validate_taxonomy_term, and views_plugin_argument_validate_user.

Definition at line 96 of file views_plugin_argument_validate.inc.

{ }

views_plugin::query ( ) [inherited]

Add anything to the query that we might need to.

Reimplemented in views_plugin_display, views_plugin_display_extender, views_plugin_exposed_form, views_plugin_exposed_form_input_required, views_plugin_pager, views_plugin_pager_full, views_plugin_pager_none, views_plugin_pager_some, views_plugin_row, views_plugin_style, views_plugin_style_summary, and views_plugin_style_summary_jump_menu.

Definition at line 506 of file plugins.inc.

Referenced by views_plugin_query_default::build().

{ }

views_object::set_default_options ( ) [inherited]

Set default options.

For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.

Definition at line 67 of file base.inc.

References views_object::option_definition(), and views_object::options().

Referenced by views_object::construct().

                                 {
    $this->_set_option_defaults($this->options, $this->option_definition());

    // Retained for complex defaults plus backward compatibility.
    $this->options($this->options);
  }

views_object::set_definition ( $ definition ) [inherited]

Let the handler know what its full definition is.

Definition at line 173 of file base.inc.

                                       {
    $this->definition = $definition;
    if (isset($definition['field'])) {
      $this->real_field = $definition['field'];
    }
  }

views_plugin::summary_title ( ) [inherited]

Returns the summary of the settings in the display.

Reimplemented in views_plugin_row_comment_view, views_plugin_row_node_rss, views_plugin_row_node_view, views_plugin_row_user_view, views_plugin_access, views_plugin_access_none, views_plugin_access_perm, views_plugin_access_role, views_plugin_cache, views_plugin_cache_none, views_plugin_cache_time, views_plugin_pager, views_plugin_pager_full, views_plugin_pager_mini, views_plugin_pager_none, views_plugin_pager_some, and views_plugin_query.

Definition at line 540 of file plugins.inc.

                           {
    return t('Settings');
  }

views_plugin::theme_functions ( ) [inherited]

Provide a full list of possible theme templates used by this style.

Definition at line 511 of file plugins.inc.

References views_theme_functions().

Referenced by views_plugin_display::options_form(), views_plugin_style_summary::render(), views_plugin_style_rss::render(), views_plugin_row::render(), views_plugin_display::render(), views_plugin_row_search_view::render(), and views_plugin_style::render_grouping_sets().

                             {
    return views_theme_functions($this->definition['theme'], $this->view, $this->display);
  }

views_object::unpack_options	(	&$	storage,
		$	options,
		$	definition = `NULL`,
		$	all = `TRUE`,
		$	check = `TRUE`,
		$	localization_keys = `array()`
	)			`[inherited]`

Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.

Definition at line 93 of file base.inc.

References views_object::$options, and views_object::option_definition().

Referenced by views_plugin_style::init(), views_plugin_row::init(), views_plugin_query::init(), views_plugin_pager::init(), views_plugin_exposed_form::init(), views_plugin_cache::init(), views_plugin_argument_validate::init(), views_plugin_argument_default::init(), views_plugin_access::init(), and views_handler::init().

                                                                                                                             {
    if ($check && !is_array($options)) {
      return;
    }

    if (!isset($definition)) {
      $definition = $this->option_definition();
    }

    if (!empty($this->view)) {
      // Ensure we have a localization plugin.
      $this->view->init_localization();

      // Set up default localization keys. Handlers and such set this for us
      if (empty($localization_keys) && isset($this->localization_keys)) {
        $localization_keys = $this->localization_keys;
      }
      // but plugins don't because there isn't a common init() these days.
      else if (!empty($this->is_plugin)) {
        if ($this->plugin_type != 'display') {
          $localization_keys = array($this->view->current_display);
          $localization_keys[] = $this->plugin_type;
        }
      }
    }

    foreach ($options as $key => $value) {
      if (is_array($value)) {
        // Ignore arrays with no definition.
        if (!$all && empty($definition[$key])) {
          continue;
        }

        if (!isset($storage[$key]) || !is_array($storage[$key])) {
          $storage[$key] = array();
        }

        // If we're just unpacking our known options, and we're dropping an
        // unknown array (as might happen for a dependent plugin fields) go
        // ahead and drop that in.
        if (!$all && isset($definition[$key]) && !isset($definition[$key]['contains'])) {
          $storage[$key] = $value;
          continue;
        }

        $this->unpack_options($storage[$key], $value, isset($definition[$key]['contains']) ? $definition[$key]['contains'] : array(), $all, FALSE, array_merge($localization_keys, array($key)));
      }
      // Don't localize strings during editing. When editing, we need to work with
      // the original data, not the translated version.
      else if (empty($this->view->editing) && !empty($definition[$key]['translatable']) && !empty($value) || !empty($definition['contains'][$key]['translatable']) && !empty($value)) {
        if (!empty($this->view) && $this->view->is_translatable()) {
          // Allow other modules to make changes to the string before it's
          // sent for translation.
          // The $keys array is built from the view name, any localization keys
          // sent in, and the name of the property being processed.
          $format = NULL;
          if (isset($definition[$key]['format_key']) && isset($options[$definition[$key]['format_key']])) {
            $format = $options[$definition[$key]['format_key']];
          }
          $translation_data = array(
            'value' => $value,
            'format' => $format,
            'keys' => array_merge(array($this->view->name), $localization_keys, array($key)),
          );
          $storage[$key] = $this->view->localization_plugin->translate($translation_data);
        }
        // Otherwise, this is a code-based string, so we can use t().
        else {
          $storage[$key] = t($value);
        }
      }
      else if ($all || !empty($definition[$key])) {
        $storage[$key] = $value;
      }
    }
  }

views_object::unpack_translatable	(	&$	translatable,
		$	storage,
		$	option,
		$	definition,
		$	parents,
		$	keys = `array()`
	)			`[inherited]`

Unpack a single option definition.

This function run's through all suboptions recursive.

Parameters:

	$translatable	Stores all available translatable items.
	$storage
	$option
	$definition
	$parents
	$keys

Definition at line 275 of file base.inc.

References views_object::$options.

Referenced by views_object::unpack_translatables().

                                                                                                          {
    // Do not export options for which we have no settings.
    if (!isset($storage[$option])) {
      return;
    }

    // Special handling for some items
    if (isset($definition['unpack_translatable']) && method_exists($this, $definition['unpack_translatable'])) {
      return $this->{$definition['unpack_translatable']}($translatable, $storage, $option, $definition, $parents, $keys);
    }

    if (isset($definition['translatable'])) {
      if ($definition['translatable'] === FALSE) {
        return;
      }
    }

    // Add the current option to the parents tree.
    $parents[] = $option;

    // If it has child items, unpack those separately.
    if (isset($definition['contains'])) {
      foreach ($definition['contains'] as $sub_option => $sub_definition) {
        $translation_keys = array_merge($keys, array($sub_option));
        $this->unpack_translatable($translatable, $storage[$option], $sub_option, $sub_definition, $parents, $translation_keys);
      }
    }

    // @todo Figure out this double definition stuff.
    $options = $storage[$option];
    if (is_array($options)) {
      foreach ($options as $key => $value) {
        $translation_keys = array_merge($keys, array($key));
        if (is_array($value)) {
          $this->unpack_translatable($translatable, $options, $key, $definition, $parents, $translation_keys);
        }
        else if (!empty($definition[$key]['translatable']) && !empty($value)) {
          // Build source data and add to the array
          $format = NULL;
          if (isset($definition['format_key']) && isset($options[$definition['format_key']])) {
            $format = $options[$definition['format_key']];
          }
          $translatable[] = array(
            'value' => $value,
            'keys' => $translation_keys,
            'format' => $format,
          );
        }
      }
    }
    else if (!empty($definition['translatable']) && !empty($options)) {
      $value = $options;
      // Build source data and add to the array
      $format = NULL;
      if (isset($definition['format_key']) && isset($storage[$definition['format_key']])) {
        $format = $options[$definition['format_key']];
      }
      $translatable[] = array(
        'value' => $value,
        'keys' => isset($translation_keys) ? $translation_keys : $parents,
        'format' => $format,
      );
    }
  }

views_object::unpack_translatables	(	&$	translatable,
		$	parents = `array()`
	)			`[inherited]`

Unpacks each handler to store translatable texts.

Definition at line 256 of file base.inc.

References views_object::option_definition(), views_object::options(), and views_object::unpack_translatable().

                                                                    {
    foreach ($this->option_definition() as $option => $definition) {
      $this->unpack_translatable($translatable, $this->options, $option, $definition, $parents, array());
    }
  }

views_plugin::validate ( ) [inherited]

Validate that the plugin is correct and can be saved.