class views_plugin_argument_validate_php in Views (for Drupal 7) 6.3

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

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_validate
      • class \views_plugin_argument_validate_php

Related topics

Views' argument validate plugins

Allow specialized methods of validating arguments.

1 string reference to 'views_plugin_argument_validate_php'

views_views_plugins in includes/plugins.inc

Implementation of hook_views_plugins

File

plugins/views_plugin_argument_validate_php.inc, line 12

Contains the php code argument validator plugin.

class views_plugin_argument_validate_php extends views_plugin_argument_validate {
  function option_definition() {
    $options = parent::option_definition();
    $options['code'] = array(
      'default' => '',
    );
    return $options;
  }
  function 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.
   */
  function access() {
    return user_access('use PHP for block visibility');
  }
  function convert_options(&$options) {
    if (!isset($options['code']) && isset($this->argument->options['validate_argument_php'])) {
      $options['code'] = $this->argument->options['validate_argument_php'];
    }
  }
  function validate_argument($argument) {

    // set up variables to make it easier to reference during the argument.
    $view =& $this->view;
    $handler =& $this->argument;
    ob_start();
    $result = eval($this->options['code']);
    ob_end_clean();
    return $result;
  }

}

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_validate::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_validate::init		function	Initialize this plugin with the view and the argument it is linked to.
views_plugin_argument_validate::options_submit		function	Provide the default form form for submitting options Overrides views_plugin::options_submit	3
views_plugin_argument_validate::options_validate		function	Provide the default form form for validating options Overrides views_plugin::options_validate
views_plugin_argument_validate_php::access		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		function	Convert options from the older style. Overrides views_plugin_argument_validate::convert_options
views_plugin_argument_validate_php::options_form		function	Provide the default form for setting options. Overrides views_plugin_argument_validate::options_form
views_plugin_argument_validate_php::option_definition		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		function	Overrides views_plugin_argument_validate::validate_argument