class views_plugin_argument_validate_php

Provide PHP code to validate whether or not an argument is ok.

Hierarchy

Expanded class hierarchy of views_plugin_argument_validate_php

Related topics

1 string reference to 'views_plugin_argument_validate_php'
views_views_plugins in includes/plugins.inc
Implements hook_views_plugins().

File

plugins/views_plugin_argument_validate_php.inc, line 13

View source
class views_plugin_argument_validate_php extends views_plugin_argument_validate {
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['code'] = array(
            'default' => '',
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $form['code'] = array(
            '#type' => 'textarea',
            '#title' => t('PHP validate code'),
            '#default_value' => $this->options['code'],
            '#description' => t('Enter PHP code that returns TRUE or FALSE. No return is the same as FALSE, so be SURE to return something if you do not want to declare the argument invalid. Do not use <?php ?>. The argument to validate will be "$argument" and the view will be "$view". You may change the argument by setting "$handler->argument". You may change the title used for substitutions for this argument by setting "$handler->validated_title".'),
        );
        $this->check_access($form, 'code');
    }
    
    /**
     * Only let users with PHP block visibility permissions set/modify this
     * validate plugin.
     */
    public function access() {
        return user_access('use PHP for settings');
    }
    
    /**
     * {@inheritdoc}
     */
    public function convert_options(&$options) {
        if (!isset($options['code']) && isset($this->argument->options['validate_argument_php'])) {
            $options['code'] = $this->argument->options['validate_argument_php'];
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function validate_argument($argument) {
        ob_start();
        $result = eval($this->options['code']);
        ob_end_clean();
        return $result;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title 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 public 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::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::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
views_plugin_argument_validate_php::access public function Only let users with PHP block visibility permissions set/modify this
validate plugin.
Overrides views_plugin_argument_validate::access
views_plugin_argument_validate_php::convert_options public function Convert options from the older style. Overrides views_plugin_argument_validate::convert_options
views_plugin_argument_validate_php::options_form public function Provide the default form for setting options. Overrides views_plugin_argument_validate::options_form
views_plugin_argument_validate_php::option_definition public function Retrieve the options when this is a new access control plugin. Overrides views_plugin_argument_validate::option_definition
views_plugin_argument_validate_php::validate_argument public function Overrides views_plugin_argument_validate::validate_argument