class Users in Drupal 10
Same name and namespace in other branches
- 8 core/modules/user/src/Plugin/views/wizard/Users.php \Drupal\user\Plugin\views\wizard\Users
- 9 core/modules/user/src/Plugin/views/wizard/Users.php \Drupal\user\Plugin\views\wizard\Users
Tests creating user views with the wizard.
Plugin annotation
@ViewsWizard(
id = "users",
base_table = "users_field_data",
title = @Translation("Users")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\wizard\WizardPluginBase implements WizardInterface
- class \Drupal\user\Plugin\views\wizard\Users
- class \Drupal\views\Plugin\views\wizard\WizardPluginBase implements WizardInterface
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Users
6 string references to 'Users'
- drupal6.php in core/
modules/ migrate_drupal/ tests/ fixtures/ drupal6.php - A database agnostic dump for testing purposes.
- drupal7.php in core/
modules/ rdf/ tests/ fixtures/ drupal7.php - A database agnostic dump for testing purposes.
- drupal7.php in core/
modules/ migrate_drupal/ tests/ fixtures/ drupal7.php - A database agnostic dump for testing purposes.
- search.page.user_search.yml in core/
modules/ user/ config/ optional/ search.page.user_search.yml - core/modules/user/config/optional/search.page.user_search.yml
- user_token_info in core/
modules/ user/ user.tokens.inc - Implements hook_token_info().
File
- core/
modules/ user/ src/ Plugin/ views/ wizard/ Users.php, line 20
Namespace
Drupal\user\Plugin\views\wizardView source
class Users extends WizardPluginBase {
/**
* Set the created column.
*
* @var string
*/
protected $createdColumn = 'created';
/**
* Set default values for the filters.
*/
protected $filters = [
'status' => [
'value' => TRUE,
'table' => 'users_field_data',
'field' => 'status',
'plugin_id' => 'boolean',
'entity_type' => 'user',
'entity_field' => 'status',
],
];
/**
* {@inheritdoc}
*/
protected function defaultDisplayOptions() {
$display_options = parent::defaultDisplayOptions();
// Add permission-based access control.
$display_options['access']['type'] = 'perm';
$display_options['access']['options']['perm'] = 'access user profiles';
// Remove the default fields, since we are customizing them here.
unset($display_options['fields']);
/* Field: User: Name */
$display_options['fields']['name']['id'] = 'name';
$display_options['fields']['name']['table'] = 'users_field_data';
$display_options['fields']['name']['field'] = 'name';
$display_options['fields']['name']['entity_type'] = 'user';
$display_options['fields']['name']['entity_field'] = 'name';
$display_options['fields']['name']['label'] = '';
$display_options['fields']['name']['alter']['alter_text'] = 0;
$display_options['fields']['name']['alter']['make_link'] = 0;
$display_options['fields']['name']['alter']['absolute'] = 0;
$display_options['fields']['name']['alter']['trim'] = 0;
$display_options['fields']['name']['alter']['word_boundary'] = 0;
$display_options['fields']['name']['alter']['ellipsis'] = 0;
$display_options['fields']['name']['alter']['strip_tags'] = 0;
$display_options['fields']['name']['alter']['html'] = 0;
$display_options['fields']['name']['hide_empty'] = 0;
$display_options['fields']['name']['empty_zero'] = 0;
$display_options['fields']['name']['plugin_id'] = 'field';
return $display_options;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 18 |
MessengerTrait:: |
public | function | Gets the messenger. | 18 |
MessengerTrait:: |
public | function | Sets the messenger. | |
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 | Stores the render API renderer. | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 6 |
PluginBase:: |
public | property | The top object of a view. | |
PluginBase:: |
public | function | 9 | |
PluginBase:: |
public | function | 4 | |
PluginBase:: |
protected | function | Information about options for all kinds of purposes will be held here. | 10 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function | 1 | |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | 2 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
protected | function | Returns the render API renderer. | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function | 2 | |
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function | ||
PluginBase:: |
public static | function | ||
PluginBase:: |
public static | function | ||
PluginBase:: |
public | function | 4 | |
PluginBase:: |
public static | function | Returns substitutions for Views queries for languages. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function | 4 | |
PluginBase:: |
public | function | 3 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public static | function | 1 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | 6 | |
PluginBase:: |
public | function | 2 | |
PluginBase:: |
public | function | 5 | |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 1 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. | ||
Users:: |
protected | property |
Set the created column. Overrides WizardPluginBase:: |
|
Users:: |
protected | property |
Set default values for the filters. Overrides WizardPluginBase:: |
|
Users:: |
protected | function |
Assembles the default display options for the view. Overrides WizardPluginBase:: |
|
WizardPluginBase:: |
protected | property | The available store criteria. | |
WizardPluginBase:: |
protected | property | The base table connected with the wizard. | |
WizardPluginBase:: |
protected | property | The bundle info service. | |
WizardPluginBase:: |
protected | property | Contains the information from entity_get_info of the $entity_type. | |
WizardPluginBase:: |
protected | property | The entity type connected with the wizard. | |
WizardPluginBase:: |
protected | property | Default values for filters. | |
WizardPluginBase:: |
protected | property | The parent form selector service. | |
WizardPluginBase:: |
protected | property | Views items configuration arrays for sorts added by the wizard. | |
WizardPluginBase:: |
protected | property | An array of validated view objects, keyed by a hash. | |
WizardPluginBase:: |
protected | function | Adds the array of display options to the view, with appropriate overrides. | |
WizardPluginBase:: |
protected | function | Alters the full array of display options before they are added to the view. | |
WizardPluginBase:: |
protected | function | Retrieves the block display options. | 1 |
WizardPluginBase:: |
protected | function | Builds an array of display options for the view. | 1 |
WizardPluginBase:: |
protected | function | Builds the form structure for selecting the view's filters. | 1 |
WizardPluginBase:: |
public | function |
Form callback to build other elements in the "show" form. Overrides WizardInterface:: |
|
WizardPluginBase:: |
protected | function | Adds the style options to the wizard form. | |
WizardPluginBase:: |
protected | function | Builds the form structure for selecting the view's sort order. | |
WizardPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides PluginBase:: |
1 |
WizardPluginBase:: |
public | function |
Creates a view from values that have already been validated. Overrides WizardInterface:: |
|
WizardPluginBase:: |
protected | function | Retrieves all filter information used by the default display. | |
WizardPluginBase:: |
protected | function | Retrieves filter information based on user input for the default display. | 2 |
WizardPluginBase:: |
protected | function | Retrieves all sort information used by the default display. | |
WizardPluginBase:: |
protected | function | Retrieves sort information based on user input for the default display. | |
WizardPluginBase:: |
public | function | Gets the availableSorts property. | 2 |
WizardPluginBase:: |
public | function | Gets the createdColumn property. | |
WizardPluginBase:: |
public | function | Gets the filters property. | 1 |
WizardPluginBase:: |
public static | function | Gets the current value of a #select element, from within a form constructor function. | |
WizardPluginBase:: |
public | function | Gets the sorts property. | |
WizardPluginBase:: |
protected | function | Instantiates a view object from form values. | |
WizardPluginBase:: |
protected | function | Retrieves the page display options. | 1 |
WizardPluginBase:: |
protected | function | Retrieves the feed display options. | |
WizardPluginBase:: |
protected | function | Retrieves the REST export display options from the submitted form values. | |
WizardPluginBase:: |
protected | function | Retrieves a validated view for a form submission. | |
WizardPluginBase:: |
protected | function | Retrieves row style plugin names. | 3 |
WizardPluginBase:: |
protected | function | Sets options for a display and makes them the default options if possible. | |
WizardPluginBase:: |
protected | function | Sets options for a display, inheriting from the defaults when possible. | |
WizardPluginBase:: |
protected | function | Stores a validated view from a form submission. | |
WizardPluginBase:: |
public | function |
Implements Drupal\views\Plugin\views\wizard\WizardInterface::validate(). Overrides WizardInterface:: |
|
WizardPluginBase:: |
public | function |
Constructs a WizardPluginBase object. Overrides PluginBase:: |
1 |