You are here

Home » API reference » Workflow 8 » WorkflowScheduledTransition.php

class WorkflowScheduledTransition in Workflow 8

Implements a scheduled transition, as shown on Workflow form.

Plugin annotation


@ContentEntityType(
  id = "workflow_scheduled_transition",
  label = @Translation("Workflow scheduled transition"),
  label_singular = @Translation("Workflow scheduled transition"),
  label_plural = @Translation("Workflow scheduled transitions"),
  label_count = @PluralTranslation(
    singular = "@count Workflow scheduled transition",
    plural = "@count Workflow scheduled transitions",
  ),
  bundle_label = @Translation("Workflow type"),
  bundle_entity_type = "workflow_type",
  module = "workflow",
  handlers = {
    "access" = "Drupal\workflow\WorkflowAccessControlHandler",
    "list_builder" = "Drupal\workflow\WorkflowTransitionListBuilder",
    "form" = {
       "add" = "Drupal\workflow\Form\WorkflowTransitionForm",
       "edit" = "Drupal\workflow\Form\WorkflowTransitionForm",
       "delete" = "Drupal\Core\Entity\EntityDeleteForm",
     },
    "views_data" = "Drupal\workflow\WorkflowScheduledTransitionViewsData",
  },
  base_table = "workflow_transition_schedule",
  translatable = FALSE,
  entity_keys = {
    "id" = "tid",
    "bundle" = "wid",
    "langcode" = "langcode",
  },
  links = {
    "canonical" = "/workflow_transition/{workflow_transition}",
    "delete-form" = "/workflow_transition/{workflow_transition}/delete",
    "edit-form" = "/workflow_transition/{workflow_transition}/edit",
  },
)

Hierarchy

Expanded class hierarchy of WorkflowScheduledTransition

2 files declare their use of WorkflowScheduledTransition
workflow.module in ./workflow.module
Support workflows made up of arbitrary states.
WorkflowTransitionElement.php in src/Element/WorkflowTransitionElement.php

File

src/Entity/WorkflowScheduledTransition.php, line 48

Namespace

Drupal\workflow\Entity
View source 
class WorkflowScheduledTransition extends WorkflowTransition {

