interface WebformAccessGroupInterface in Webform 6.x

Same name and namespace in other branches

8.5 modules/webform_access/src/WebformAccessGroupInterface.php \Drupal\webform_access\WebformAccessGroupInterface

Provides an interface defining a webform access group entity.

Hierarchy

interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
  - interface \Drupal\webform_access\WebformAccessGroupInterface

Expanded class hierarchy of WebformAccessGroupInterface

All classes that implement WebformAccessGroupInterface

1 file declares its use of WebformAccessGroupInterface

WebformAccessGroup.php in modules/webform_access/src/Entity/WebformAccessGroup.php

File

modules/webform_access/src/WebformAccessGroupInterface.php, line 10

Namespace

Drupal\webform_access

View source

interface WebformAccessGroupInterface extends ConfigEntityInterface {

  /**
   * Get webform access group type.
   *
   * @return string
   *   The webform access group type.
   */
  public function getType();

  /**
   * Get webform access group type label.
   *
   * @return string
   *   The webform access group type label.
   */
  public function getTypeLabel();

  /**
   * Set admin user ids assigned to webform access group.
   *
   * @param array $uids
   *   An array of admin user ids.
   *
   * @return $this
   */
  public function setAdminIds(array $uids);

  /**
   * Get admin user ids assigned to webform access group.
   *
   * @return array
   *   An array of admin user ids.
   */
  public function getAdminIds();

  /**
   * Set user ids assigned to webform access group.
   *
   * @param array $uids
   *   An array of user ids.
   *
   * @return $this
   */
  public function setUserIds(array $uids);

  /**
   * Get user ids assigned to webform access group.
   *
   * @return array
   *   An array of user ids.
   */
  public function getUserIds();

  /**
   * Set entities assigned to webform access group.
   *
   * @param array $entity_ids
   *   An array of entity ids.
   *   Formatted as 'node:type:field_name:webform'.
   *
   * @return $this
   */
  public function setEntityIds(array $entity_ids);

  /**
   * Get entities assigned to webform access group.
   *
   * @return array
   *   An array of entity ids.
   *   Formatted as 'node:type:field_name:webform'
   */
  public function getEntityIds();

  /**
   * Set email addresses assigned to webform access group.
   *
   * @param array $emails
   *   An array of email addresses .
   *
   * @return $this
   */
  public function setEmails(array $emails);

  /**
   * Get email addresses assigned to webform access group.
   *
   * @return array
   *   An array of email addresses .
   */
  public function getEmails();

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

  // Add/Remote methods.

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

  /**
   * Add admin user id to webform access group.
   *
   * @param int $uid
   *   A admin user id.
   *
   * @return $this
   */
  public function addAdminId($uid);

  /**
   * Remove admin user id to webform access group.
   *
   * @param int $uid
   *   A user id.
   *
   * @return $this
   */
  public function removeAdminId($uid);

  /**
   * Add user id to webform access group.
   *
   * @param int $uid
   *   A user id.
   *
   * @return $this
   */
  public function addUserId($uid);

  /**
   * Remove user id to webform access group.
   *
   * @param int $uid
   *   A user id.
   *
   * @return $this
   */
  public function removeUserId($uid);

  /**
   * Add entity id to webform access group.
   *
   * @param string $entity_type
   *   The source entity type.
   * @param string $entity_id
   *   The source entity id.
   * @param string $field_name
   *   The source entity webform field name.
   * @param string $webform_id
   *   The webform id.
   */
  public function addEntityId($entity_type, $entity_id, $field_name, $webform_id);

  /**
   * Remove entity id to webform access group.
   *
   * @param string $entity_type
   *   The source entity type.
   * @param string $entity_id
   *   The source entity id.
   * @param string $field_name
   *   The source entity webform field name.
   * @param string $webform_id
   *   The webform id.
   */
  public function removeEntityId($entity_type, $entity_id, $field_name, $webform_id);

  /**
   * Add email address to webform access group.
   *
   * @param string $email
   *   An email address.
   *
   * @return $this
   */
  public function addEmail($email);

  /**
   * Remove email address to webform access group.
   *
   * @param int $email
   *   An email address.
   *
   * @return $this
   */
  public function removeEmail($email);

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

  // Caching methods.

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

  /**
   * Invalidates an entity's cache tags upon save.
   */
  public function invalidateTags();

}

Members

Name	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::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::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
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
WebformAccessGroupInterface::addAdminId	public	function	Add admin user id to webform access group.	1
WebformAccessGroupInterface::addEmail	public	function	Add email address to webform access group.	1
WebformAccessGroupInterface::addEntityId	public	function	Add entity id to webform access group.	1
WebformAccessGroupInterface::addUserId	public	function	Add user id to webform access group.	1
WebformAccessGroupInterface::getAdminIds	public	function	Get admin user ids assigned to webform access group.	1
WebformAccessGroupInterface::getEmails	public	function	Get email addresses assigned to webform access group.	1
WebformAccessGroupInterface::getEntityIds	public	function	Get entities assigned to webform access group.	1
WebformAccessGroupInterface::getType	public	function	Get webform access group type.	1
WebformAccessGroupInterface::getTypeLabel	public	function	Get webform access group type label.	1
WebformAccessGroupInterface::getUserIds	public	function	Get user ids assigned to webform access group.	1
WebformAccessGroupInterface::invalidateTags	public	function	Invalidates an entity's cache tags upon save.	1
WebformAccessGroupInterface::removeAdminId	public	function	Remove admin user id to webform access group.	1
WebformAccessGroupInterface::removeEmail	public	function	Remove email address to webform access group.	1
WebformAccessGroupInterface::removeEntityId	public	function	Remove entity id to webform access group.	1
WebformAccessGroupInterface::removeUserId	public	function	Remove user id to webform access group.	1
WebformAccessGroupInterface::setAdminIds	public	function	Set admin user ids assigned to webform access group.	1
WebformAccessGroupInterface::setEmails	public	function	Set email addresses assigned to webform access group.	1
WebformAccessGroupInterface::setEntityIds	public	function	Set entities assigned to webform access group.	1
WebformAccessGroupInterface::setUserIds	public	function	Set user ids assigned to webform access group.	1

You are here

interface WebformAccessGroupInterface in Webform 6.x

Hierarchy

File

Namespace

Members

API Navigation