class views_plugin_argument_validate_php

  1. 3.x plugins/views_plugin_argument_validate_php.inc views_plugin_argument_validate_php
  2. 2.x plugins/views_plugin_argument_validate_php.inc 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

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
Implements hook_views_plugins().

File

plugins/views_plugin_argument_validate_php.inc, line 13
Contains the php code argument validator plugin.

View source
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) {
    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.
   */
  function access() {
    return user_access('use PHP for settings');
  }

  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

Contains filters are case sensitive
Namesort descending Modifiers Type Description
views_object::construct function Views handlers use a special construct function so that we can more easily construct them with variable arguments.
views_object::destroy function
views_object::export_option function
views_object::export_options function
views_object::export_option_always function Always exports the option, regardless of the default value.
views_object::options Deprecated function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
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::additional_theme_functions function Provide a list of additional theme functions for the theme information page
views_plugin::plugin_title function Return the human readable name of the display.
views_plugin::query function Add anything to the query that we might need to.
views_plugin::summary_title function Returns the summary of the settings in the display.
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.
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
views_plugin_argument_validate::options_validate function Provide the default form form for validating options Overrides views_plugin::options_validate
views_plugin_argument_validate::process_summary_arguments function Process the summary arguments for displaying.
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