class views_plugin_argument_validate

Base argument validator plugin to provide basic functionality.

Hierarchy

Expanded class hierarchy of views_plugin_argument_validate

Related topics

File

plugins/views_plugin_argument_validate.inc, line 19

View source
class views_plugin_argument_validate extends views_plugin {
    
    /**
     * Initialize this plugin with the view and the argument it is linked to.
     */
    public function init(&$view, &$argument, $options) {
        $this->view =& $view;
        $this->argument =& $argument;
        $this->convert_options($options);
        $this->unpack_options($this->options, $options);
    }
    
    /**
     * Retrieve the options when this is a new access control plugin.
     */
    public function option_definition() {
        return array();
    }
    
    /**
     * Provide the default form for setting options.
     */
    public function options_form(&$form, &$form_state) {
    }
    
    /**
     * Provide the default form form for validating options.
     */
    public function options_validate(&$form, &$form_state) {
    }
    
    /**
     * Provide the default form form for submitting options.
     */
    public function options_submit(&$form, &$form_state, &$options = array()) {
    }
    
    /**
     * 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.
     */
    public function convert_options(&$options) {
    }
    
    /**
     * Determine if the administrator has the privileges to use this plugin.
     */
    public function access() {
        return TRUE;
    }
    
    /**
     * 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.
     */
    public function check_access(&$form, $option_name) {
        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>';
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function validate_argument($arg) {
        return TRUE;
    }
    
    /**
     * Process the summary arguments for displaying.
     *
     * Some plugins alter the argument so it uses something else internally.
     * 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.
     */
    public function process_summary_arguments(&$args) {
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
views_object::$definition public property Handler&#039;s definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition public function Collect this handler&#039;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&#039;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&#039;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_form public function Provide the default form for setting options. Overrides views_plugin::options_form 4
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::option_definition public function Retrieve the options when this is a new access control plugin. Overrides views_object::option_definition 4
views_plugin_argument_validate::process_summary_arguments public function Process the summary arguments for displaying. 2
views_plugin_argument_validate::validate_argument public function 5