class views_plugin_argument_default_php in Views (for Drupal 7) 6.2

Default argument plugin to provide a PHP code block.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_default
      • class \views_plugin_argument_default_php

1 string reference to 'views_plugin_argument_default_php'

views_views_plugins in includes/plugins.inc

Implementation of hook_views_plugins

File

plugins/views_plugin_argument_default_php.inc, line 10

Contains the php code argument default plugin.

class views_plugin_argument_default_php extends views_plugin_argument_default {
  var $option_name = 'default_argument_php';
  function argument_form(&$form, &$form_state) {
    $form[$this->option_name] = array(
      '#type' => 'textarea',
      '#title' => t('PHP argument code'),
      '#default_value' => $this
        ->get_argument(TRUE),
      // the true forces it raw.
      '#process' => array(
        'views_process_dependency',
      ),
      '#description' => t('Enter PHP code that returns a value to use for this argument. Do not use <?php ?>. You must return only a single value for just this argument.'),
      '#dependency' => array(
        'radio:options[default_action]' => array(
          'default',
        ),
        'radio:options[default_argument_type]' => array(
          $this->id,
        ),
      ),
      '#dependency_count' => 2,
    );
    $this
      ->check_access($form);
  }

  /**
   * Only let users with PHP block visibility permissions set/modify this
   * default plugin.
   */
  function access() {
    return user_access('use PHP for block visibility');
  }
  function get_argument($raw = FALSE) {
    if ($raw) {
      return parent::get_argument();
    }

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

}

Members

Name	Modifiers	Type	Description	Overrides
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.	5
views_object::destroy		function		2
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::option_definition		function	Information about options for all kinds of purposes will be held here.	9
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		1
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.	5
views_plugin::options_submit		function	Handle any special handling on the validate form.	3
views_plugin::options_validate		function	Validate the options form.	3
views_plugin::query		function	Add anything to the query that we might need to.	3
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_default::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_default::init		function	Initialize this plugin with the view and the argument it is linked to. Overrides views_plugin::init
views_plugin_argument_default_php::$option_name		property	Overrides views_plugin_argument_default::$option_name
views_plugin_argument_default_php::access		function	Only let users with PHP block visibility permissions set/modify this default plugin. Overrides views_plugin_argument_default::access
views_plugin_argument_default_php::argument_form		function	Overrides views_plugin_argument_default::argument_form
views_plugin_argument_default_php::get_argument		function	Return the default argument. Overrides views_plugin_argument_default::get_argument