class rb_views_plugin_argument_validate_rules_component in Rules Bonus Pack 7

Use a Rules component to validate a contextual filter value ('argument').

This component allows using a Rules component for validation of Views contextual filter values. The component must accept a text string as input (parameter) – this is the contextual filter value from Views. (This value can be altered by the component, if desired.) The component must return a string and a boolean as output (provided). The string is the (altered) argument value, and the boolean is the TRUE/FALSE outcome of the validation.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_validate
      • class \rb_views_plugin_argument_validate_rules_component

1 string reference to 'rb_views_plugin_argument_validate_rules_component'

rb_views_views_plugins in views/rb_views.views.inc

@file Declares Views plugins for Rules Bonus Pack: Views.

File

views/rb_views_plugin_argument_validate_rules_component.inc, line 19

Contains the plugin for validating a Views argument with rule sets.

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

    // Get all the relevant plugin instances.
    $components = rules_get_components(TRUE, NULL, array(
      'plugin' => 'views argument validator',
    ));

    // Build the options form for the validator.
    $form['component'] = array(
      '#type' => 'select',
      '#title' => t('Choose validator component'),
      '#options' => $components,
      '#default_value' => $this->options['component'],
      '#description' => t('New argument validators can be set up using the Rules component interface.'),
    );
  }
  function validate_argument($argument) {

    // Run the rule set with the argument value as input.
    $result = rules_invoke_component($this->options['component'], &$this->argument->argument, $this->view->args);

    // Update the argument with the output from the rule set.
    $this->argument->argument = $result[0];
    $this->view->args = $result[1];

    // Return the validation boolean from the rule set.
    return $result[2];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
rb_views_plugin_argument_validate_rules_component::options_form		function	Provide the default form for setting options. Overrides views_plugin_argument_validate::options_form
rb_views_plugin_argument_validate_rules_component::option_definition		function	Retrieve the options when this is a new access control plugin. Overrides views_plugin_argument_validate::option_definition
rb_views_plugin_argument_validate_rules_component::validate_argument		function	Overrides views_plugin_argument_validate::validate_argument
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_validate::access	public	function	Determine if the administrator has the privileges to use this plugin.	1
views_plugin_argument_validate::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_validate::convert_options	public	function	Convert options from the older style.	4
views_plugin_argument_validate::init	public	function	Initialize this plugin with the view and the argument it is linked to.	1
views_plugin_argument_validate::options_submit	public	function	Provide the default form form for submitting options Overrides views_plugin::options_submit	3
views_plugin_argument_validate::options_validate	public	function	Provide the default form form for validating options. Overrides views_plugin::options_validate
views_plugin_argument_validate::process_summary_arguments	public	function	Process the summary arguments for displaying.	2