Default argument plugin to extract a user via menu_get_object.
@Plugin(
id = "user",
module = "user",
title = @Translation("User ID from URL")
)
Expanded class hierarchy of User
class User extends ArgumentDefaultPluginBase {
protected function defineOptions() {
$options = parent::defineOptions();
$options['user'] = array(
'default' => '',
'bool' => TRUE,
'translatable' => FALSE,
);
return $options;
}
public function buildOptionsForm(&$form, &$form_state) {
$form['user'] = array(
'#type' => 'checkbox',
'#title' => t('Also look for a node and use the node author'),
'#default_value' => $this->options['user'],
);
}
function get_argument() {
foreach (range(1, 3) as $i) {
$user = menu_get_object('user', $i);
if (!empty($user)) {
return $user->uid;
}
}
foreach (range(1, 3) as $i) {
$user = menu_get_object('user_uid_optional', $i);
if (!empty($user)) {
return $user->uid;
}
}
if (!empty($this->options['user'])) {
foreach (range(1, 3) as $i) {
$node = menu_get_object('node', $i);
if (!empty($node)) {
return $node->uid;
}
}
}
if (arg(0) == 'user' && is_numeric(arg(1))) {
return arg(1);
}
if (!empty($this->options['user'])) {
if (arg(0) == 'node' && is_numeric(arg(1))) {
$node = node_load(arg(1));
if ($node) {
return $node->uid;
}
}
}
// If the current page is a view that takes uid as an argument, return the uid.
$view = views_get_page_view();
if ($view && isset($view->argument['uid'])) {
return $view->argument['uid']->argument;
}
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ArgumentDefaultPluginBase:: |
public | function | Determine if the administrator has the privileges to use this plugin | 1 |
ArgumentDefaultPluginBase:: |
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 | Initialize this plugin with the view and the argument it is linked to. | 1 |
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:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | The discovery object. | |
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_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 | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). 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 | 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 | ||
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:: |
|
User:: |
public | function |
Provide the default form for setting options. Overrides ArgumentDefaultPluginBase:: |
|
User:: |
protected | function |
Retrieve the options when this is a new access
control plugin Overrides ArgumentDefaultPluginBase:: |
|
User:: |
function |
Return the default argument. Overrides ArgumentDefaultPluginBase:: |