interface ConsentAgreementStorageInterface in General Data Protection Regulation 3.0.x

Defines the storage handler class for Consent Agreement entities.

This extends the base storage class, adding required special handling for Consent Agreement entities.

Hierarchy

• interface \Drupal\Core\Entity\EntityStorageInterface; interface \Drupal\Core\Entity\TranslatableRevisionableStorageInterface
  • interface \Drupal\Core\Entity\ContentEntityStorageInterface
    • interface \Drupal\gdpr_consent\ConsentAgreementStorageInterface

File

modules/gdpr_consent/src/ConsentAgreementStorageInterface.php, line 18

Namespace

Drupal\gdpr_consent

interface ConsentAgreementStorageInterface extends ContentEntityStorageInterface {

  /**
   * Gets a list of Consent Agreement revision IDs for a specific Agreement.
   *
   * @param \Drupal\gdpr_consent\Entity\ConsentAgreementInterface $entity
   *   The Consent Agreement entity.
   *
   * @return int[]
   *   Consent Agreement revision IDs (in ascending order).
   */
  public function revisionIds(ConsentAgreementInterface $entity);

  /**
   * Gets a list of revision IDs for a given user as Consent Agreement author.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user entity.
   *
   * @return int[]
   *   Consent Agreement revision IDs (in ascending order).
   */
  public function userRevisionIds(AccountInterface $account);

  /**
   * Counts the number of revisions in the default language.
   *
   * @param \Drupal\gdpr_consent\Entity\ConsentAgreementInterface $entity
   *   The Consent Agreement entity.
   *
   * @return int
   *   The number of revisions in the default language.
   */
  public function countDefaultLanguageRevisions(ConsentAgreementInterface $entity);

  /**
   * Unsets the language for all Consent Agreement with the given language.
   *
   * @param \Drupal\Core\Language\LanguageInterface $language
   *   The language object.
   */
  public function clearRevisionsLanguage(LanguageInterface $language);

}

Members

Name	Modifiers	Type	Description	Overrides
ConsentAgreementStorageInterface::clearRevisionsLanguage	public	function	Unsets the language for all Consent Agreement with the given language.	1
ConsentAgreementStorageInterface::countDefaultLanguageRevisions	public	function	Counts the number of revisions in the default language.	1
ConsentAgreementStorageInterface::revisionIds	public	function	Gets a list of Consent Agreement revision IDs for a specific Agreement.	1
ConsentAgreementStorageInterface::userRevisionIds	public	function	Gets a list of revision IDs for a given user as Consent Agreement author.	1
ContentEntityStorageInterface::createWithSampleValues	public	function	Creates an entity with sample field values.	2
EntityStorageInterface::create	public	function	Constructs a new entity object, without permanently saving it.	1
EntityStorageInterface::delete	public	function	Deletes permanently saved entities.	1
EntityStorageInterface::deleteRevision	public	function	Delete a specific entity revision.	4
EntityStorageInterface::FIELD_LOAD_CURRENT		constant	Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION		constant	Load the version of an entity's field data specified in the entity.
EntityStorageInterface::getAggregateQuery	public	function	Gets an aggregated query instance.	1
EntityStorageInterface::getEntityType	public	function	Gets the entity type definition.	1
EntityStorageInterface::getEntityTypeId	public	function	Gets the entity type ID.	1
EntityStorageInterface::getQuery	public	function	Gets an entity query instance.	1
EntityStorageInterface::hasData	public	function	Determines if the storage contains any data.	1
EntityStorageInterface::load	public	function	Loads one entity.	1
EntityStorageInterface::loadByProperties	public	function	Load entities by their property values.	1
EntityStorageInterface::loadMultiple	public	function	Loads one or more entities.	1
EntityStorageInterface::loadRevision	public	function	Load a specific entity revision.	4
EntityStorageInterface::loadUnchanged	public	function	Loads an unchanged entity from the database.	1
EntityStorageInterface::resetCache	public	function	Resets the internal entity cache.	1
EntityStorageInterface::restore	public	function	Restores a previously saved entity.	1
EntityStorageInterface::save	public	function	Saves the entity permanently.	1
RevisionableStorageInterface::getLatestRevisionId	public	function	Returns the latest revision identifier for an entity.	2
RevisionableStorageInterface::loadMultipleRevisions	public	function	Loads multiple entity revisions.	2
TranslatableRevisionableStorageInterface::createRevision	public	function	Creates a new revision starting off from the specified entity object. Overrides RevisionableStorageInterface::createRevision	2
TranslatableRevisionableStorageInterface::getLatestTranslationAffectedRevisionId	public	function	Returns the latest revision affecting the specified translation.	2
TranslatableStorageInterface::createTranslation	public	function	Constructs a new entity translation object, without permanently saving it.	2