Default argument plugin to use the raw value from the URL.
@Plugin(
id = "raw",
title = @Translation("Raw value from URL")
)
Expanded class hierarchy of Raw
class Raw extends ArgumentDefaultPluginBase {
protected function defineOptions() {
$options = parent::defineOptions();
$options['index'] = array(
'default' => '',
);
$options['use_alias'] = array(
'default' => FALSE,
'bool' => TRUE,
);
return $options;
}
public function buildOptionsForm(&$form, &$form_state) {
parent::buildOptionsForm($form, $form_state);
// Using range(1, 10) will create an array keyed 0-9, which allows arg() to
// properly function since it is also zero-based.
$form['index'] = array(
'#type' => 'select',
'#title' => t('Path component'),
'#default_value' => $this->options['index'],
'#options' => range(1, 10),
'#description' => t('The numbering starts from 1, e.g. on the page admin/structure/types, the 3rd path component is "types".'),
);
$form['use_alias'] = array(
'#type' => 'checkbox',
'#title' => t('Use path alias'),
'#default_value' => $this->options['use_alias'],
'#description' => t('Use path alias instead of internal path.'),
);
}
public function getArgument() {
$path = NULL;
if ($this->options['use_alias']) {
$path = drupal_get_path_alias();
}
if ($arg = arg($this->options['index'], $path)) {
return $arg;
}
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ArgumentDefaultPluginBase:: |
protected | property | The argument handler instance associated with this plugin. | |
ArgumentDefaultPluginBase:: |
public | function | Determine if the administrator has the privileges to use this plugin | 1 |
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 |
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:: |
|
Raw:: |
public | function |
Provide the default form for setting options. Overrides ArgumentDefaultPluginBase:: |
|
Raw:: |
protected | function |
Retrieve the options when this is a new access
control plugin Overrides ArgumentDefaultPluginBase:: |
|
Raw:: |
public | function |
Return the default argument. Overrides ArgumentDefaultPluginBase:: |