class ViewPaymentsByOwner in Payment 8.2
Same name in this branch
- 8.2 src/Controller/ViewPaymentsByOwner.php \Drupal\payment\Controller\ViewPaymentsByOwner
- 8.2 src/Plugin/views/argument_validator/ViewPaymentsByOwner.php \Drupal\payment\Plugin\views\argument_validator\ViewPaymentsByOwner
Validates whether the current user has access to view a user's payments.
Plugin annotation
@ViewsArgumentValidator(
id = "payment_view_payments_by_owner",
title = @Translation("Access to view a user's payments"),
entity_type = "user"
)
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\argument_validator\ArgumentValidatorPluginBase
- class \Drupal\views\Plugin\views\argument_validator\Entity uses DeprecatedServicePropertyTrait
- class \Drupal\user\Plugin\views\argument_validator\User
- class \Drupal\payment\Plugin\views\argument_validator\ViewPaymentsByOwner
- class \Drupal\user\Plugin\views\argument_validator\User
- class \Drupal\views\Plugin\views\argument_validator\Entity uses DeprecatedServicePropertyTrait
- class \Drupal\views\Plugin\views\argument_validator\ArgumentValidatorPluginBase
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ViewPaymentsByOwner
1 file declares its use of ViewPaymentsByOwner
- ViewPaymentsByOwnerTest.php in tests/
src/ Unit/ Plugin/ views/ argument_validator/ ViewPaymentsByOwnerTest.php
File
- src/
Plugin/ views/ argument_validator/ ViewPaymentsByOwner.php, line 18
Namespace
Drupal\payment\Plugin\views\argument_validatorView source
class ViewPaymentsByOwner extends User {
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $currentUser;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
$argument_validator = parent::create($container, $configuration, $plugin_id, $plugin_definition);
$argument_validator->currentUser = $container
->get('current_user');
return $argument_validator;
}
/**
* Sets the current user.
*
* @param \Drupal\Core\Session\AccountInterface $current_user
* The current user.
*/
public function setCurrentUser(AccountInterface $current_user) {
$this->currentUser = $current_user;
}
/**
* {@inheritdoc}
*/
public function validateArgument($argument) {
if (!parent::validateArgument($argument)) {
return FALSE;
}
// Extract the IDs from the argument. See parent::validateArgument().
if ($this->multipleCapable && $this->options['multiple']) {
$user_ids = array_filter(preg_split('/[,+ ]/', $argument));
}
else {
$user_ids = [
$argument,
];
}
// Allow access when the current user has access to view all payments, or
// when the current user only tries to view their own payments and has
// permission to do so.
return [
$this->currentUser
->id(),
] == $user_ids && $this->currentUser
->hasPermission('payment.payment.view.own') || $this->currentUser
->hasPermission('payment.payment.view.any');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ArgumentValidatorPluginBase:: |
protected | property | The argument handler instance associated with this plugin. | |
ArgumentValidatorPluginBase:: |
public | function | Determines if the administrator has the privileges to use this plugin. | |
ArgumentValidatorPluginBase:: |
protected | function | Blocks user input when the form is shown but we don´t have access. | |
ArgumentValidatorPluginBase:: |
public | function | Processes the summary arguments for displaying. | 1 |
ArgumentValidatorPluginBase:: |
public | function | Sets the parent argument this plugin is associated with. | |
ArgumentValidatorPluginBase:: |
public | function |
Provides the default form for validating options. Overrides PluginBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DeprecatedServicePropertyTrait:: |
public | function | Allows to access deprecated/removed properties. | |
Entity:: |
protected | property | ||
Entity:: |
protected | property | The entity bundle info. | |
Entity:: |
protected | property | The entity type manager. | |
Entity:: |
protected | property | If this validator can handle multiple arguments. | |
Entity:: |
public | function |
Returns a context definition for this argument. Overrides ArgumentValidatorPluginBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
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. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Stores the render API renderer. | 3 |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Clears a plugin. Overrides ViewsPluginInterface:: |
2 |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function |
Filter out stored options depending on the defined options. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns an array of available token replacements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin provider. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
protected | function | Returns the render API renderer. | 1 |
PluginBase:: |
public | function |
Adds elements for available core tokens to a form. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns a string with any core tokens replaced. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function |
Initialize the plugin. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function |
Return the human readable name of the display. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Flattens the structure of form elements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Add anything to the query that we might need to. Overrides ViewsPluginInterface:: |
8 |
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 |
Returns the summary of the settings in the display. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
public | function |
Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface:: |
1 |
PluginBase:: |
public static | function |
Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface:: |
6 |
PluginBase:: |
public | function |
Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns the usesOptions property. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | 1 |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
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. | 2 |
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. | ||
User:: |
protected | property | The user storage. | |
User:: |
public | function |
Provides the default form for setting options. Overrides Entity:: |
1 |
User:: |
public | function |
Calculates dependencies for the configured plugin. Overrides Entity:: |
|
User:: |
protected | function |
Retrieves the options when this is a new access control plugin. Overrides Entity:: |
|
User:: |
public | function |
Provides the default form for submitting options. Overrides Entity:: |
|
User:: |
protected | function |
Validates an individual entity against class access settings. Overrides Entity:: |
|
User:: |
public | function |
Constructs an \Drupal\views\Plugin\views\argument_validator\Entity object. Overrides Entity:: |
|
ViewPaymentsByOwner:: |
protected | property | The current user. | |
ViewPaymentsByOwner:: |
public static | function |
Creates an instance of the plugin. Overrides Entity:: |
|
ViewPaymentsByOwner:: |
public | function | Sets the current user. | |
ViewPaymentsByOwner:: |
public | function |
Performs validation for a given argument. Overrides Entity:: |