You are here

Home » API reference » Entity Legal 8.2 » EntityLegalDocument.php

class EntityLegalDocument in Entity Legal 8.2

Same name in this branch
  1. 8.2 src/Entity/EntityLegalDocument.php \Drupal\entity_legal\Entity\EntityLegalDocument
  2. 8.2 src/Plugin/migrate/source/EntityLegalDocument.php \Drupal\entity_legal\Plugin\migrate\source\EntityLegalDocument
Same name and namespace in other branches
  1. 8 src/Entity/EntityLegalDocument.php \Drupal\entity_legal\Entity\EntityLegalDocument
  2. 4.0.x src/Entity/EntityLegalDocument.php \Drupal\entity_legal\Entity\EntityLegalDocument
  3. 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

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\Entity
View 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) {

      // 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.
        entity_get_form_display('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.
        entity_get_display('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

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::$uuid protected property The UUID for this entity.
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::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::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
ConfigEntityBundleBase::deleteDisplays protected function Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays protected function Returns view or form displays for this bundle.
ConfigEntityBundleBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete 2
ConfigEntityBundleBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave 2
ConfigEntityBundleBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
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::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::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
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.
EntityLegalDocument::$id protected property The legal document ID.
EntityLegalDocument::$label protected property The human-readable label of the legal document.
EntityLegalDocument::$require_existing protected property Require existing users to accept this document.
EntityLegalDocument::$require_signup protected property Require new users to accept this document on signup.
EntityLegalDocument::$settings protected property Am array of additional data related to the legal document.
EntityLegalDocument::delete public function Deletes an entity permanently. Overrides EntityBase::delete
EntityLegalDocument::getAcceptanceDeliveryMethod public function Get the acceptance delivery method for a given user type. Overrides EntityLegalDocumentInterface::getAcceptanceDeliveryMethod
EntityLegalDocument::getAcceptanceForm public function Get an acceptance form for this legal document. Overrides EntityLegalDocumentInterface::getAcceptanceForm
EntityLegalDocument::getAcceptanceLabel public function Get the label to be shown on the acceptance checkbox. Overrides EntityLegalDocumentInterface::getAcceptanceLabel
EntityLegalDocument::getAcceptances public function Get the acceptances for this entity legal document revision. Overrides EntityLegalDocumentInterface::getAcceptances
EntityLegalDocument::getAllVersions public function Get all versions of this legal document entity. Overrides EntityLegalDocumentInterface::getAllVersions
EntityLegalDocument::getPermissionExistingUser public function Get the permission name for new users accepting this document. Overrides EntityLegalDocumentInterface::getPermissionExistingUser
EntityLegalDocument::getPermissionView public function Get the permission name for any user viewing this agreement. Overrides EntityLegalDocumentInterface::getPermissionView
EntityLegalDocument::getPublishedVersion public function Get the current published version of this document. Overrides EntityLegalDocumentInterface::getPublishedVersion
EntityLegalDocument::preCreate public static function Changes the values of an entity before it is created. Overrides EntityBase::preCreate
EntityLegalDocument::save public function Saves an entity permanently. Overrides ConfigEntityBase::save
EntityLegalDocument::setPublishedVersion public function Set the published document version. Overrides EntityLegalDocumentInterface::setPublishedVersion
EntityLegalDocument::toUrl public function Gets the URL object for the entity. Overrides ConfigEntityBase::toUrl
EntityLegalDocument::userHasAgreed public function Check if the given user has agreed to the current version of this document. Overrides EntityLegalDocumentInterface::userHasAgreed
EntityLegalDocument::userMustAgree public function Checks to see if a given user can agree to this document. Overrides EntityLegalDocumentInterface::userMustAgree
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
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