class views_plugin_argument_default_php in Views (for Drupal 7) 7.3
Same name and namespace in other branches
- 6.3 plugins/views_plugin_argument_default_php.inc \views_plugin_argument_default_php
- 6.2 plugins/views_plugin_argument_default_php.inc \views_plugin_argument_default_php
Default argument plugin to provide a PHP code block.
Hierarchy
- class \views_object
- class \views_plugin
Expanded class hierarchy of views_plugin_argument_default_php
Related topics
1 string reference to 'views_plugin_argument_default_php'
- views_views_plugins in includes/
plugins.inc - Implements hook_views_plugins().
File
- plugins/
views_plugin_argument_default_php.inc, line 13 - Definition of views_plugin_argument_default_php.
View source
class views_plugin_argument_default_php extends views_plugin_argument_default {
/**
* {@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 contextual filter code'),
'#default_value' => $this->options['code'],
'#description' => t('Enter PHP code that returns a value to use for this filter. Do not use <?php ?>. You must return only a single value for just this filter. Some variables are available: the view object will be "$view". The argument handler will be "$argument", for example you may change the title used for substitutions for this argument by setting "argument->validated_title"".'),
);
// Only do this if using one simple standard form gadget.
$this
->check_access($form, 'code');
}
/**
* {@inheritdoc}
*/
public function convert_options(&$options) {
if (!isset($options['code']) && isset($this->argument->options['default_argument_php'])) {
$options['code'] = $this->argument->options['default_argument_php'];
}
}
/**
* Only let users with PHP block visibility permissions set/modify this
* default plugin.
*/
public function access() {
return user_access('use PHP for settings');
}
/**
* {@inheritdoc}
*/
public function 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->options['code']);
ob_end_clean();
return $result;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Views handlers use a special construct function. | 4 |
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function | ||
views_plugin:: |
public | property | The current used views display. | |
views_plugin:: |
public | property | The plugin name of this plugin, for example table or full. | |
views_plugin:: |
public | property | The plugin type of this plugin, for example style or query. | |
views_plugin:: |
public | property |
The top object of a view. Overrides views_object:: |
1 |
views_plugin:: |
public | function | Provide a list of additional theme functions for the theme info page. | |
views_plugin:: |
public | function | Return the human readable name of the display. | |
views_plugin:: |
public | function | Add anything to the query that we might need to. | 7 |
views_plugin:: |
public | function | Returns the summary of the settings in the display. | 8 |
views_plugin:: |
public | function | Provide a full list of possible theme templates used by this style. | |
views_plugin:: |
public | function | Validate that the plugin is correct and can be saved. | 3 |
views_plugin_argument_default:: |
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_default:: |
public | function | Initialize this plugin with the view and the argument it is linked to. | 1 |
views_plugin_argument_default:: |
public | function |
Provide the default form form for submitting options. Overrides views_plugin:: |
1 |
views_plugin_argument_default:: |
public | function |
Provide the default form form for validating options. Overrides views_plugin:: |
|
views_plugin_argument_default_php:: |
public | function |
Only let users with PHP block visibility permissions set/modify this
default plugin. Overrides views_plugin_argument_default:: |
|
views_plugin_argument_default_php:: |
public | function |
Convert options from the older style. Overrides views_plugin_argument_default:: |
|
views_plugin_argument_default_php:: |
public | function |
Return the default argument. Overrides views_plugin_argument_default:: |
|
views_plugin_argument_default_php:: |
public | function |
Provide the default form for setting options. Overrides views_plugin_argument_default:: |
|
views_plugin_argument_default_php:: |
public | function |
Retrieve the options when this is a new access control plugin. Overrides views_plugin_argument_default:: |