You are here

Home » API reference » Agreement 3.0.x » Agreement.php

class Agreement in Agreement 3.0.x

Same name in this branch
  1. 3.0.x src/Entity/Agreement.php \Drupal\agreement\Entity\Agreement
  2. 3.0.x src/Plugin/migrate/source/Agreement.php \Drupal\agreement\Plugin\migrate\source\Agreement
  3. 3.0.x src/Plugin/migrate/destination/Agreement.php \Drupal\agreement\Plugin\migrate\destination\Agreement
Same name and namespace in other branches
  1. 8.2 src/Entity/Agreement.php \Drupal\agreement\Entity\Agreement

Describes an agreement configuration.

Plugin annotation


@ConfigEntityType(
  id = "agreement",
  label = @Translation("Agreement"),
  admin_permission = "administer agreements",
  handlers = {
    "list_builder" = "Drupal\agreement\Entity\AgreementListBuilder",
    "form" = {
      "default" = "Drupal\agreement\Entity\AgreementForm",
      "delete" = "Drupal\agreement\Entity\AgreementDeleteForm",
    },
    "route_provider" = {
      "html" = "Drupal\agreement\Entity\Routing\AgreementRouteProvider",
    },
  },
  config_prefix = "agreement",
  static_cache = TRUE,
  entity_keys = {
    "id" = "id",
    "label" = "label",
  },
  links = {
    "delete-form" = "/admin/config/people/agreement/manage/{agreement}/delete",
    "edit-form" = "/admin/config/people/agreement/manage/{agreement}",
    "collection" = "/admin/config/people/agreement/manage",
  },
  config_export = {
    "id",
    "label",
    "path",
    "settings",
    "agreement",
  }
)

Hierarchy

Expanded class hierarchy of Agreement

10 files declare their use of Agreement
AgreementEntityTest.php in tests/src/Unit/Plugin/views/field/AgreementEntityTest.php
AgreementForm.php in src/Form/AgreementForm.php
AgreementHandler.php in src/AgreementHandler.php
AgreementHandlerInterface.php in src/AgreementHandlerInterface.php
AgreementHandlerTest.php in tests/src/Unit/AgreementHandlerTest.php

... See full list

7 string references to 'Agreement'
agreement.info.yml in ./agreement.info.yml
agreement.info.yml
agreement.schema.yml in config/schema/agreement.schema.yml
config/schema/agreement.schema.yml
agreement.views.schema.yml in config/schema/agreement.views.schema.yml
config/schema/agreement.views.schema.yml
AgreementType::fields in src/Plugin/migrate/source/d7/AgreementType.php
Returns available fields on the source.
agreement_views_data in ./agreement.views.inc
Implements hook_views_data().

... See full list

File

src/Entity/Agreement.php, line 46

Namespace

Drupal\agreement\Entity
View source 
class Agreement extends ConfigEntityBase {

  /**
   * The machine name.
   *
   * @var string
   */
  protected $id;

  /**
   * The label.
   *
   * @var string
   */
  protected $label;

  /**
   * Agreement frequency setting.
   *
   * @return bool
   *   TRUE if the agreement is configured for users to agree only once.
   */
  public function agreeOnce() {
    $settings = $this
      ->getSettings();
    return $settings['frequency'] == -1 ? TRUE : FALSE;
  }

  /**
   * Agreement frequency timestamp.
   *
   * @return int
   *   The timestamp modifier to use for the frequency.
   */
  public function getAgreementFrequencyTimestamp() {
    $timestamp = 0;
    $settings = $this
      ->getSettings();
    if ($settings['frequency'] > 0) {
      $timestamp = round(time() - $settings['frequency'] * 24 * 60 * 60);
    }
    return max($settings['reset_date'], $timestamp);
  }

  /**
   * Returns the settings as an array.
   *
   * @return array
   *   The stored settings or some sane defaults.
   */
  public function getSettings() {
    $defaults = $this
      ->getDefaultSettings();
    $settings = $this
      ->get('settings');
    if ($settings === NULL) {
      $settings = [];
    }
    return NestedArray::mergeDeep($defaults, $settings);
  }

  /**
   * Find if the agreement applies to an user account by role.
   *
   * @param \Drupal\Core\Session\AccountProxyInterface $account
   *   The user account to check roles for.
   *
   * @return bool
   *   TRUE if the user account has a role configured for this agreement.
   */
  public function accountHasAgreementRole(AccountProxyInterface $account) {
    $account_roles = $account
      ->getRoles();
    $settings = $this
      ->getSettings();
    $roles = $settings['roles'];
    $has_roles = array_intersect($roles, $account_roles);
    return !empty($has_roles);
  }

  /**
   * Get a formatted visibility pages as a string.
   *
   * @return string
   *   Get the visibility pages setting as a string.
   */
  public function getVisibilityPages() {
    $settings = $this
      ->getSettings();
    return html_entity_decode(strtolower(implode("\n", $settings['visibility']['pages'])));
  }

  /**
   * Get the visibility setting.
   *
   * @return int
   *   The visibility setting: 0 for match all except, and 1 for match any.
   */
  public function getVisibilitySetting() {
    $settings = $this
      ->getSettings();
    return $settings['visibility']['settings'];
  }

  /**
   * Provides default keys for settings.
   *
   * @return array
   *   Default keys and values for settings array.
   *
   * @internal
   */
  public static function getDefaultSettings() {
    return [
      'frequency' => -1,
      'title' => '',
      'format' => '',
      'submit' => '',
      'checkbox' => '',
      'success' => '',
      'revoked' => '',
      'failure' => '',
      'destination' => '',
      'recipient' => '',
      'roles' => [],
      'reset_date' => 0,
      'visibility' => [
        'settings' => -1,
        'pages' => [],
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Agreement::$id protected property The machine name.
Agreement::$label protected property The label.
Agreement::accountHasAgreementRole public function Find if the agreement applies to an user account by role.
Agreement::agreeOnce public function Agreement frequency setting.
Agreement::getAgreementFrequencyTimestamp public function Agreement frequency timestamp.
Agreement::getDefaultSettings public static function Provides default keys for settings.
Agreement::getSettings public function Returns the settings as an array.
Agreement::getVisibilityPages public function Get a formatted visibility pages as a string.
Agreement::getVisibilitySetting public function Get the visibility setting.
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
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 14
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::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
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::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
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::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
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::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
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::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 18
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
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.
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