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
Implementation of hook_views_plugins

File

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

View source
class views_plugin_argument_validate_php extends views_plugin_argument_validate {
  var $option_name = 'validate_argument_php';

  function validate_form(&$form, &$form_state) {
    $form[$this->option_name] = array(
      '#type' => 'textarea',
      '#title' => t('PHP validate code'),
      '#default_value' => $this->get_argument(),
      '#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".'),
      '#process' => array('views_process_dependency'),
      '#dependency' => array('edit-options-validate-type' => array($this->id)),
    );

    $this->check_access($form);
  }

  /**
   * Only let users with PHP block visibility permissions set/modify this
   * validate plugin.
   */
  function access() {
    return user_access('use PHP for block visibility');
  }

  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->argument->options[$this->option_name]);
    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::options function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::option_definition function Information about options for all kinds of purposes will be held here.
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::_set_option_defaults function
views_plugin::additional_theme_functions function Provide a list of additional theme functions for the theme information page
views_plugin::options_form function Provide a form to edit options for this plugin.
views_plugin::options_submit function Handle any special handling on the validate form.
views_plugin::options_validate function Validate the options form.
views_plugin::query function Add anything to the query that we might need to.
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::argument_form function
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::get_argument function Return the validate argument.
views_plugin_argument_validate::init function Initialize this plugin with the view and the argument it is linked to. Overrides views_plugin::init
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::validate_argument function Overrides views_plugin_argument_validate::validate_argument
views_plugin_argument_validate_php::validate_form function Overrides views_plugin_argument_validate::validate_form