You are here

Home » API reference » Webform 8.5 » WebformAccessGroup.php

class WebformAccessGroup in Webform 8.5

Same name and namespace in other branches
  1. 6.x modules/webform_access/src/Entity/WebformAccessGroup.php \Drupal\webform_access\Entity\WebformAccessGroup

Defines the webform access group entity.

Plugin annotation


@ConfigEntityType(
  id = "webform_access_group",
  label = @Translation("Webform access group"),
  label_collection = @Translation("Access groups"),
  label_singular = @Translation("access group"),
  label_plural = @Translation("access groups"),
  label_count = @PluralTranslation(
    singular = "@count access group",
    plural = "@count access groups",
  ),
  handlers = {
    "storage" = "\Drupal\webform_access\WebformAccessGroupStorage",
    "access" = "Drupal\webform_access\WebformAccessGroupAccessControlHandler",
    "list_builder" = "Drupal\webform_access\WebformAccessGroupListBuilder",
    "form" = {
      "add" = "Drupal\webform_access\WebformAccessGroupForm",
      "edit" = "Drupal\webform_access\WebformAccessGroupForm",
      "duplicate" = "Drupal\webform_access\WebformAccessGroupForm",
      "delete" = "Drupal\webform_access\WebformAccessGroupDeleteForm",
    }
  },
  admin_permission = "administer webform",
  entity_keys = {
    "id" = "id",
    "label" = "label",
  },
  links = {
    "add-form" = "/admin/structure/webform/config/access/group/manage/add",
    "edit-form" = "/admin/structure/webform/config/access/group/manage/{webform_access_group}",
    "duplicate-form" = "/admin/structure/webform/config/access/group/manage/{webform_access_group}/duplicate",
    "delete-form" = "/admin/structure/webform/config/access/group/manage/{webform_access_group}/delete",
    "collection" = "/admin/structure/webform/config/access/group/manage",
  },
  config_export = {
    "id",
    "uuid",
    "label",
    "description",
    "type",
    "permissions",
    "emails",
  }
)

Hierarchy

Expanded class hierarchy of WebformAccessGroup

4 files declare their use of WebformAccessGroup
WebformAccessBrowserTestBase.php in modules/webform_access/tests/src/Functional/WebformAccessBrowserTestBase.php
WebformAccessTypeListBuilder.php in modules/webform_access/src/WebformAccessTypeListBuilder.php
webform_access.module in modules/webform_access/webform_access.module
Provides webform access controls for webform nodes.
webform_demo_region_contact.install in modules/webform_demo/webform_demo_region_contact/webform_demo_region_contact.install
Install, update and uninstall functions for the webform demo region contact module.

File

modules/webform_access/src/Entity/WebformAccessGroup.php, line 57

Namespace

Drupal\webform_access\Entity
View source 
class WebformAccessGroup extends ConfigEntityBase implements WebformAccessGroupInterface {
  use StringTranslationTrait;

  /**
   * The webform access group ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The webform access group UUID.
   *
   * @var string
   */
  protected $uuid;

  /**
   * The webform access group label.
   *
   * @var string
   */
  protected $label;

  /**
   * The webform access group description.
   *
   * @var string
   */
  protected $description;

  /**
   * The webform access group type.
   *
   * @var string
   */
  protected $type;

  /**
   * The webform access group permissions.
   *
   * @var array
   */
  protected $permissions = [];

  /**
   * The webform access group admin user ids.
   *
   * @var array
   */
  protected $adminIds = [];

  /**
   * The webform access group user ids.
   *
   * @var array
   */
  protected $userIds = [];

  /**
   * The webform access group source entity ids.
   *
   * @var array
   */
  protected $entityIds = [];

  /**
   * The webform access group emails.
   *
   * @var array
   */
  protected $emails = [];

  /**
   * {@inheritdoc}
   */
  public function getType() {
    return $this->type ?: '';
  }

  /**
   * {@inheritdoc}
   */
  public function getTypeLabel() {
    if (empty($this->type)) {
      return '';
    }
    $webform_access_type = WebformAccessType::load($this->type);
    return $webform_access_type ? $webform_access_type
      ->label() : '';
  }

  /**
   * {@inheritdoc}
   */
  public function setAdminIds(array $uids) {
    $this->adminIds = $uids;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getAdminIds() {
    return $this->adminIds;
  }

  /**
   * {@inheritdoc}
   */
  public function setUserIds(array $uids) {
    $this->userIds = $uids;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getUserIds() {
    return $this->userIds;
  }

  /**
   * {@inheritdoc}
   */
  public function setEntityIds(array $entity_ids) {
    $this->entityIds = $entity_ids;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getEntityIds() {
    return $this->entityIds;
  }

  /**
   * {@inheritdoc}
   */
  public function setEmails(array $emails) {
    $this->emails = $emails;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getEmails() {
    return $this->emails;
  }

  /****************************************************************************/

  // Add/Remote methods.

  /****************************************************************************/

  /**
   * {@inheritdoc}
   */
  public function addAdminId($uid) {
    if (!in_array($uid, $this->adminIds)) {
      $this->adminIds[] = $uid;
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function removeAdminId($uid) {
    foreach ($this->adminIds as $index => $adminId) {
      if ($adminId === $uid) {
        unset($this->adminIds[$index]);
      }
    }
    $this->adminIds = array_values($this->adminIds);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function addUserId($uid) {
    if (!in_array($uid, $this->userIds)) {
      $this->userIds[] = $uid;
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function removeUserId($uid) {
    foreach ($this->userIds as $index => $userId) {
      if ($userId === $uid) {
        unset($this->userIds[$index]);
      }
    }
    $this->userIds = array_values($this->userIds);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function addEntityId($entity_type, $entity_id, $field_name, $webform_id) {
    $entity = "{$entity_type}:{$entity_id}:{$field_name}:{$webform_id}";
    if (!in_array($entity, $this->entityIds)) {
      $this->entityIds[] = $entity;
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function removeEntityId($entity_type, $entity_id, $field_name, $webform_id) {
    $entity = "{$entity_type}:{$entity_id}:{$field_name}:{$webform_id}";
    foreach ($this->entityIds as $index => $entityId) {
      if ($entity === $entityId) {
        unset($this->entityIds[$index]);
      }
    }
    $this->entityIds = array_values($this->entityIds);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function addEmail($email) {
    if (!in_array($email, $this->emails)) {
      $this->emails[] = $email;
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function removeEmail($email) {
    foreach ($this->emails as $index => $email_address) {
      if ($email_address === $email) {
        unset($this->emails[$index]);
      }
    }
    $this->emails = array_values($this->emails);
    return $this;
  }

  /****************************************************************************/

  // Caching methods.

  /****************************************************************************/

  /**
   * {@inheritdoc}
   */
  public function invalidateTags() {
    Cache::invalidateTags($this
      ->getCacheTagsToInvalidate());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function
WebformAccessGroup::$adminIds protected property The webform access group admin user ids.
WebformAccessGroup::$description protected property The webform access group description.
WebformAccessGroup::$emails protected property The webform access group emails.
WebformAccessGroup::$entityIds protected property The webform access group source entity ids.
WebformAccessGroup::$id protected property The webform access group ID.
WebformAccessGroup::$label protected property The webform access group label.
WebformAccessGroup::$permissions protected property The webform access group permissions.
WebformAccessGroup::$type protected property The webform access group type.
WebformAccessGroup::$userIds protected property The webform access group user ids.
WebformAccessGroup::$uuid protected property The webform access group UUID. Overrides ConfigEntityBase::$uuid
WebformAccessGroup::addAdminId public function Add admin user id to webform access group. Overrides WebformAccessGroupInterface::addAdminId
WebformAccessGroup::addEmail public function Add email address to webform access group. Overrides WebformAccessGroupInterface::addEmail
WebformAccessGroup::addEntityId public function Add entity id to webform access group. Overrides WebformAccessGroupInterface::addEntityId
WebformAccessGroup::addUserId public function Add user id to webform access group. Overrides WebformAccessGroupInterface::addUserId
WebformAccessGroup::getAdminIds public function Get admin user ids assigned to webform access group. Overrides WebformAccessGroupInterface::getAdminIds
WebformAccessGroup::getEmails public function Get email addresses assigned to webform access group. Overrides WebformAccessGroupInterface::getEmails
WebformAccessGroup::getEntityIds public function Get entities assigned to webform access group. Overrides WebformAccessGroupInterface::getEntityIds
WebformAccessGroup::getType public function Get webform access group type. Overrides WebformAccessGroupInterface::getType
WebformAccessGroup::getTypeLabel public function Get webform access group type label. Overrides WebformAccessGroupInterface::getTypeLabel
WebformAccessGroup::getUserIds public function Get user ids assigned to webform access group. Overrides WebformAccessGroupInterface::getUserIds
WebformAccessGroup::invalidateTags public function Invalidates an entity's cache tags upon save. Overrides WebformAccessGroupInterface::invalidateTags
WebformAccessGroup::removeAdminId public function Remove admin user id to webform access group. Overrides WebformAccessGroupInterface::removeAdminId
WebformAccessGroup::removeEmail public function Remove email address to webform access group. Overrides WebformAccessGroupInterface::removeEmail
WebformAccessGroup::removeEntityId public function Remove entity id to webform access group. Overrides WebformAccessGroupInterface::removeEntityId
WebformAccessGroup::removeUserId public function Remove user id to webform access group. Overrides WebformAccessGroupInterface::removeUserId
WebformAccessGroup::setAdminIds public function Set admin user ids assigned to webform access group. Overrides WebformAccessGroupInterface::setAdminIds
WebformAccessGroup::setEmails public function Set email addresses assigned to webform access group. Overrides WebformAccessGroupInterface::setEmails
WebformAccessGroup::setEntityIds public function Set entities assigned to webform access group. Overrides WebformAccessGroupInterface::setEntityIds
WebformAccessGroup::setUserIds public function Set user ids assigned to webform access group. Overrides WebformAccessGroupInterface::setUserIds