You are here

Home » API reference » Transaction 8 » Transaction.php

class Transaction in Transaction 8

Provides the transaction content entity.

Plugin annotation


@ContentEntityType(
  id = "transaction",
  label = @Translation("Transaction"),
  label_singular = @Translation("transaction"),
  label_plural = @Translation("transactions"),
  label_count = @PluralTranslation(
    singular = "@count transaction",
    plural = "@count transaction",
  ),
  admin_permission = "administer transactions",
  bundle_label = @Translation("Transaction type"),
  handlers = {
    "list_builder" = "Drupal\transaction\TransactionListBuilder",
    "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
    "access" = "Drupal\transaction\TransactionAccessControlHandler",
    "views_data" = "Drupal\transaction\TransactionViewsData",
    "form" = {
      "default" = "Drupal\transaction\Form\TransactionForm",
      "add" = "Drupal\transaction\Form\TransactionForm",
      "edit" = "Drupal\transaction\Form\TransactionForm",
      "delete" = "Drupal\transaction\Form\TransactionDeleteForm",
      "execute" = "Drupal\transaction\Form\TransactionExecuteForm"
    },
    "route_provider" = {
      "default" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
    },
    "transactor" = "Drupal\transaction\TransactorHandler",
  },
  base_table = "transaction",
  translatable = FALSE,
  entity_keys = {
    "id" = "id",
    "bundle" = "type",
    "uuid" = "uuid",
    "uid" = "uid",
  },
  bundle_entity_type = "transaction_type",
  field_ui_base_route = "entity.transaction_type.edit_form",
  permission_granularity = "bundle",
  links = {
    "canonical" = "/transaction/{transaction}",
    "add-form" = "/transaction/add/{transaction_type}/{target_entity_type}/{target_entity}",
    "edit-form" = "/transaction/{transaction}/edit",
    "delete-form" = "/transaction/{transaction}/delete",
    "execute-form" = "/transaction/{transaction}/execute",
    "collection" = "/transaction/{transaction_type}/{target_entity_type}/{target_entity}",
  }
)

Hierarchy

Expanded class hierarchy of Transaction

2 files declare their use of Transaction
BalanceTransactionTest.php in tests/src/Kernel/BalanceTransactionTest.php
KernelTransactionTestBase.php in tests/src/Kernel/KernelTransactionTestBase.php
4 string references to 'Transaction'
transaction.info.yml in ./transaction.info.yml
transaction.info.yml
transaction.routing.yml in ./transaction.routing.yml
transaction.routing.yml
transaction.rules.events.yml in ./transaction.rules.events.yml
transaction.rules.events.yml
TransactionCreateDeriver::getDerivativeDefinitions in src/Plugin/RulesAction/TransactionCreateDeriver.php
Gets the definition of all derivatives of a base plugin.

File

src/Entity/Transaction.php, line 68

Namespace

