class EntityLegalDocument in Entity Legal 4.0.x
Same name in this branch
- 4.0.x src/Entity/EntityLegalDocument.php \Drupal\entity_legal\Entity\EntityLegalDocument
- 4.0.x src/Plugin/migrate/source/EntityLegalDocument.php \Drupal\entity_legal\Plugin\migrate\source\EntityLegalDocument
Same name and namespace in other branches
- 8.2 src/Entity/EntityLegalDocument.php \Drupal\entity_legal\Entity\EntityLegalDocument
- 8 src/Entity/EntityLegalDocument.php \Drupal\entity_legal\Entity\EntityLegalDocument
- 3.0.x src/Entity/EntityLegalDocument.php \Drupal\entity_legal\Entity\EntityLegalDocument
Defines the entity legal document entity.
Plugin annotation
@ConfigEntityType(
id = "entity_legal_document",
label = @Translation("Legal document"),
handlers = {
"access" = "Drupal\entity_legal\EntityLegalDocumentAccessControlHandler",
"list_builder" = "Drupal\entity_legal\EntityLegalDocumentListBuilder",
"form" = {
"add" = "Drupal\entity_legal\Form\EntityLegalDocumentForm",
"edit" = "Drupal\entity_legal\Form\EntityLegalDocumentForm",
"delete" = "Drupal\Core\Entity\EntityDeleteForm"
}
},
config_prefix = "document",
admin_permission = "administer entity legal",
bundle_of = "entity_legal_document_version",
entity_keys = {
"id" = "id",
"label" = "label"
},
links = {
"delete-form" = "/admin/structure/legal/manage/{entity_legal_document}/delete",
"edit-form" = "/admin/structure/legal/manage/{entity_legal_document}",
"collection" = "/admin/structure/legal",
"canonical" = "/legal/document/{entity_legal_document}",
},
config_export = {
"id",
"label",
"require_signup",
"require_existing",
"settings",
},
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- class \Drupal\entity_legal\Entity\EntityLegalDocument implements EntityLegalDocumentInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of EntityLegalDocument
4 files declare their use of EntityLegalDocument
- DocumentTest.php in tests/
src/ Kernel/ DocumentTest.php - EntityLegalPermissions.php in src/
EntityLegalPermissions.php - SingleLegalDocumentPublishedVersionConstraintTest.php in tests/
src/ Kernel/ SingleLegalDocumentPublishedVersionConstraintTest.php - UpdateTest.php in tests/
src/ Functional/ UpdateTest.php
File
- src/
Entity/ EntityLegalDocument.php, line 53
Namespace
Drupal\entity_legal\EntityView source
class EntityLegalDocument extends ConfigEntityBundleBase implements EntityLegalDocumentInterface {
/**
* The legal document ID.
*
* @var string
*/
protected $id;
/**
* The human-readable label of the legal document.
*
* @var string
*/
protected $label;
/**
* Require new users to accept this document on signup.
*
* @var bool
*/
protected $require_signup = FALSE;
/**
* Require existing users to accept this document.
*
* @var bool
*/
protected $require_existing = FALSE;
/**
* Am array of additional data related to the legal document.
*
* @var array
*/
protected $settings = [];
/**
* {@inheritdoc}
*/
public static function preCreate(EntityStorageInterface $storage, array &$values) {
parent::preCreate($storage, $values);
if (empty($values['settings']['title_pattern'])) {
$values['settings']['title_pattern'] = '[entity_legal_document:label]';
}
}
/**
* {@inheritdoc}
*/
public function delete() {
if (!$this
->isNew()) {
// Delete all associated versions.
$versions = $this
->getAllVersions();
foreach ($versions as $version) {
$version
->delete();
}
}
parent::delete();
}
/**
* {@inheritdoc}
*/
public function getAcceptanceForm() {
/** @var \Drupal\entity_legal\Form\EntityLegalDocumentAcceptanceForm $form */
$form = \Drupal::classResolver()
->getInstanceFromDefinition(EntityLegalDocumentAcceptanceForm::class);
$form
->setDocument($this);
return \Drupal::formBuilder()
->getForm($form);
}
/**
* {@inheritdoc}
*/
public function getAllVersions() {
$query = \Drupal::entityQuery(ENTITY_LEGAL_DOCUMENT_VERSION_ENTITY_NAME)
->condition('document_name', $this
->id());
$results = $query
->execute();
if (!empty($results)) {
return \Drupal::entityTypeManager()
->getStorage(ENTITY_LEGAL_DOCUMENT_VERSION_ENTITY_NAME)
->loadMultiple($results);
}
else {
return [];
}
}
/**
* {@inheritdoc}
*/
public function getPublishedVersion() {
$storage = $this
->entityTypeManager()
->getStorage(ENTITY_LEGAL_DOCUMENT_VERSION_ENTITY_NAME);
$ids = $storage
->getQuery()
->condition('document_name', $this
->id())
->condition('published', TRUE)
->execute();
if (!$ids) {
return FALSE;
}
$id = reset($ids);
return $storage
->load($id);
}
/**
* {@inheritdoc}
*/
public function setPublishedVersion(EntityLegalDocumentVersionInterface $version_entity) {
if (!$version_entity
->isNew()) {
/** @var \Drupal\entity_legal\EntityLegalDocumentVersionInterface $unchanged_version */
$unchanged_version = $this
->entityTypeManager()
->getStorage(ENTITY_LEGAL_DOCUMENT_VERSION_ENTITY_NAME)
->loadUnchanged($version_entity
->id());
if ($unchanged_version
->isPublished()) {
// An existing entity is already published.
return TRUE;
}
}
// If the version entity is not of this bundle, fail.
if ($version_entity
->bundle() != $this
->id()) {
return FALSE;
}
// Unpublish a published version.
if ($actual_published_version = $this
->getPublishedVersion()) {
$actual_published_version
->unpublish()
->save();
}
$version_entity
->publish()
->save();
return TRUE;
}
/**
* {@inheritdoc}
*/
public function getAcceptanceLabel() {
$label = '';
$published_version = $this
->getPublishedVersion();
if ($published_version) {
$label = $published_version
->get('acceptance_label')->value;
}
$token_service = \Drupal::service('token');
$label = $token_service
->replace($label, [
ENTITY_LEGAL_DOCUMENT_ENTITY_NAME => $this,
]);
return Xss::filter($label);
}
/**
* {@inheritdoc}
*/
public function toUrl($rel = 'canonical', array $options = []) {
// Unless language was already provided, avoid setting an explicit language.
$options += [
'language' => NULL,
];
return parent::toUrl($rel, $options);
}
/**
* {@inheritdoc}
*/
public function userMustAgree($new_user = FALSE, AccountInterface $account = NULL) {
// User cannot agree unless there is a published version.
if (!$this
->getPublishedVersion()) {
return FALSE;
}
if (empty($account)) {
$account = \Drupal::currentUser();
}
if ($new_user) {
return !empty($this->require_signup);
}
else {
return !empty($this->require_existing) && $account
->hasPermission($this
->getPermissionExistingUser());
}
}
/**
* {@inheritdoc}
*/
public function userHasAgreed(AccountInterface $account = NULL) {
if (empty($account)) {
$account = \Drupal::currentUser();
}
return count($this
->getAcceptances($account)) > 0;
}
/**
* {@inheritdoc}
*/
public function getAcceptances(AccountInterface $account = NULL, $published = TRUE) {
$acceptances = [];
$versions = [];
if ($published) {
$versions[] = $this
->getPublishedVersion();
}
else {
$versions = $this
->getAllVersions();
}
/** @var \Drupal\entity_legal\EntityLegalDocumentVersionInterface $version */
foreach ($versions as $version) {
$acceptances += $version
->getAcceptances($account);
}
return $acceptances;
}
/**
* {@inheritdoc}
*/
public function getPermissionView() {
return 'legal view ' . $this
->id();
}
/**
* {@inheritdoc}
*/
public function getPermissionExistingUser() {
return 'legal re-accept ' . $this
->id();
}
/**
* {@inheritdoc}
*/
public function getAcceptanceDeliveryMethod($new_user = FALSE) {
$setting_group = $new_user ? 'new_users' : 'existing_users';
return isset($this
->get('settings')[$setting_group]['require_method']) ? $this
->get('settings')[$setting_group]['require_method'] : FALSE;
}
/**
* {@inheritdoc}
*/
public function save() {
$status = parent::save();
if ($status == SAVED_NEW && !\Drupal::isConfigSyncing()) {
// Add or remove the body field, as needed.
$field = FieldConfig::loadByName('entity_legal_document_version', $this
->id(), 'entity_legal_document_text');
if (empty($field)) {
FieldConfig::create([
'field_storage' => FieldStorageConfig::loadByName('entity_legal_document_version', 'entity_legal_document_text'),
'bundle' => $this
->id(),
'label' => 'Document text',
'settings' => [
'display_summary' => FALSE,
],
])
->save();
// Assign widget settings for the 'default' form mode.
\Drupal::service('entity_display.repository')
->getFormDisplay('entity_legal_document_version', $this
->id(), 'default')
->setComponent('entity_legal_document_text', [
'type' => 'text_textarea_with_summary',
])
->save();
// Assign display settings for 'default' view mode.
\Drupal::service('entity_display.repository')
->getViewDisplay('entity_legal_document_version', $this
->id(), 'default')
->setComponent('entity_legal_document_text', [
'label' => 'hidden',
'type' => 'text_default',
])
->save();
}
}
else {
Cache::invalidateTags([
"entity_legal_document:{$this->id()}",
]);
}
return $status;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | ||
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
14 |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
8 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
ConfigEntityBundleBase:: |
protected | function | Deletes display if a bundle is deleted. | |
ConfigEntityBundleBase:: |
protected | function | Returns view or form displays for this bundle. | |
ConfigEntityBundleBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityBase:: |
2 |
ConfigEntityBundleBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase:: |
2 |
ConfigEntityBundleBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase:: |
|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 2 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
EntityLegalDocument:: |
protected | property | The legal document ID. | |
EntityLegalDocument:: |
protected | property | The human-readable label of the legal document. | |
EntityLegalDocument:: |
protected | property | Require existing users to accept this document. | |
EntityLegalDocument:: |
protected | property | Require new users to accept this document on signup. | |
EntityLegalDocument:: |
protected | property | Am array of additional data related to the legal document. | |
EntityLegalDocument:: |
public | function |
Deletes an entity permanently. Overrides EntityBase:: |
|
EntityLegalDocument:: |
public | function |
Get the acceptance delivery method for a given user type. Overrides EntityLegalDocumentInterface:: |
|
EntityLegalDocument:: |
public | function |
Get an acceptance form for this legal document. Overrides EntityLegalDocumentInterface:: |
|
EntityLegalDocument:: |
public | function |
Get the label to be shown on the acceptance checkbox. Overrides EntityLegalDocumentInterface:: |
|
EntityLegalDocument:: |
public | function |
Get the acceptances for this entity legal document revision. Overrides EntityLegalDocumentInterface:: |
|
EntityLegalDocument:: |
public | function |
Get all versions of this legal document entity. Overrides EntityLegalDocumentInterface:: |
|
EntityLegalDocument:: |
public | function |
Get the permission name for new users accepting this document. Overrides EntityLegalDocumentInterface:: |
|
EntityLegalDocument:: |
public | function |
Get the permission name for any user viewing this agreement. Overrides EntityLegalDocumentInterface:: |
|
EntityLegalDocument:: |
public | function |
Get the current published version of this document. Overrides EntityLegalDocumentInterface:: |
|
EntityLegalDocument:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityBase:: |
|
EntityLegalDocument:: |
public | function |
Saves an entity permanently. Overrides ConfigEntityBase:: |
|
EntityLegalDocument:: |
public | function |
Set the published document version. Overrides EntityLegalDocumentInterface:: |
|
EntityLegalDocument:: |
public | function |
Gets the URL object for the entity. Overrides ConfigEntityBase:: |
|
EntityLegalDocument:: |
public | function |
Check if the given user has agreed to the current version of this document. Overrides EntityLegalDocumentInterface:: |
|
EntityLegalDocument:: |
public | function |
Checks to see if a given user can agree to this document. Overrides EntityLegalDocumentInterface:: |
|
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |