interface EntityLegalDocumentInterface in Entity Legal 4.0.x
Same name and namespace in other branches
- 8.2 src/EntityLegalDocumentInterface.php \Drupal\entity_legal\EntityLegalDocumentInterface
- 3.0.x src/EntityLegalDocumentInterface.php \Drupal\entity_legal\EntityLegalDocumentInterface
Interface EntityLegalDocumentInterface.
@package Drupal\entity_legal
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\entity_legal\EntityLegalDocumentInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
Expanded class hierarchy of EntityLegalDocumentInterface
All classes that implement EntityLegalDocumentInterface
7 files declare their use of EntityLegalDocumentInterface
- EntityLegalController.php in src/
Controller/ EntityLegalController.php - EntityLegalDocument.php in src/
Entity/ EntityLegalDocument.php - EntityLegalDocumentAcceptanceForm.php in src/
Form/ EntityLegalDocumentAcceptanceForm.php - EntityLegalTestBase.php in src/
Tests/ EntityLegalTestBase.php - EntityLegalTestTrait.php in tests/
src/ Traits/ EntityLegalTestTrait.php
File
- src/
EntityLegalDocumentInterface.php, line 13
Namespace
Drupal\entity_legalView source
interface EntityLegalDocumentInterface extends ConfigEntityInterface {
/**
* Get the acceptance delivery method for a given user type.
*
* @param bool $new_user
* Get the method for new signups or existing accounts.
*
* @return string
* The acceptance delivery method.
*/
public function getAcceptanceDeliveryMethod($new_user = FALSE);
/**
* Get an acceptance form for this legal document.
*
* @return array
* The drupal acceptance form.
*/
public function getAcceptanceForm();
/**
* Get the label to be shown on the acceptance checkbox.
*
* @return string
* The label to be shown on the acceptance checkbox.
*/
public function getAcceptanceLabel();
/**
* Get the acceptances for this entity legal document revision.
*
* @param \Drupal\Core\Session\AccountInterface|null $account
* The Drupal user account to check for, or get all acceptances if FALSE.
* @param bool $published
* Get acceptances only for the currently published version.
*
* @return array
* The acceptance entities keyed by acceptance id.
*/
public function getAcceptances(AccountInterface $account = NULL, $published = TRUE);
/**
* Get all versions of this legal document entity.
*
* @return array
* All versions of this legal document entity.
*/
public function getAllVersions();
/**
* Get the permission name for any user viewing this agreement.
*
* @return string
* The user permission, used with user_access.
*/
public function getPermissionView();
/**
* Get the permission name for new users accepting this document.
*
* @return string
* The user permission, used with user_access.
*/
public function getPermissionExistingUser();
/**
* Get the current published version of this document.
*
* @return bool|EntityLegalDocumentVersionInterface
* The current legal document version or FALSE if none found.
*/
public function getPublishedVersion();
/**
* Set the published document version.
*
* @param EntityLegalDocumentVersionInterface $version_entity
* The legal document version to set as the published version.
*
* @return bool
* Whether or not the published version was set successfully.
*/
public function setPublishedVersion(EntityLegalDocumentVersionInterface $version_entity);
/**
* Check if the given user has agreed to the current version of this document.
*
* @param \Drupal\Core\Session\AccountInterface|null $account
* The Drupal user account to check. Default logged in user if not provided.
*
* @return bool
* Whether or not the user has agreed to the current version.
*/
public function userHasAgreed(AccountInterface $account = NULL);
/**
* Checks to see if a given user can agree to this document.
*
* @param bool $new_user
* Whether or not the user to check is a new user signup or not.
* @param \Drupal\Core\Session\AccountInterface|null $account
* The user account to check the access permissions of. Defaults to the
* current user if none is provided.
*
* @return bool
* Can a user agree to this document.
*/
public function userMustAgree($new_user = FALSE, AccountInterface $account = NULL);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessibleInterface:: |
public | function | Checks data value access. | 9 |
CacheableDependencyInterface:: |
public | function | The cache contexts associated with this object. | 34 |
CacheableDependencyInterface:: |
public | function | The maximum age for which this object may be cached. | 34 |
CacheableDependencyInterface:: |
public | function | The cache tags associated with this object. | 27 |
ConfigEntityInterface:: |
public | function | Calculates dependencies and stores them in the dependency property. | 2 |
ConfigEntityInterface:: |
public | function | Disables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Enables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Gets the configuration dependencies. | 2 |
ConfigEntityInterface:: |
public | function | Gets whether on not the data is trusted. | 2 |
ConfigEntityInterface:: |
public | function | Checks whether this entity is installable. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether this entity is being changed during the uninstall process. | 2 |
ConfigEntityInterface:: |
public | function | Informs the entity that entities it depends on will be deleted. | 2 |
ConfigEntityInterface:: |
public | function | Sets the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Sets the status of the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether the configuration entity is enabled. | 2 |
ConfigEntityInterface:: |
public | function | Sets that the data should be trusted. | 2 |
EntityInterface:: |
public | function | Gets the bundle of the entity. | 2 |
EntityInterface:: |
public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 2 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 2 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 2 |
EntityInterface:: |
public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface:: |
public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface:: |
public | function | Gets the configuration dependency name. | 2 |
EntityInterface:: |
public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity type definition. | 2 |
EntityInterface:: |
public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface:: |
public | function | Gets the original ID. | 2 |
EntityInterface:: |
public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface:: |
public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface:: |
public | function | Gets the identifier. | 2 |
EntityInterface:: |
public | function | Determines whether the entity is new. | 2 |
EntityInterface:: |
public | function | Gets the label of the entity. | 2 |
EntityInterface:: |
public | function | Gets the language of the entity. | 2 |
EntityInterface:: |
public static | function | Loads an entity. | 2 |
EntityInterface:: |
public static | function | Loads one or more entities. | 2 |
EntityInterface:: |
public | function | Acts on a created entity before hooks are invoked. | 2 |
EntityInterface:: |
public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface:: |
public static | function | Acts on loaded entities. | 3 |
EntityInterface:: |
public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface:: |
public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface:: |
public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface:: |
public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface:: |
public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface:: |
public | function | Saves an entity permanently. | 2 |
EntityInterface:: |
public | function | Sets the original ID. | 2 |
EntityInterface:: |
public | function | Gets an array of all property values. | 3 |
EntityInterface:: |
public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface:: |
public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
EntityLegalDocumentInterface:: |
public | function | Get the acceptance delivery method for a given user type. | 1 |
EntityLegalDocumentInterface:: |
public | function | Get an acceptance form for this legal document. | 1 |
EntityLegalDocumentInterface:: |
public | function | Get the label to be shown on the acceptance checkbox. | 1 |
EntityLegalDocumentInterface:: |
public | function | Get the acceptances for this entity legal document revision. | 1 |
EntityLegalDocumentInterface:: |
public | function | Get all versions of this legal document entity. | 1 |
EntityLegalDocumentInterface:: |
public | function | Get the permission name for new users accepting this document. | 1 |
EntityLegalDocumentInterface:: |
public | function | Get the permission name for any user viewing this agreement. | 1 |
EntityLegalDocumentInterface:: |
public | function | Get the current published version of this document. | 1 |
EntityLegalDocumentInterface:: |
public | function | Set the published document version. | 1 |
EntityLegalDocumentInterface:: |
public | function | Check if the given user has agreed to the current version of this document. | 1 |
EntityLegalDocumentInterface:: |
public | function | Checks to see if a given user can agree to this document. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
SynchronizableInterface:: |
public | function | Returns whether this entity is being changed as part of a synchronization. | 1 |
SynchronizableInterface:: |
public | function | Sets the status of the synchronization flag. | 1 |
ThirdPartySettingsInterface:: |
public | function | Gets the list of third parties that store information. | 5 |
ThirdPartySettingsInterface:: |
public | function | Gets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface:: |
public | function | Gets all third-party settings of a given module. | 5 |
ThirdPartySettingsInterface:: |
public | function | Sets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface:: |
public | function | Unsets a third-party setting. | 5 |