Drupal\transaction\Entity
View source 
class Transaction extends ContentEntityBase implements TransactionInterface {

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {

    // Generic base fields.
    $fields = parent::baseFieldDefinitions($entity_type);

    // Creation timestamp.
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Authored on'))
      ->setDescription(t('The time that the transaction was created.'))
      ->setRequired(TRUE)
      ->setDisplayOptions('view', [
      'type' => 'timestamp',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('view', TRUE)
      ->setDisplayOptions('form', [
      'type' => 'datetime_timestamp',
      'weight' => 10,
    ])
      ->setDisplayConfigurable('form', TRUE);

    // User ID (transaction author).
    $fields['uid'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Authored by'))
      ->setDescription(t('The user ID of the author.'))
      ->setRequired(TRUE)
      ->setSetting('target_type', 'user')
      ->setSetting('handler', 'default')
      ->setDefaultValueCallback('Drupal\\transaction\\Entity\\Transaction::getCurrentUserId')
      ->setDisplayOptions('view', [
      'type' => 'author',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('view', TRUE)
      ->setDisplayOptions('form', [
      'type' => 'entity_reference_autocomplete',
      'weight' => 5,
      'settings' => [
        'match_operator' => 'CONTAINS',
        'size' => '60',
        'autocomplete_type' => 'tags',
        'placeholder' => '',
      ],
    ])
      ->setDisplayConfigurable('form', TRUE);

    // Target entity.
    $fields['target_entity'] = BaseFieldDefinition::create('dynamic_entity_reference')
      ->setLabel(t('Target entity'))
      ->setDescription(t('The target entity of the transaction.'))
      ->setRequired(TRUE)
      ->setDisplayOptions('view', [
      'type' => 'author',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('view', TRUE);

    // Operation.
    $fields['operation'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Operation'))
      ->setDescription(t('Reference to a transaction operation that describes the transaction.'))
      ->setRequired(FALSE)
      ->setSetting('target_type', 'transaction_operation')
      ->setSetting('handler', 'default:transaction_operation')
      ->setDisplayOptions('view', [
      'type' => 'entity_reference_label',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('view', TRUE)
      ->setDisplayOptions('form', [
      'type' => 'options_select',
      'weight' => 0,
      'settings' => [
        'size' => '60',
      ],
    ])
      ->setDisplayConfigurable('form', TRUE);

    // Execution timestamp.
    $fields['executed'] = BaseFieldDefinition::create('timestamp')
      ->setLabel(t('Executed on'))
      ->setDescription(t('The time that the transaction was executed.'))
      ->setRequired(FALSE)
      ->setDisplayOptions('view', [
      'type' => 'timestamp',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('view', TRUE);

    // The execution sequence number.
    $fields['execution_sequence'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Execution sequence'))
      ->setDescription(t('The order number on which this transaction was executed.'))
      ->setSetting('unsigned', TRUE)
      ->setReadOnly(TRUE)
      ->setDisplayOptions('view', [
      'type' => 'number_integer',
      'region' => 'hidden',
    ])
      ->setDisplayConfigurable('view', TRUE);

    // The execution result code.
    $fields['result_code'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Result code'))
      ->setReadOnly(TRUE)
      ->setRequired(TRUE);

    // The execution result message.
    $fields['result_message'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Result message'))
      ->setComputed(TRUE)
      ->setClass('\\Drupal\\transaction\\Plugin\\Field\\TransactionResultMessageItemList')
      ->setDisplayOptions('view', [
      'type' => 'string',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('view', TRUE);

    // The user that executes the transaction.
    $fields['executor'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Executed by'))
      ->setDescription(t('The user ID of the user that executed the transaction.'))
      ->setRequired(FALSE)
      ->setSetting('target_type', 'user')
      ->setSetting('handler', 'default')
      ->setDisplayOptions('view', [
      'type' => 'entity_reference_label',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('view', TRUE);

    // Properties.
    $fields['properties'] = BaseFieldDefinition::create('map')
      ->setLabel(t('Properties'))
      ->setDescription(t('A name-value map managed by the transactor plugin.'));

    // Description (computed).
    $fields['description'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Description'))
      ->setDescription(t('A human-readable description of the transaction.'))
      ->setComputed(TRUE)
      ->setClass('\\Drupal\\transaction\\Plugin\\Field\\TransactionDescriptionItemList')
      ->setDisplayOptions('view', [
      'type' => 'string',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('view', TRUE);

    // Details (computed).
    $fields['details'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Details'))
      ->setDescription(t('A list of details of the transaction.'))
      ->setComputed(TRUE)
      ->setClass('\\Drupal\\transaction\\Plugin\\Field\\TransactionDetailsItemList')
      ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)
      ->setDisplayOptions('view', [
      'type' => 'string',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('view', TRUE);
    return $fields;
  }

  /**
   * Default value callback for 'uid' base field definition.
   *
   * @see ::baseFieldDefinitions()
   *
   * @return array
   *   An array of default values.
   */
  public static function getCurrentUserId() {
    return [
      \Drupal::currentUser()
        ->id(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    return strip_tags($this
      ->getDescription());
  }

  /**
   * {@inheritdoc}
   */
  public function getOwner() {
    return $this
      ->get('uid')->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function setOwner(UserInterface $account) {
    $this
      ->set('uid', $account
      ->id());
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getOwnerId() {
    return $this
      ->getEntityKey('uid');
  }

  /**
   * {@inheritdoc}
   */
  public function setOwnerId($uid) {
    $this
      ->set('uid', $uid);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getExecutionSequence() {
    return $this
      ->get('execution_sequence')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setExecutionSequence($execution_sequence) {
    if ($execution_sequence !== NULL && $execution_sequence < 1) {
      throw new \InvalidArgumentException('The execution sequence number must be greater than 0.');
    }
    $this
      ->set('execution_sequence', $execution_sequence);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getExecutionTime() {
    return $this
      ->get('executed')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setExecutionTime($timestamp) {
    $this
      ->set('executed', $timestamp);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCreatedTime() {
    return $this
      ->get('created')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setCreatedTime($timestamp) {
    $this
      ->set('created', $timestamp);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getProperty($key) {
    $properties = $this
      ->getProperties();
    return isset($properties[$key]) ? $properties[$key] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function setProperty($key, $value = NULL) {
    $item = $this
      ->get('properties')
      ->first() ?: $this
      ->get('properties')
      ->appendItem();
    $map = $item
      ->getValue();
    if ($value === NULL) {
      unset($map[$key]);
    }
    else {
      $map[$key] = $value;
    }
    $item
      ->setValue($map);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getProperties() {
    $properties = $this
      ->get('properties');
    return $properties
      ->isEmpty() ? [] : $properties
      ->first()
      ->toArray();
  }

  /**
   * {@inheritdoc}
   */
  public function execute($save = TRUE, UserInterface $user = NULL) {
    return $this
      ->transactorHandler()
      ->doExecute($this, $save, $user);
  }

  /**
   * {@inheritdoc}
   */
  public function getResultCode() {
    return $this
      ->get('result_code')->value ?: FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function setResultCode($code) {
    $this
      ->get('result_code')
      ->setValue($code);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getResultMessage($reset = FALSE) {
    if ($reset || $this
      ->get('result_message')
      ->isEmpty()) {
      return $this
        ->transactorHandler()
        ->composeResultMessage($this);
    }
    return $this
      ->get('result_message')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function getExecutorId() {
    return $this
      ->get('executor')
      ->isEmpty() ? FALSE : $this
      ->get('executor')->target_id;
  }

  /**
   * {@inheritdoc}
   */
  public function getExecutor() {
    return $this
      ->get('executor')
      ->isEmpty() ? NULL : $this
      ->get('executor')->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function setExecutor(UserInterface $user) {
    $this
      ->get('executor')
      ->setValue($user
      ->id());
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getType() {
    return $this
      ->get('type')->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getTypeId() {
    return $this
      ->get('type')
      ->getString();
  }

  /**
   * {@inheritdoc}
   */
  public function getOperation() {
    return $this
      ->get('operation')->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getOperationId() {
    return $this
      ->get('operation')->target_id;
  }

  /**
   * {@inheritdoc}
   */
  public function setOperation($operation = NULL) {
    $this
      ->set('operation', is_string($operation) ? $operation : $operation
      ->id());
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getPrevious() {
    if ($this
      ->isPending()) {
      throw new InvalidTransactionStateException();
    }
    return $this
      ->transactorHandler()
      ->getPreviousTransaction($this);
  }

  /**
   * {@inheritdoc}
   */
  public function getNext() {
    if ($this
      ->isPending()) {
      throw new InvalidTransactionStateException();
    }
    return $this
      ->transactorHandler()
      ->getNextTransaction($this);
  }

  /**
   * {@inheritdoc}
   */
  public function getTargetEntity() {
    return $this
      ->get('target_entity')
      ->isEmpty() ? NULL : $this
      ->get('target_entity')->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getTargetEntityId() {
    return $this
      ->get('target_entity')
      ->isEmpty() ? FALSE : $this
      ->get('target_entity')->target_id;
  }

  /**
   * {@inheritdoc}
   */
  public function setTargetEntity(ContentEntityInterface $entity) {
    $this
      ->get('target_entity')
      ->setValue($entity);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription($reset = FALSE) {
    if ($reset || $this
      ->get('description')
      ->isEmpty()) {
      return $this
        ->transactorHandler()
        ->composeDescription($this);
    }
    return $this
      ->get('description')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function getDetails($reset = FALSE) {
    if ($reset) {
      return $this
        ->transactorHandler()
        ->composeDetails($this);
    }
    $details = [];
    foreach ($this
      ->get('details')
      ->getValue() as $detail_value) {
      $details[] = $detail_value['value'];
    }
    return $details;
  }

  /**
   * {@inheritdoc}
   */
  public function isPending() {
    return $this
      ->getExecutionTime() === NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    parent::preSave($storage);

    // Execute the transaction if inmediate execution is enabled.
    if ($this
      ->isNew() && $this
      ->getType()
      ->getOption('execution') == TransactionTypeInterface::EXECUTION_IMMEDIATE) {
      $this
        ->execute(FALSE);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);

    // Save the target entity if it was updated during the transaction
    // execution.
    $from_pending = isset($this->original) && !$this->original
      ->getProperty(TransactionInterface::PROPERTY_TARGET_ENTITY_UPDATED);
    if (($from_pending || !$update) && $this
      ->getProperty(TransactionInterface::PROPERTY_TARGET_ENTITY_UPDATED)) {
      $this
        ->getTargetEntity()
        ->save();
    }
  }

  /**
   * Gets the transactor handler.
   *
   * @return \Drupal\transaction\TransactorHandlerInterface
   *   The transactor entity handler.
   */
  protected function transactorHandler() {
    return $this
      ->entityTypeManager()
      ->getHandler($this
      ->getEntityTypeId(), 'transactor');
  }

  /**
   * {@inheritdoc}
   */
  protected function urlRouteParameters($rel) {
    $uri_route_parameters = parent::urlRouteParameters($rel);
    if ($rel === 'collection' || $rel == 'add-form') {
      $uri_route_parameters['transaction_type'] = $this
        ->getTypeId();
      $uri_route_parameters['target_entity_type'] = $this
        ->getType()
        ->getTargetEntityTypeId();

      // Transactions with empty target entity field is inconsistent. Returning
      // 0 to avoid exceptions. URL will end in a page not found.
      $uri_route_parameters['target_entity'] = $this
        ->getTargetEntityId() ?: 0;
    }
    return $uri_route_parameters;
  }

}

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.
ContentEntityBase::$activeLangcode protected property Language code identifying the entity active language.
ContentEntityBase::$defaultLangcode protected property Local cache for the default language code.
ContentEntityBase::$defaultLangcodeKey protected property The default langcode entity key.
ContentEntityBase::$enforceRevisionTranslationAffected protected property Whether the revision translation affected flag has been enforced.
ContentEntityBase::$entityKeys protected property Holds untranslatable entity keys such as the ID, bundle, and revision ID.
ContentEntityBase::$fieldDefinitions protected property Local cache for field definitions.
ContentEntityBase::$fields protected property The array of fields, each being an instance of FieldItemListInterface.
ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck protected static property Local cache for fields to skip from the checking for translation changes.
ContentEntityBase::$isDefaultRevision protected property Indicates whether this is the default revision.
ContentEntityBase::$langcodeKey protected property The language entity key.
ContentEntityBase::$languages protected property Local cache for the available language objects.
ContentEntityBase::$loadedRevisionId protected property The loaded revision ID before the new revision was set.
ContentEntityBase::$newRevision protected property Boolean indicating whether a new revision should be created on save.
ContentEntityBase::$revisionTranslationAffectedKey protected property The revision translation affected entity key.
ContentEntityBase::$translatableEntityKeys protected property Holds translatable entity keys such as the label.
ContentEntityBase::$translationInitialize protected property A flag indicating whether a translation object is being initialized.
ContentEntityBase::$translations protected property An array of entity translation metadata.
ContentEntityBase::$validated protected property Whether entity validation was performed.
ContentEntityBase::$validationRequired protected property Whether entity validation is required before saving the entity.
ContentEntityBase::$values protected property The plain data values of the contained fields.
ContentEntityBase::access public function Checks data value access. Overrides EntityBase::access 1
ContentEntityBase::addTranslation public function Adds a new translation to the translatable object. Overrides TranslatableInterface::addTranslation
ContentEntityBase::bundle public function Gets the bundle of the entity. Overrides EntityBase::bundle
ContentEntityBase::bundleFieldDefinitions public static function Provides field definitions for a specific bundle. Overrides FieldableEntityInterface::bundleFieldDefinitions 4
ContentEntityBase::clearTranslationCache protected function Clear entity translation object cache to remove stale references.
ContentEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ContentEntityBase::get public function Gets a field item list. Overrides FieldableEntityInterface::get
ContentEntityBase::getEntityKey protected function Gets the value of the given entity key, if defined. 1
ContentEntityBase::getFieldDefinition public function Gets the definition of a contained field. Overrides FieldableEntityInterface::getFieldDefinition
ContentEntityBase::getFieldDefinitions public function Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface::getFieldDefinitions
ContentEntityBase::getFields public function Gets an array of all field item lists. Overrides FieldableEntityInterface::getFields
ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip in ::hasTranslationChanges. 1
ContentEntityBase::getIterator public function
ContentEntityBase::getLanguages protected function
ContentEntityBase::getLoadedRevisionId public function Gets the loaded Revision ID of the entity. Overrides RevisionableInterface::getLoadedRevisionId
ContentEntityBase::getRevisionId public function Gets the revision identifier of the entity. Overrides RevisionableInterface::getRevisionId
ContentEntityBase::getTranslatableFields public function Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface::getTranslatableFields
ContentEntityBase::getTranslatedField protected function Gets a translated field.
ContentEntityBase::getTranslation public function Gets a translation of the data. Overrides TranslatableInterface::getTranslation
ContentEntityBase::getTranslationLanguages public function Returns the languages the data is translated to. Overrides TranslatableInterface::getTranslationLanguages
ContentEntityBase::getTranslationStatus public function Returns the translation status. Overrides TranslationStatusInterface::getTranslationStatus
ContentEntityBase::getUntranslated public function Returns the translatable object referring to the original language. Overrides TranslatableInterface::getUntranslated
ContentEntityBase::hasField public function Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface::hasField
ContentEntityBase::hasTranslation public function Checks there is a translation for the given language code. Overrides TranslatableInterface::hasTranslation
ContentEntityBase::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes. Overrides TranslatableInterface::hasTranslationChanges
ContentEntityBase::id public function Gets the identifier. Overrides EntityBase::id
ContentEntityBase::initializeTranslation protected function Instantiates a translation object for an existing translation.
ContentEntityBase::isDefaultRevision public function Checks if this entity is the default revision. Overrides RevisionableInterface::isDefaultRevision
ContentEntityBase::isDefaultTranslation public function Checks whether the translation is the default one. Overrides TranslatableInterface::isDefaultTranslation
ContentEntityBase::isDefaultTranslationAffectedOnly public function Checks if untranslatable fields should affect only the default translation. Overrides TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly
ContentEntityBase::isLatestRevision public function Checks if this entity is the latest revision. Overrides RevisionableInterface::isLatestRevision
ContentEntityBase::isLatestTranslationAffectedRevision public function Checks whether this is the latest revision affecting this translation. Overrides TranslatableRevisionableInterface::isLatestTranslationAffectedRevision
ContentEntityBase::isNewRevision public function Determines whether a new revision should be created on save. Overrides RevisionableInterface::isNewRevision
ContentEntityBase::isNewTranslation public function Checks whether the translation is new. Overrides TranslatableInterface::isNewTranslation
ContentEntityBase::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision. Overrides TranslatableRevisionableInterface::isRevisionTranslationAffected
ContentEntityBase::isRevisionTranslationAffectedEnforced public function Checks if the revision translation affected flag value has been enforced. Overrides TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced
ContentEntityBase::isTranslatable public function Returns the translation support status. Overrides TranslatableInterface::isTranslatable
ContentEntityBase::isValidationRequired public function Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::isValidationRequired
ContentEntityBase::language public function Gets the language of the entity. Overrides EntityBase::language
ContentEntityBase::onChange public function Reacts to changes to a field. Overrides FieldableEntityInterface::onChange
ContentEntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityBase::postCreate
ContentEntityBase::preSaveRevision public function Acts on a revision before it gets saved. Overrides RevisionableInterface::preSaveRevision 2
ContentEntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityBase::referencedEntities 1
ContentEntityBase::removeTranslation public function Removes the translation identified by the given language code. Overrides TranslatableInterface::removeTranslation
ContentEntityBase::set public function Sets a field value. Overrides FieldableEntityInterface::set
ContentEntityBase::setDefaultLangcode protected function Populates the local cache for the default language code.
ContentEntityBase::setNewRevision public function Enforces an entity to be saved as a new revision. Overrides RevisionableInterface::setNewRevision
ContentEntityBase::setRevisionTranslationAffected public function Marks the current revision translation as affected. Overrides TranslatableRevisionableInterface::setRevisionTranslationAffected
ContentEntityBase::setRevisionTranslationAffectedEnforced public function Enforces the revision translation affected flag value. Overrides TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced
ContentEntityBase::setValidationRequired public function Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::setValidationRequired
ContentEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray
ContentEntityBase::updateFieldLangcodes protected function Updates language for already instantiated fields.
ContentEntityBase::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID. Overrides RevisionableInterface::updateLoadedRevisionId
ContentEntityBase::updateOriginalValues public function Updates the original values with the interim changes.
ContentEntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase::uuid
ContentEntityBase::validate public function Validates the currently set values. Overrides FieldableEntityInterface::validate
ContentEntityBase::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved. Overrides RevisionableInterface::wasDefaultRevision
ContentEntityBase::__clone public function Magic method: Implements a deep clone.
ContentEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct
ContentEntityBase::__get public function Implements the magic method for getting object properties.
ContentEntityBase::__isset public function Implements the magic method for isset().
ContentEntityBase::__set public function Implements the magic method for setting object properties.
ContentEntityBase::__sleep public function Overrides EntityBase::__sleep
ContentEntityBase::__unset public function Implements the magic method for unset().
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
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::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::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::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate 2
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName 1
EntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget 1
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::getOriginalId public function Gets the original ID. Overrides EntityInterface::getOriginalId 1
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::invalidateTagsOnDelete protected static function Invalidates an entity's cache tags upon delete. 1
EntityBase::invalidateTagsOnSave protected function Invalidates an entity's cache tags upon save. 1
EntityBase::isNew public function Determines whether the entity is new. Overrides EntityInterface::isNew 2
EntityBase::languageManager protected function Gets the language manager.
EntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link 1
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::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete 4
EntityBase::save public function Saves an entity permanently. Overrides EntityInterface::save 3
EntityBase::setOriginalId public function Sets the original ID. Overrides EntityInterface::setOriginalId 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl 2
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::url public function Gets the public URL for this entity. Overrides EntityInterface::url 2
EntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityInterface::urlInfo 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck
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
Transaction::baseFieldDefinitions public static function Provides base field definitions for an entity type. Overrides ContentEntityBase::baseFieldDefinitions
Transaction::execute public function Executes the transaction. Overrides TransactionInterface::execute
Transaction::getCreatedTime public function Gets the transaction creation timestamp. Overrides TransactionInterface::getCreatedTime
Transaction::getCurrentUserId public static function Default value callback for 'uid' base field definition.
Transaction::getDescription public function Returns the transaction description. Overrides TransactionInterface::getDescription
Transaction::getDetails public function Returns the transaction details. Overrides TransactionInterface::getDetails
Transaction::getExecutionSequence public function Gets the transaction execution sequence. Overrides TransactionInterface::getExecutionSequence
Transaction::getExecutionTime public function Gets the transaction execution timestamp. Overrides TransactionInterface::getExecutionTime
Transaction::getExecutor public function Gets the user that executed the transaction. Overrides TransactionInterface::getExecutor
Transaction::getExecutorId public function Gets the ID of the user that executed the transaction. Overrides TransactionInterface::getExecutorId
Transaction::getNext public function Get the next same-type transaction in order of execution. Overrides TransactionInterface::getNext
Transaction::getOperation public function Gets the transaction operation. Overrides TransactionInterface::getOperation
Transaction::getOperationId public function Gets the transaction operation ID. Overrides TransactionInterface::getOperationId
Transaction::getOwner public function Returns the entity owner's user entity. Overrides EntityOwnerInterface::getOwner
Transaction::getOwnerId public function Returns the entity owner's user ID. Overrides EntityOwnerInterface::getOwnerId
Transaction::getPrevious public function Get the previous same-type transaction in order of execution. Overrides TransactionInterface::getPrevious
Transaction::getProperties public function Get a keyed array with all the transaction properties. Overrides TransactionInterface::getProperties
Transaction::getProperty public function Returns a property value. Overrides TransactionInterface::getProperty
Transaction::getResultCode public function Gets the execution result code. Overrides TransactionInterface::getResultCode
Transaction::getResultMessage public function Gets the execution result message. Overrides TransactionInterface::getResultMessage
Transaction::getTargetEntity public function Get the transaction target entity. Overrides TransactionInterface::getTargetEntity
Transaction::getTargetEntityId public function Get the transaction target entity ID. Overrides TransactionInterface::getTargetEntityId
Transaction::getType public function Returns the transaction type. Overrides TransactionInterface::getType
Transaction::getTypeId public function Returns the transaction type ID. Overrides TransactionInterface::getTypeId
Transaction::isPending public function Indicates if the transaction is pending execution. Overrides TransactionInterface::isPending
Transaction::label public function Gets the label of the entity. Overrides ContentEntityBase::label
Transaction::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides ContentEntityBase::postSave
Transaction::preSave public function Acts on an entity before the presave hook is invoked. Overrides ContentEntityBase::preSave
Transaction::setCreatedTime public function Sets the transaction creation timestamp. Overrides TransactionInterface::setCreatedTime
Transaction::setExecutionSequence public function Sets the execution sequence number. Overrides TransactionInterface::setExecutionSequence
Transaction::setExecutionTime public function Sets the transaction execution timestamp. Overrides TransactionInterface::setExecutionTime
Transaction::setExecutor public function Sets the user that executed the transaction. Overrides TransactionInterface::setExecutor
Transaction::setOperation public function Sets the transaction operation. Overrides TransactionInterface::setOperation
Transaction::setOwner public function Sets the entity owner's user entity. Overrides EntityOwnerInterface::setOwner
Transaction::setOwnerId public function Sets the entity owner's user ID. Overrides EntityOwnerInterface::setOwnerId
Transaction::setProperty public function Sets a property value. Overrides TransactionInterface::setProperty
Transaction::setResultCode public function Sets the execution result code. Overrides TransactionInterface::setResultCode
Transaction::setTargetEntity public function Sets the transaction's target entity. Overrides TransactionInterface::setTargetEntity
Transaction::transactorHandler protected function Gets the transactor handler.
Transaction::urlRouteParameters protected function Gets an array of placeholders for this entity. Overrides EntityBase::urlRouteParameters
TransactionInterface::EXECUTED constant Transaction executed state.
TransactionInterface::PENDING constant Transaction pending state.
TransactionInterface::PROPERTY_TARGET_ENTITY_UPDATED constant Name of property indicating that the target entity was updated.
TransactionInterface::RESULT_ERROR Deprecated constant Generic result code for failed execution.
TransactionInterface::RESULT_OK Deprecated constant Generic result code for successful execution.
TranslationStatusInterface::TRANSLATION_CREATED constant Status code identifying a newly created translation.
TranslationStatusInterface::TRANSLATION_EXISTING constant Status code identifying an existing translation.
TranslationStatusInterface::TRANSLATION_REMOVED constant Status code identifying a removed translation.