class ProtectionRule in User protect 8
Defines the Protection rule entity.
Plugin annotation
@ConfigEntityType(
id = "userprotect_rule",
label = @Translation("Protection rule"),
handlers = {
"storage" = "Drupal\Core\Config\Entity\ConfigEntityStorage",
"list_builder" = "Drupal\userprotect\Controller\ProtectionRuleListBuilder",
"form" = {
"add" = "Drupal\userprotect\Form\ProtectionRuleAddForm",
"edit" = "Drupal\userprotect\Form\ProtectionRuleEditForm",
"delete" = "Drupal\userprotect\Form\ProtectionRuleDeleteForm"
},
},
admin_permission = "userprotect.administer",
config_prefix = "rule",
entity_keys = {
"id" = "name",
"label" = "label",
"uuid" = "uuid"
},
config_export = {
"name",
"label",
"uuid",
"protectedEntityTypeId",
"protectedEntityId",
"protections"
},
links = {
"edit-form" = "/admin/config/people/userprotect/manage/{userprotect_rule}",
"delete-form" = "/admin/config/people/userprotect/manage/{userprotect_rule}/delete"
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\userprotect\Entity\ProtectionRule implements EntityWithPluginCollectionInterface, ProtectionRuleInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of ProtectionRule
4 files declare their use of ProtectionRule
- ProtectionRuleCrudTest.php in tests/
src/ Functional/ ProtectionRuleCrudTest.php - ProtectionRuleUnitTest.php in tests/
src/ Kernel/ Entity/ ProtectionRuleUnitTest.php - RoleDelegationIntegrationTest.php in tests/
src/ Functional/ RoleDelegation/ RoleDelegationIntegrationTest.php - UserProtectCreationTrait.php in tests/
src/ Traits/ UserProtectCreationTrait.php
File
- src/
Entity/ ProtectionRule.php, line 51
Namespace
Drupal\userprotect\EntityView source
class ProtectionRule extends ConfigEntityBase implements ProtectionRuleInterface, EntityWithPluginCollectionInterface {
/**
* The name of the protection rule.
*
* @var string
*/
public $name;
/**
* The protection rule label.
*
* @var string
*/
public $label;
/**
* The protection rule UUID.
*
* @var string
*/
public $uuid;
/**
* The entity type the protection applies for.
*
* Can be "user" or "user_role".
*
* @var string
*/
protected $protectedEntityTypeId = 'user_role';
/**
* The entity ID the protection applies for.
*
* @var string|int
* The identifier of the protected entity.
*/
protected $protectedEntityId;
/**
* The elements that are protected by this rule.
*
* @var array
*/
protected $protections = [];
/**
* Holds the collection of protections that are used by this protection rule.
*
* @var \Drupal\userprotect\Plugin\UserProtection\UserProtectionPluginCollection
*/
protected $protectionsCollection;
/**
* {@inheritdoc}
*/
protected $pluginConfigKey = 'protections';
/**
* List of user role IDs to that may bypass this protection rule.
*
* This property is saved as user permissions.
*
* @var array
*/
protected $bypassRoles = [];
/**
* Overrides Drupal\Core\Entity\Entity::id().
*/
public function id() {
return $this->name;
}
/**
* {@inheritdoc}
*/
public function getProtectedEntityTypeId() {
return $this->protectedEntityTypeId;
}
/**
* {@inheritdoc}
*/
public function setProtectedEntityTypeId($entity_type_id) {
// Check if given entity type exists. An InvalidArgumentException will be
// thrown if not.
\Drupal::entityTypeManager()
->getDefinition($entity_type_id, TRUE);
$this->protectedEntityTypeId = $entity_type_id;
return $this;
}
/**
* {@inheritdoc}
*/
public function getProtectedEntity() {
if ($this
->getProtectedEntityId()) {
return \Drupal::entityTypeManager()
->getStorage($this
->getProtectedEntityTypeId())
->load($this
->getProtectedEntityId());
}
}
/**
* {@inheritdoc}
*/
public function getProtectedEntityId() {
return $this->protectedEntityId;
}
/**
* {@inheritdoc}
*/
public function setProtectedEntityId($entity_id) {
$this->protectedEntityId = $entity_id;
return $this;
}
/**
* {@inheritdoc}
*/
public function getProtection($protection) {
return $this
->getProtections()
->get($protection);
}
/**
* {@inheritdoc}
*/
public function getProtections() {
if (!isset($this->protectionsCollection)) {
$this->protectionsCollection = new UserProtectionPluginCollection(UserProtect::pluginManager(), $this->protections);
}
return $this->protectionsCollection;
}
/**
* {@inheritdoc}
*/
public function getPluginCollections() {
return [
'protections' => $this
->getProtections(),
];
}
/**
* {@inheritdoc}
*/
public function setPluginConfig($instance_id, array $configuration) {
$this->protections[$instance_id] = $configuration;
if (isset($this->protectionsCollection)) {
$this->protectionsCollection
->setInstanceConfiguration($instance_id, $configuration);
$this->protectionsCollection
->sort();
}
return $this;
}
/**
* {@inheritdoc}
*/
public function enableProtection($instance_id) {
$this
->setPluginConfig($instance_id, [
'status' => TRUE,
]);
return $this;
}
/**
* {@inheritdoc}
*/
public function disableProtection($instance_id) {
$this
->setPluginConfig($instance_id, [
'status' => FALSE,
]);
return $this;
}
/**
* {@inheritdoc}
*/
public function toArray() {
$properties = parent::toArray();
$names = [
'protections',
'protectedEntityTypeId',
'protectedEntityId',
];
foreach ($names as $name) {
$properties[$name] = $this
->get($name);
}
return $properties;
}
/**
* Overrides ConfigEntityBase::calculateDependencies().
*/
public function calculateDependencies() {
parent::calculateDependencies();
// Always add a dependency on the user module.
$this
->addDependency('module', 'user');
// Add a dependency on an user role in case this protection rule protects
// an user role.
$protected_entity = $this
->getProtectedEntity();
if ($protected_entity instanceof ConfigEntityInterface) {
$this
->addDependency('config', $protected_entity
->getConfigDependencyName());
}
return $this->dependencies;
}
/**
* {@inheritdoc}
*/
protected function calculatePluginDependencies(PluginInspectionInterface $instance) {
// Only add dependencies for plugins that are enabled.
// @see \Drupal\userprotect\Plugin\UserProtection\UserProtectionPluginCollection::getConfiguration()
if (isset($this->protections[$instance
->getPluginId()])) {
parent::calculatePluginDependencies($instance);
}
}
/**
* {@inheritdoc}
*/
public function getBypassRoles() {
return $this->bypassRoles;
}
/**
* {@inheritdoc}
*/
public function setBypassRoles(array $roles) {
$this->bypassRoles = $roles;
return $this;
}
/**
* {@inheritdoc}
*/
public static function postLoad(EntityStorageInterface $storage_controller, array &$entities) {
parent::postLoad($storage_controller, $entities);
foreach ($entities as $entity) {
$permission = $entity
->getPermissionName();
if ($permission) {
$roles = array_keys(user_role_names(FALSE, $permission));
$entity
->setBypassRoles($roles);
}
}
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage_controller, $update = TRUE) {
parent::postSave($storage_controller, $update);
// Set bypass permissions.
$roles = $this
->getBypassRoles();
$permission = $this
->getPermissionName();
if ($roles && $permission) {
foreach (user_roles() as $rid => $name) {
$enabled = in_array($rid, $roles, TRUE);
user_role_change_permissions($rid, [
$permission => $enabled,
]);
}
}
}
/**
* {@inheritdoc}
*/
public function getPermissionName() {
return 'userprotect.' . $this
->id() . '.bypass';
}
/**
* {@inheritdoc}
*/
public function appliesTo(UserInterface $user) {
switch ($this->protectedEntityTypeId) {
case 'user':
return $this->protectedEntityId == $user
->id();
case 'user_role':
return $user
->hasRole($this->protectedEntityId);
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function hasProtection($protection) {
if ($this
->getProtections()
->has($protection)) {
return $this
->getProtection($protection)
->isEnabled();
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function isProtected(UserInterface $user, $op, AccountInterface $account) {
// First check if this protection rule is applyable to the given user.
if (!$this
->appliesTo($user)) {
// Not applyable. The operation is not protected by this rule.
return FALSE;
}
// Check if the asked operation is equal to a protection plugin name
// and if so, check if that protection plugin is enabled for this
// rule.
if ($this
->hasProtection($op)) {
// Protection enabled. The operation is protected by this rule.
return TRUE;
}
foreach ($this
->getProtections() as $protection) {
if ($protection
->isEnabled()) {
if ($protection
->isProtected($user, $op, $account)) {
// The plugin says the operation is not permitted.
return TRUE;
}
}
}
// In all other cases, the operation is not protected by this rule.
return FALSE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
13 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
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 | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
16 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
ProtectionRule:: |
protected | property | List of user role IDs to that may bypass this protection rule. | |
ProtectionRule:: |
public | property | The protection rule label. | |
ProtectionRule:: |
public | property | The name of the protection rule. | |
ProtectionRule:: |
protected | property | ||
ProtectionRule:: |
protected | property | The entity ID the protection applies for. | |
ProtectionRule:: |
protected | property | The entity type the protection applies for. | |
ProtectionRule:: |
protected | property | The elements that are protected by this rule. | |
ProtectionRule:: |
protected | property | Holds the collection of protections that are used by this protection rule. | |
ProtectionRule:: |
public | property |
The protection rule UUID. Overrides ConfigEntityBase:: |
|
ProtectionRule:: |
public | function |
Returns if this rule applies to the given user. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Overrides ConfigEntityBase::calculateDependencies(). Overrides ConfigEntityBase:: |
|
ProtectionRule:: |
protected | function |
Calculates and adds dependencies of a specific plugin instance. Overrides PluginDependencyTrait:: |
|
ProtectionRule:: |
public | function |
Disables a certain protection. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Enables a certain protection. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Returns a list of roles that may bypass this protection rule. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Returns the name of the permission to bypass the protection rule. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface:: |
|
ProtectionRule:: |
public | function |
Gets the protected entity. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Gets the protected entity id. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Gets the protected entity type id. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Returns a specific user protection. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Returns the user protections for this protection rule. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Returns if the given protection is enabled on this rule. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Overrides Drupal\Core\Entity\Entity::id(). Overrides EntityBase:: |
|
ProtectionRule:: |
public | function |
Checks if a given operation on an user should be protected. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public static | function |
Acts on loaded entities. Overrides EntityBase:: |
|
ProtectionRule:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase:: |
|
ProtectionRule:: |
public | function |
Sets the list of roles that may bypass this protection rule. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Sets the configuration for a user protection plugin instance. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Gets the protected entity id. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Sets the protected entity type id. Overrides ProtectionRuleInterface:: |
|
ProtectionRule:: |
public | function |
Gets an array of all property values. Overrides ConfigEntityBase:: |
|
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |