Default argument plugin to provide a PHP code block.
@Plugin(
id = "php",
title = @Translation("PHP Code")
)
Expanded class hierarchy of Php
class Php extends ArgumentDefaultPluginBase {
protected function defineOptions() {
$options = parent::defineOptions();
$options['code'] = array(
'default' => '',
);
return $options;
}
public function buildOptionsForm(&$form, &$form_state) {
parent::buildOptionsForm($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
->checkAccess($form, 'code');
}
/**
* Only let users with PHP block visibility permissions set/modify this
* default plugin.
*/
public function access() {
return user_access('use PHP for settings');
}
public function getArgument() {
// 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;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ArgumentDefaultPluginBase:: |
protected | property | The argument handler instance associated with this plugin. | |
ArgumentDefaultPluginBase:: |
protected | 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. | |
ArgumentDefaultPluginBase:: |
public | function | Sets the parent argument this plugin is associated with. | |
ArgumentDefaultPluginBase:: |
public | function |
Provide the default form form for submitting options Overrides PluginBase:: |
1 |
ArgumentDefaultPluginBase:: |
public | function |
Provide the default form form for validating options Overrides PluginBase:: |
|
ContainerFactoryPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
11 |
Php:: |
public | function |
Only let users with PHP block visibility permissions set/modify this
default plugin. Overrides ArgumentDefaultPluginBase:: |
|
Php:: |
public | function |
Provide the default form for setting options. Overrides ArgumentDefaultPluginBase:: |
|
Php:: |
protected | function |
Retrieve the options when this is a new access
control plugin Overrides ArgumentDefaultPluginBase:: |
|
Php:: |
public | function |
Return the default argument. Overrides ArgumentDefaultPluginBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Initialize the plugin. | 8 |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
public | function | Add anything to the query that we might need to. | 13 |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Validate that the plugin is correct and can be saved. | 4 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |