You are here

Home » API reference » User protect 8 » ProtectionRuleInterface.php

interface ProtectionRuleInterface in User protect 8

Provides an interface defining a userprotect_rule entity.

Hierarchy

Expanded class hierarchy of ProtectionRuleInterface

All classes that implement ProtectionRuleInterface

4 files declare their use of ProtectionRuleInterface
ProtectionRuleCrudTest.php in tests/src/Functional/ProtectionRuleCrudTest.php
ProtectionRuleListBuilder.php in src/Controller/ProtectionRuleListBuilder.php
ProtectionRuleUnitTest.php in tests/src/Kernel/Entity/ProtectionRuleUnitTest.php
UserProtectCreationTrait.php in tests/src/Traits/UserProtectCreationTrait.php

File

src/Entity/ProtectionRuleInterface.php, line 12

Namespace

Drupal\userprotect\Entity
View source 
interface ProtectionRuleInterface extends ConfigEntityInterface {

  /**
   * Gets the protected entity type id.
   *
   * @return string
   *   ID of the entity type that is protected.
   */
  public function getProtectedEntityTypeId();

  /**
   * Sets the protected entity type id.
   *
   * @param string $entity_type_id
   *   ID of the entity type that should be protected.
   *
   * @return \Drupal\userprotect\Entity\ProtectionRuleInterface
   *   The class instance this method is called on.
   *
   * @throws \InvalidArgumentException
   *   Thrown if $entity_type_id is invalid.
   */
  public function setProtectedEntityTypeId($entity_type_id);

  /**
   * Gets the protected entity.
   *
   * @return EntityInterface
   *   The loaded entity, if found.
   *   NULL otherwise.
   */
  public function getProtectedEntity();

  /**
   * Gets the protected entity id.
   *
   * @return string|int
   *   ID of the entity that is protected.
   */
  public function getProtectedEntityId();

  /**
   * Gets the protected entity id.
   *
   * @param string|int $entity_id
   *   ID of the entity that should be protected.
   *
   * @return \Drupal\userprotect\Entity\ProtectionRuleInterface
   *   The class instance this method is called on.
   */
  public function setProtectedEntityId($entity_id);

  /**
   * Returns a specific user protection.
   *
   * @param string $protection
   *   The user protection plugin ID.
   *
   * @return \Drupal\userprotect\Plugin\UserProtection\UserProtectionInterface
   *   The user protection object.
   */
  public function getProtection($protection);

  /**
   * Returns the user protections for this protection rule.
   *
   * @return \Drupal\userprotect\Plugin\UserProtection\UserProtectionPluginCollection|\Drupal\userprotect\Plugin\UserProtection\UserProtectionInterface[]
   *   The user protection plugin collection.
   */
  public function getProtections();

  /**
   * Sets the configuration for a user protection plugin instance.
   *
   * @param string $instance_id
   *   The ID of a user protection plugin to set the configuration for.
   * @param array $configuration
   *   The user protection plugin configuration to set.
   *
   * @return \Drupal\userprotect\Entity\ProtectionRuleInterface
   *   The called protection rule entity.
   */
  public function setPluginConfig($instance_id, array $configuration);

  /**
   * Enables a certain protection.
   *
   * @param string $instance_id
   *   The ID of a user protection plugin to enable.
   *
   * @return \Drupal\userprotect\Entity\ProtectionRuleInterface
   *   The called protection rule entity.
   */
  public function enableProtection($instance_id);

  /**
   * Disables a certain protection.
   *
   * @param string $instance_id
   *   The ID of a user protection plugin to disable.
   *
   * @return \Drupal\userprotect\Entity\ProtectionRuleInterface
   *   The called protection rule entity.
   */
  public function disableProtection($instance_id);

  /**
   * Returns a list of roles that may bypass this protection rule.
   *
   * @return array
   *   A list of role names.
   */
  public function getBypassRoles();

  /**
   * Sets the list of roles that may bypass this protection rule.
   *
   * @param array $roles
   *   The roles that may bypass this protection rule.
   *
   * @return \Drupal\userprotect\Entity\ProtectionRuleInterface
   *   The called protection rule entity.
   */
  public function setBypassRoles(array $roles);

  /**
   * Returns the name of the permission to bypass the protection rule.
   *
   * @return string
   *   The permission name.
   */
  public function getPermissionName();

  /**
   * Returns if this rule applies to the given user.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user to check.
   *
   * @return bool
   *   TRUE if this rule applies to the given user.
   *   FALSE otherwise.
   */
  public function appliesTo(UserInterface $user);

  /**
   * Returns if the given protection is enabled on this rule.
   *
   * @param string $protection
   *   The protection to check.
   *
   * @return bool
   *   TRUE if the protection is enabled.
   *   FALSE otherwise.
   */
  public function hasProtection($protection);

  /**
   * Checks if a given operation on an user should be protected.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user object to check access for.
   * @param string $op
   *   The operation that is to be performed on $user.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The account trying to access the entity.
   *
   * @return bool
   *   TRUE if the operation should be protected.
   *   FALSE if the operation is not protected by this rule.
   */
  public function isProtected(UserInterface $user, $op, AccountInterface $account);

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 2
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
ProtectionRuleInterface::appliesTo public function Returns if this rule applies to the given user. 1
ProtectionRuleInterface::disableProtection public function Disables a certain protection. 1
ProtectionRuleInterface::enableProtection public function Enables a certain protection. 1
ProtectionRuleInterface::getBypassRoles public function Returns a list of roles that may bypass this protection rule. 1
ProtectionRuleInterface::getPermissionName public function Returns the name of the permission to bypass the protection rule. 1
ProtectionRuleInterface::getProtectedEntity public function Gets the protected entity. 1
ProtectionRuleInterface::getProtectedEntityId public function Gets the protected entity id. 1
ProtectionRuleInterface::getProtectedEntityTypeId public function Gets the protected entity type id. 1
ProtectionRuleInterface::getProtection public function Returns a specific user protection. 1
ProtectionRuleInterface::getProtections public function Returns the user protections for this protection rule. 1
ProtectionRuleInterface::hasProtection public function Returns if the given protection is enabled on this rule. 1
ProtectionRuleInterface::isProtected public function Checks if a given operation on an user should be protected. 1
ProtectionRuleInterface::setBypassRoles public function Sets the list of roles that may bypass this protection rule. 1
ProtectionRuleInterface::setPluginConfig public function Sets the configuration for a user protection plugin instance. 1
ProtectionRuleInterface::setProtectedEntityId public function Gets the protected entity id. 1
ProtectionRuleInterface::setProtectedEntityTypeId public function Sets the protected entity type id. 1
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 5
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 5
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 5
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 5
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 5