You are here

Home » API reference » Scheduled Transitions 2.x » ScheduledTransitionInterface.php

interface ScheduledTransitionInterface in Scheduled Transitions 2.x

Same name and namespace in other branches
  1. 8 src/Entity/ScheduledTransitionInterface.php \Drupal\scheduled_transitions\Entity\ScheduledTransitionInterface

Interface for Scheduled Transitions.

Hierarchy

Expanded class hierarchy of ScheduledTransitionInterface

All classes that implement ScheduledTransitionInterface

12 files declare their use of ScheduledTransitionInterface
ScheduledTransitionForm.php in src/Form/ScheduledTransitionForm.php
ScheduledTransitionsAccessControlHandler.php in src/ScheduledTransitionsAccessControlHandler.php
ScheduledTransitionsNewRevisionEvent.php in src/Event/ScheduledTransitionsNewRevisionEvent.php
ScheduledTransitionsRunner.php in src/ScheduledTransitionsRunner.php
ScheduledTransitionsRunnerInterface.php in src/ScheduledTransitionsRunnerInterface.php

... See full list

File

src/Entity/ScheduledTransitionInterface.php, line 17

Namespace

Drupal\scheduled_transitions\Entity
View source 
interface ScheduledTransitionInterface extends ContentEntityInterface {

  /**
   * Entity operation for rescheduling transitions for a scheduled transition.
   */
  public const ENTITY_OPERATION_RESCHEDULE = 'reschedule';

  /**
   * Option to schedule latest revision.
   */
  public const OPTION_LATEST_REVISION = 'latest_revision';

  /**
   * Creates a new Scheduled Transition from known common metadata.
   *
   * Language code and revision ID are set with $revision context.
   *
   * @param \Drupal\workflows\WorkflowInterface $workflow
   *   The workflow.
   * @param string $state
   *   The state ID.
   * @param \Drupal\Core\Entity\RevisionableInterface $revision
   *   Set the revision this scheduled transition is for.
   * @param \DateTimeInterface $dateTime
   *   The transition date.
   * @param \Drupal\Core\Session\AccountInterface $author
   *   The scheduled transition author.
   *
   * @return static
   *   A new unsaved Scheduled Transition.
   */
  public static function createFrom(WorkflowInterface $workflow, string $state, RevisionableInterface $revision, \DateTimeInterface $dateTime, AccountInterface $author);

  /**
   * Get the entity this scheduled transition is for.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   The entity.
   */
  public function getEntity() : ?EntityInterface;

  /**
   * Set the revision this scheduled transition is for.
   *
   * @param \Drupal\Core\Entity\RevisionableInterface $revision
   *   The revision to be transitioned.
   *
   * @return static
   *   Returns entity for chaining.
   */
  public function setEntity(RevisionableInterface $revision);

  /**
   * Get the revision this scheduled transition is for.
   *
   * @return string|int|null
   *   The revision ID.
   */
  public function getEntityRevisionId();

  /**
   * Set the revision this scheduled transition is for.
   *
   * @param string|int $revisionId
   *   The revision to be transitioned.
   *
   * @return static
   *   Returns entity for chaining.
   */
  public function setEntityRevisionId($revisionId);

  /**
   * Get the language of the revision this scheduled transition is for.
   *
   * @return string|null
   *   The revision language code.
   */
  public function getEntityRevisionLanguage() : ?string;

  /**
   * Set the language of the revision this scheduled transition is for.
   *
   * @param string $langCode
   *   The revision language code.
   *
   * @return static
   *   Returns entity for chaining.
   */
  public function setEntityRevisionLanguage(string $langCode);

  /**
   * Get the author for this scheduled transition.
   *
   * @return \Drupal\user\UserInterface|null
   *   The author.
   */
  public function getAuthor() : ?UserInterface;

  /**
   * Set the author of the scheduled transition.
   *
   * @param \Drupal\Core\Session\AccountInterface $author
   *   The scheduled transition author.
   *
   * @return static
   *   Returns entity for chaining.
   */
  public function setAuthor(AccountInterface $author);

  /**
   * Get the workflow for this scheduled transition.
   *
   * @return \Drupal\workflows\WorkflowInterface|null
   *   The workflow.
   */
  public function getWorkflow() : ?WorkflowInterface;

  /**
   * Set the new workflow and state for this scheduled transition.
   *
   * @param \Drupal\workflows\WorkflowInterface $workflow
   *   The workflow.
   * @param string $state
   *   The state ID.
   *
   * @return static
   *   Returns entity for chaining.
   */
  public function setState(WorkflowInterface $workflow, string $state);

  /**
   * Get the new state for this scheduled transition.
   *
   * @return string|null
   *   The state ID.
   */
  public function getState() : ?string;

  /**
   * Get the time this scheduled transition was created.
   *
   * @return int
   *   The creation time.
   */
  public function getCreatedTime() : int;

  /**
   * Get the date this scheduled transition should execute.
   *
   * @return \DateTimeInterface
   *   The scheduled transition date.
   */
  public function getTransitionDate() : \DateTimeInterface;

  /**
   * Get the time this scheduled transition should execute.
   *
   * @return int
   *   The scheduled transition time.
   */
  public function getTransitionTime() : int;

  /**
   * Set the date this scheduled transition should execute.
   *
   * @param \DateTimeInterface $dateTime
   *   The transition date.
   *
   * @return static
   *   Returns entity for chaining.
   */
  public function setTransitionDate(\DateTimeInterface $dateTime);

  /**
   * Sets the transition time.
   *
   * @param int $time
   *   The transition time.
   *
   * @return static
   *   Returns entity for chaining.
   */
  public function setTransitionTime(int $time);