  /**
   * @inheritdoc.
   */
  public function __construct(array $values = [], $entityType = 'workflow_scheduled_transition', $bundle = FALSE, $translations = []) {

    // Please be aware that $entity_type and $entityType are different things!
    parent::__construct($values, $entityType, $bundle, $translations);

    // This transition is scheduled.
    $this->isScheduled = TRUE;

    // This transition is not executed.
    $this->isExecuted = FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function setValues($to_sid, $uid = NULL, $scheduled = NULL, $comment = '', $force_create = FALSE) {
    parent::setValues($to_sid, $uid, $scheduled, $comment, $force_create);
  }

  /**
   * {@inheritdoc}
   *
   * This is a hack to avoid the following error, because ScheduledTransition is not a bundle of Workflow:
   *   Drupal\Component\Plugin\Exception\PluginNotFoundException: The "entity:workflow_scheduled_transition:first" plugin does not exist. in Drupal\Core\Plugin\DefaultPluginManager->doGetDefinition() (line 60 of core\lib\Drupal\Component\Plugin\Discovery\DiscoveryTrait.php).
   */
  public function validate() {

    // Since this function generates an error in one use case (using WorkflowTransitionForm)
    // and is not called in the other use case (using the Workflow Widget),
    // this function is disabled for now.
    // @todo This function is only called in the WorkflowTransitionForm, not in the Widget.
    // @todo Repair https://www.drupal.org/node/2896650 .
    //
    // The following is from return parent::validate();
    $this->validated = TRUE;

    // $violations = $this->getTypedData()->validate();
    // return new EntityConstraintViolationList($this, iterator_to_array($violations));
    $violations = [];
    return new EntityConstraintViolationList($this, $violations);
  }

  /**
   * CRUD functions.
   */

  /**
   * {@inheritdoc}
   *
   * Saves a scheduled transition. If the transition is executed, save in history.
   */
  public function save() {

    // If executed, save in history.
    if ($this->isExecuted) {

      // Be careful, we are not a WorkflowScheduleTransition anymore!
      // No fuzzing around, just copy the ScheduledTransition to a normal one.
      $current_sid = $this
        ->getFromSid();
      $field_name = $this
        ->getFieldName();
      $executed_transition = WorkflowTransition::create([
        $current_sid,
        'field_name' => $field_name,
      ]);
      $executed_transition
        ->setTargetEntity($this
        ->getTargetEntity());
      $executed_transition
        ->setValues($this
        ->getToSid(), $this
        ->getOwnerId(), \Drupal::time()
        ->getRequestTime(), $this
        ->getComment());
      return $executed_transition
        ->save();

      // <-- exit !!
    }
    $hid = $this
      ->id();
    if (!$hid) {

      // Insert the transition. Make sure it hasn't already been inserted.
      // @todo Allow a scheduled transition per revision.
      $entity = $this
        ->getTargetEntity();
      $found_transition = self::loadByProperties($entity
        ->getEntityTypeId(), $entity
        ->id(), [], $this
        ->getFieldName(), $this
        ->getLangcode());
      if ($found_transition) {

        // Avoid duplicate entries.
        $found_transition
          ->delete();
        $result = parent::save();
      }
      else {
        $result = parent::save();
      }
    }
    else {
      workflow_debug(__FILE__, __FUNCTION__, __LINE__);

      // @todo D8-port: still test this snippet.
      // Update the transition.
      $result = parent::save();
    }

    // Create user message.
    if ($state = $this
      ->getToState()) {
      $entity = $this
        ->getTargetEntity();
      $message = '%entity_title scheduled for state change to %state_name on %scheduled_date';
      $args = [
        '%entity_title' => $entity
          ->label(),
        '%state_name' => $state
          ->label(),
        '%scheduled_date' => $this
          ->getTimestampFormatted(),
        'link' => $this
          ->getTargetEntityId() && $this
          ->getTargetEntity()
          ->hasLinkTemplate('canonical') ? $this
          ->getTargetEntity()
          ->toLink($this
          ->t('View'))
          ->toString() : '',
      ];
      \Drupal::logger('workflow')
        ->notice($message, $args);
      $this
        ->messenger()
        ->addStatus($this
        ->t($message, $args));
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public static function loadByProperties($entity_type, $entity_id, array $revision_ids = [], $field_name = '', $langcode = '', $sort = 'ASC', $transition_type = 'workflow_scheduled_transition') {

    // N.B. $transition_type is set as parameter default.
    return parent::loadByProperties($entity_type, $entity_id, $revision_ids, $field_name, $langcode, $sort, $transition_type);
  }

  /**
   * {@inheritdoc}
   */
  public static function loadMultipleByProperties($entity_type, array $entity_ids, array $revision_ids = [], $field_name = '', $langcode = '', $limit = NULL, $sort = 'ASC', $transition_type = 'workflow_scheduled_transition') {

    // N.B. $transition_type is set as parameter default.
    return parent::loadMultipleByProperties($entity_type, $entity_ids, $revision_ids, $field_name, $langcode, $limit, $sort, $transition_type);
  }

  /**
   * Given a time frame, get all scheduled transitions.
   *
   * @param int $start
   * @param int $end
   * @param string $from_sid
   * @param string $to_sid
   *
   * @return WorkflowScheduledTransition[]
   *   An array of transitions.
   */
  public static function loadBetween($start = 0, $end = 0, $from_sid = '', $to_sid = '') {
    $transition_type = 'workflow_scheduled_transition';

    // @todo Get this from annotation.

    /** @var \Drupal\Core\Entity\Query\QueryInterface $query */
    $query = \Drupal::entityQuery($transition_type)
      ->sort('timestamp', 'ASC')
      ->addTag($transition_type);
    if ($start) {
      $query
        ->condition('timestamp', $start, '>');
    }
    if ($end) {
      $query
        ->condition('timestamp', $end, '<');
    }
    if ($from_sid) {
      $query
        ->condition('from_sid', $from_sid, '=');
    }
    if ($to_sid) {
      $query
        ->condition('to_sid', $from_sid, '=');
    }
    $ids = $query
      ->execute();
    $transitions = self::loadMultiple($ids);
    return $transitions;
  }

  /**
   * Property functions.
   */

  /**
   * Create a default comment (on scheduled transition w/o comment).
   */
  public function addDefaultComment() {
    $this
      ->setComment($this
      ->t('Scheduled by user @uid.', [
      '@uid' => $this
        ->getOwnerId(),
    ]));
  }

  /**
   * Define the fields. Modify the parent fields.
   *
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = [];

    // Add the specific ID-field : tid vs. hid.
    $fields['tid'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Transition ID'))
      ->setDescription(t('The transition ID.'))
      ->setReadOnly(TRUE)
      ->setSetting('unsigned', TRUE);

    // Get the rest of the fields.
    $fields += parent::baseFieldDefinitions($entity_type);

    // The timestamp has a different description.
    $fields['timestamp'] = [];

    // Reset old value.
    $fields['timestamp'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Scheduled'))
      ->setDescription(t('The date+time this transition is scheduled for.'))
      ->setRevisionable(TRUE);

    // Remove the specific ID-field : tid vs. hid.
    unset($fields['hid']);
    return $fields;
  }

}

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::label public function Gets the label of the entity. Overrides EntityBase::label 2
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::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave 5
ContentEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 5
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::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::__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::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::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::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
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
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.
WorkflowScheduledTransition::addDefaultComment public function Create a default comment (on scheduled transition w/o comment).
WorkflowScheduledTransition::baseFieldDefinitions public static function Define the fields. Modify the parent fields. Overrides WorkflowTransition::baseFieldDefinitions
WorkflowScheduledTransition::loadBetween public static function Given a time frame, get all scheduled transitions.
WorkflowScheduledTransition::loadByProperties public static function Load (Scheduled) WorkflowTransitions, most recent first. Overrides WorkflowTransition::loadByProperties
WorkflowScheduledTransition::loadMultipleByProperties public static function Given an entity, get all transitions for it. Overrides WorkflowTransition::loadMultipleByProperties
WorkflowScheduledTransition::save public function Saves a scheduled transition. If the transition is executed, save in history. Overrides WorkflowTransition::save
WorkflowScheduledTransition::setValues public function Helper function for __construct. Used for all children of WorkflowTransition (aka WorkflowScheduledTransition) Overrides WorkflowTransition::setValues
WorkflowScheduledTransition::validate public function This is a hack to avoid the following error, because ScheduledTransition is not a bundle of Workflow: Drupal\Component\Plugin\Exception\PluginNotFoundException: The "entity:workflow_scheduled_transition:first" plugin does not exist. in… Overrides ContentEntityBase::validate
WorkflowScheduledTransition::__construct public function @inheritdoc. Overrides WorkflowTransition::__construct
WorkflowTransition::$entity protected property @usage Use WorkflowTransition->getTargetEntity() to fetch this.
WorkflowTransition::$isExecuted protected property Extra data: describe the state of the transition.
WorkflowTransition::$isForced protected property Extra data: describe the state of the transition.
WorkflowTransition::$isScheduled protected property Extra data: describe the state of the transition.
WorkflowTransition::$user protected property @usage Use WorkflowTransition->getOwner() to fetch this.
WorkflowTransition::create public static function Overrides EntityBase::create
WorkflowTransition::dpm public function Helper/debugging function. Shows simple contents of Transition. Overrides WorkflowTransitionInterface::dpm
WorkflowTransition::execute public function Execute a transition (change state of an entity). Overrides WorkflowTransitionInterface::execute
WorkflowTransition::executeAndUpdateEntity public function Executes a transition (change state of an entity), from OUTSIDE the entity. Overrides WorkflowTransitionInterface::executeAndUpdateEntity
WorkflowTransition::force public function Set if a transition must be executed, even if transition is invalid or user not authorized. Overrides WorkflowTransitionInterface::force
WorkflowTransition::getComment public function Get the comment of the Transition. Overrides WorkflowTransitionInterface::getComment
WorkflowTransition::getFieldName public function Get the field_name for which the Transition is valid. Overrides WorkflowTransitionInterface::getFieldName
WorkflowTransition::getFromSid public function Overrides WorkflowConfigTransitionInterface::getFromSid
WorkflowTransition::getFromState public function Overrides WorkflowConfigTransitionInterface::getFromState
WorkflowTransition::getLangcode public function Get the language code for which the Transition is valid. Overrides WorkflowTransitionInterface::getLangcode
WorkflowTransition::getOwner public function Returns the entity owner's user entity. Overrides EntityOwnerInterface::getOwner
WorkflowTransition::getOwnerId public function Returns the entity owner's user ID. Overrides EntityOwnerInterface::getOwnerId
WorkflowTransition::getTargetEntity public function Returns the entity to which the workflow is attached. Overrides WorkflowTransitionInterface::getTargetEntity
WorkflowTransition::getTargetEntityId public function Returns the ID of the entity to which the workflow is attached. Overrides WorkflowTransitionInterface::getTargetEntityId
WorkflowTransition::getTargetEntityTypeId public function Returns the type of the entity to which the workflow is attached. Overrides WorkflowTransitionInterface::getTargetEntityTypeId
WorkflowTransition::getTimestamp public function Returns the time on which the transitions was or will be executed. Overrides WorkflowTransitionInterface::getTimestamp
WorkflowTransition::getTimestampFormatted public function Returns the human-readable time. Overrides WorkflowTransitionInterface::getTimestampFormatted
WorkflowTransition::getToSid public function Overrides WorkflowConfigTransitionInterface::getToSid
WorkflowTransition::getToState public function Overrides WorkflowConfigTransitionInterface::getToState
WorkflowTransition::hasStateChange public function Determines if the State changes by this Transition. Overrides WorkflowConfigTransitionInterface::hasStateChange
WorkflowTransition::isAllowed public function Determines if the current transition between 2 states is allowed. Overrides WorkflowConfigTransitionInterface::isAllowed
WorkflowTransition::isEmpty protected function Check if anything has changed in this transition.
WorkflowTransition::isExecuted public function Returns if this is an Executed Transition. Overrides WorkflowTransitionInterface::isExecuted
WorkflowTransition::isForced public function A transition may be forced skipping checks. Overrides WorkflowTransitionInterface::isForced
WorkflowTransition::isRevertable public function Returns if this is a revertable Transition on the History tab. Overrides WorkflowTransitionInterface::isRevertable
WorkflowTransition::isScheduled public function Returns if this is a Scheduled Transition. Overrides WorkflowTransitionInterface::isScheduled
WorkflowTransition::isValid public function Determines if the Transition is valid and can be executed.
WorkflowTransition::logError public function Generate a Watchdog error.
WorkflowTransition::post_execute public function Invokes 'transition post'. Overrides WorkflowTransitionInterface::post_execute
WorkflowTransition::schedule public function Sets the Transition to be scheduled or not. Overrides WorkflowTransitionInterface::schedule
WorkflowTransition::setComment public function Get the comment of the Transition. Overrides WorkflowTransitionInterface::setComment
WorkflowTransition::setExecuted public function Set the 'isExecuted' property. Overrides WorkflowTransitionInterface::setExecuted
WorkflowTransition::setOwner public function Sets the entity owner's user entity. Overrides EntityOwnerInterface::setOwner
WorkflowTransition::setOwnerId public function Sets the entity owner's user ID. Overrides EntityOwnerInterface::setOwnerId
WorkflowTransition::setTargetEntity public function Sets the Entity, that is added to the Transition. Overrides WorkflowTransitionInterface::setTargetEntity
WorkflowTransition::setTimestamp public function Returns the time on which the transitions was or will be executed. Overrides WorkflowTransitionInterface::setTimestamp
WorkflowTransition::_updateEntity private function Internal function to update the Entity.
WorkflowTypeAttributeTrait::$wid protected property The machine_name of the attached Workflow.
WorkflowTypeAttributeTrait::$workflow protected property The attached Workflow.
WorkflowTypeAttributeTrait::getWorkflow public function Returns the Workflow object of this object.
WorkflowTypeAttributeTrait::getWorkflowId public function Returns the Workflow ID of this object.
WorkflowTypeAttributeTrait::setWorkflow public function
WorkflowTypeAttributeTrait::setWorkflowId public function Sets the Workflow ID of this object.