Provide PHP code to validate whether or not an argument is ok.
@Plugin(
id = "php",
title = @Translation("PHP Code")
)
Expanded class hierarchy of Php
class Php extends ArgumentValidatorPluginBase {
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 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.
*/
public function access() {
return user_access('use PHP for settings');
}
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;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Php:: |
function |
Overrides ArgumentValidatorPluginBase:: |
||
PluginBase:: |
protected | function | ||
PluginBase:: |
public | function | Add anything to the query that we might need to. | 13 |
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |
|
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
ArgumentValidatorPluginBase:: |
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. | ||
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
ArgumentValidatorPluginBase:: |
public | function | Initialize this plugin with the view and the argument it is linked to. | 1 |
Php:: |
public | function |
Only let users with PHP block visibility permissions set/modify this
validate plugin. Overrides ArgumentValidatorPluginBase:: |
|
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
public | property | Plugins's definition | |
ArgumentValidatorPluginBase:: |
function | Process the summary arguments for displaying. | 2 | |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
Php:: |
public | function |
Provide the default form for setting options. Overrides ArgumentValidatorPluginBase:: |
|
ArgumentValidatorPluginBase:: |
public | function |
Provide the default form form for submitting options Overrides PluginBase:: |
3 |
ArgumentValidatorPluginBase:: |
public | function |
Provide the default form form for validating options Overrides PluginBase:: |
|
Php:: |
protected | function |
Retrieve the options when this is a new access
control plugin Overrides ArgumentValidatorPluginBase:: |
|
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
public | property | The top object of a view. | 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 | Validate that the plugin is correct and can be saved. | 4 |