  /**
   * Sets the lock time.
   *
   * @param int $time
   *   The lock time.
   *
   * @return static
   *   Returns entity for chaining.
   */
  public function setLockedOn(int $time);

  /**
   * Get the options.
   *
   * @return array
   *   An array of options.
   */
  public function getOptions() : array;

  /**
   * Sets options.
   *
   * @param array $options
   *   An array of options.
   *
   * @return static
   *   Returns entity for chaining.
   */
  public function setOptions(array $options);

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
FieldableEntityInterface::baseFieldDefinitions public static function Provides base field definitions for an entity type. 2
FieldableEntityInterface::bundleFieldDefinitions public static function Provides field definitions for a specific bundle. 2
FieldableEntityInterface::get public function Gets a field item list. 1
FieldableEntityInterface::getFieldDefinition public function Gets the definition of a contained field. 1
FieldableEntityInterface::getFieldDefinitions public function Gets an array of field definitions of all contained fields. 1
FieldableEntityInterface::getFields public function Gets an array of all field item lists. 1
FieldableEntityInterface::getTranslatableFields public function Gets an array of field item lists for translatable fields. 1
FieldableEntityInterface::hasField public function Determines whether the entity has a field with the given name. 1
FieldableEntityInterface::isValidationRequired public function Checks whether entity validation is required before saving the entity. 1
FieldableEntityInterface::onChange public function Reacts to changes to a field. 1
FieldableEntityInterface::set public function Sets a field value. 1
FieldableEntityInterface::setValidationRequired public function Sets whether entity validation is required before saving the entity. 1
FieldableEntityInterface::toArray public function Gets an array of all field values. Overrides EntityInterface::toArray
FieldableEntityInterface::validate public function Validates the currently set values. 1
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
RevisionableInterface::getLoadedRevisionId public function Gets the loaded Revision ID of the entity. 1
RevisionableInterface::getRevisionId public function Gets the revision identifier of the entity. 1
RevisionableInterface::isDefaultRevision public function Checks if this entity is the default revision. 1
RevisionableInterface::isLatestRevision public function Checks if this entity is the latest revision. 1
RevisionableInterface::isNewRevision public function Determines whether a new revision should be created on save. 1
RevisionableInterface::preSaveRevision public function Acts on a revision before it gets saved. 1
RevisionableInterface::setNewRevision public function Enforces an entity to be saved as a new revision. 1
RevisionableInterface::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID. 1
RevisionableInterface::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved. 1
ScheduledTransitionInterface::createFrom public static function Creates a new Scheduled Transition from known common metadata. 1
ScheduledTransitionInterface::ENTITY_OPERATION_RESCHEDULE public constant Entity operation for rescheduling transitions for a scheduled transition.
ScheduledTransitionInterface::getAuthor public function Get the author for this scheduled transition. 1
ScheduledTransitionInterface::getCreatedTime public function Get the time this scheduled transition was created. 1
ScheduledTransitionInterface::getEntity public function Get the entity this scheduled transition is for. 1
ScheduledTransitionInterface::getEntityRevisionId public function Get the revision this scheduled transition is for. 1
ScheduledTransitionInterface::getEntityRevisionLanguage public function Get the language of the revision this scheduled transition is for. 1
ScheduledTransitionInterface::getOptions public function Get the options. 1
ScheduledTransitionInterface::getState public function Get the new state for this scheduled transition. 1
ScheduledTransitionInterface::getTransitionDate public function Get the date this scheduled transition should execute. 1
ScheduledTransitionInterface::getTransitionTime public function Get the time this scheduled transition should execute. 1
ScheduledTransitionInterface::getWorkflow public function Get the workflow for this scheduled transition. 1
ScheduledTransitionInterface::OPTION_LATEST_REVISION public constant Option to schedule latest revision.
ScheduledTransitionInterface::setAuthor public function Set the author of the scheduled transition. 1
ScheduledTransitionInterface::setEntity public function Set the revision this scheduled transition is for. 1
ScheduledTransitionInterface::setEntityRevisionId public function Set the revision this scheduled transition is for. 1
ScheduledTransitionInterface::setEntityRevisionLanguage public function Set the language of the revision this scheduled transition is for. 1
ScheduledTransitionInterface::setLockedOn public function Sets the lock time. 1
ScheduledTransitionInterface::setOptions public function Sets options. 1
ScheduledTransitionInterface::setState public function Set the new workflow and state for this scheduled transition. 1
ScheduledTransitionInterface::setTransitionDate public function Set the date this scheduled transition should execute. 1
ScheduledTransitionInterface::setTransitionTime public function Sets the transition time. 1
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
TranslatableInterface::addTranslation public function Adds a new translation to the translatable object. 1
TranslatableInterface::getTranslation public function Gets a translation of the data. 1
TranslatableInterface::getTranslationLanguages public function Returns the languages the data is translated to. 1
TranslatableInterface::getUntranslated public function Returns the translatable object referring to the original language. 1
TranslatableInterface::hasTranslation public function Checks there is a translation for the given language code. 1
TranslatableInterface::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes. 1
TranslatableInterface::isDefaultTranslation public function Checks whether the translation is the default one. 1
TranslatableInterface::isNewTranslation public function Checks whether the translation is new. 1
TranslatableInterface::isTranslatable public function Returns the translation support status. 1
TranslatableInterface::removeTranslation public function Removes the translation identified by the given language code. 1
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly public function Checks if untranslatable fields should affect only the default translation. 1
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision public function Checks whether this is the latest revision affecting this translation. 1
TranslatableRevisionableInterface::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision. 1
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced public function Checks if the revision translation affected flag value has been enforced. 1
TranslatableRevisionableInterface::setRevisionTranslationAffected public function Marks the current revision translation as affected. 1
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced public function Enforces the revision translation affected flag value. 1