class ScheduledTransition in Scheduled Transitions 8
Same name and namespace in other branches
- 2.x src/Entity/ScheduledTransition.php \Drupal\scheduled_transitions\Entity\ScheduledTransition
Scheduled Transition entity.
Plugin annotation
@ContentEntityType(
id = "scheduled_transition",
label = @Translation("scheduled transition"),
label_singular = @Translation("Scheduled transition"),
label_plural = @Translation("scheduled transitions"),
label_count = @PluralTranslation(
singular = "@count scheduled transition",
plural = "@count scheduled transitions"
),
label_collection = @Translation("Scheduled transitions"),
base_table = "scheduled_transition",
data_table = "scheduled_transition",
translatable = FALSE,
entity_keys = {
"id" = "id",
"uuid" = "uuid",
"uid" = "author",
},
internal = TRUE,
admin_permission = "view all scheduled transitions",
handlers = {
"access" = "Drupal\scheduled_transitions\ScheduledTransitionsAccessControlHandler",
"list_builder" = "Drupal\scheduled_transitions\ScheduledTransitionsListBuilder",
"views_data" = "Drupal\scheduled_transitions\ScheduledTransitionsViewsData",
"form" = {
"delete" = "Drupal\Core\Entity\ContentEntityDeleteForm",
"reschedule" = "Drupal\scheduled_transitions\Form\Entity\ScheduledTransitionRescheduleForm",
},
"route_provider" = {
"html" = "Drupal\scheduled_transitions\Routing\ScheduledTransitionRouteProvider",
}
},
links = {
"collection" = "/admin/content/scheduled-transitions",
"delete-form" = "/admin/scheduled-transition/{scheduled_transition}/delete",
"reschedule-form" = "/admin/scheduled-transition/{scheduled_transition}/reschedule",
},
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
- class \Drupal\scheduled_transitions\Entity\ScheduledTransition implements ScheduledTransitionInterface
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
Expanded class hierarchy of ScheduledTransition
12 files declare their use of ScheduledTransition
- ScheduledTransitionAddForm.php in src/
Form/ Entity/ ScheduledTransitionAddForm.php - ScheduledTransitionEntityTest.php in tests/
src/ Kernel/ ScheduledTransitionEntityTest.php - ScheduledTransitionEntityTransitionsFormTest.php in tests/
src/ Functional/ ScheduledTransitionEntityTransitionsFormTest.php - ScheduledTransitionForm.php in src/
Form/ ScheduledTransitionForm.php - ScheduledTransitionListTest.php in tests/
src/ Functional/ ScheduledTransitionListTest.php
File
- src/
Entity/ ScheduledTransition.php, line 58
Namespace
Drupal\scheduled_transitions\EntityView source
class ScheduledTransition extends ContentEntityBase implements ScheduledTransitionInterface {
/**
* Option to recreate non default head.
*/
public const OPTION_RECREATE_NON_DEFAULT_HEAD = 'recreate_non_default_head';
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) : array {
$fields = parent::baseFieldDefinitions($entity_type);
$fields['entity'] = BaseFieldDefinition::create('dynamic_entity_reference')
->setLabel(\t('Entity'))
->setDescription(\t('The entity this scheduled transition is for.'))
->setRequired(TRUE)
->setCardinality(1);
// Only supports entities with integer IDs.
$fields['entity_revision_id'] = BaseFieldDefinition::create('integer')
->setLabel(\t('Content entity revision ID'))
->setDescription(\t('The revision ID of the entity this scheduled transition is for.'))
->setRequired(TRUE)
->setCardinality(1);
$fields['entity_revision_langcode'] = BaseFieldDefinition::create('language')
->setLabel(\t('Content entity revision language'))
->setDescription(\t('The revision language of the entity this scheduled transition is for.'))
->setRequired(FALSE)
->setCardinality(1);
$fields['author'] = BaseFieldDefinition::create('entity_reference')
->setLabel(\t('Authored by'))
->setDescription(\t('The user who initiated the scheduled transition.'))
->setSetting('target_type', 'user');
// Workflow is recorded so scheduled transitions can be cleaned up if they
// are deleted. Similar to 'bundle' column on field tables.
$fields['workflow'] = BaseFieldDefinition::create('entity_reference')
->setLabel(\t('Workflow'))
->setDescription(\t('The workflow of the state.'))
->setSetting('target_type', 'workflow')
->setRequired(TRUE);
$fields['moderation_state'] = BaseFieldDefinition::create('string')
->setLabel(\t('Moderation state'))
->setDescription(\t('The new state of the content.'))
->setRequired(TRUE);
$fields['created'] = BaseFieldDefinition::create('created')
->setLabel(\t('Authored on'))
->setDescription(\t('The time that the scheduled transition was created.'));
$fields['transition_on'] = BaseFieldDefinition::create('timestamp')
->setLabel(\t('Transition on'))
->setDescription(\t('The time scheduled transition should happen.'))
->setDisplayOptions('form', [
'type' => 'datetime_timestamp',
'weight' => 10,
]);
$fields['locked_on'] = BaseFieldDefinition::create('timestamp')
->setLabel(\t('Locked on'))
->setDescription(\t('The time a job was created to process the transition.'));
$fields['options'] = BaseFieldDefinition::create('map')
->setLabel(t('Options'))
->setDescription(t('Arbitrary settings for scheduled transition.'));
return $fields;
}
/**
* {@inheritdoc}
*/
public function getEntity() : ?EntityInterface {
return $this
->get('entity')->entity;
}
/**
* {@inheritdoc}
*/
public function getEntityRevisionId() {
return $this
->get('entity_revision_id')->value;
}
/**
* {@inheritdoc}
*/
public function getEntityRevisionLanguage() : ?string {
return $this
->get('entity_revision_langcode')->value;
}
/**
* {@inheritdoc}
*/
public function getAuthor() : ?UserInterface {
return $this
->get('author')->entity;
}
/**
* {@inheritdoc}
*/
public function getWorkflow() : ?WorkflowInterface {
return $this
->get('workflow')->entity;
}
/**
* {@inheritdoc}
*/
public function getState() : string {
return $this
->get('moderation_state')->value;
}
/**
* {@inheritdoc}
*/
public function getCreatedTime() : int {
return $this
->get('created')->value;
}
/**
* {@inheritdoc}
*/
public function getTransitionTime() : int {
return (int) $this
->get('transition_on')->value;
}
/**
* {@inheritdoc}
*/
public function setTransitionTime(int $time) {
$this
->set('transition_on', $time);
return $this;
}
/**
* {@inheritdoc}
*/
public function setLockedOn(int $time) {
$this
->set('locked_on', $time);
return $this;
}
/**
* {@inheritdoc}
*/
public function getOptions() : array {
$options = $this
->get('options')
->first();
if (isset($options)) {
return $options
->getValue();
}
return [];
}
/**
* {@inheritdoc}
*/
public function getCacheTagsToInvalidate() : array {
$tags = parent::getCacheTagsToInvalidate();
$entity = $this
->getEntity();
if ($entity) {
$tags[] = ScheduledTransitionsUtility::createScheduledTransitionsCacheTag($entity);
}
return $tags;
}
/**
* {@inheritdoc}
*/
protected function invalidateTagsOnSave($update) {
parent::invalidateTagsOnSave($update);
$entity = $this
->getEntity();
if ($entity) {
$tags[] = ScheduledTransitionsUtility::createScheduledTransitionsCacheTag($entity);
}
Cache::invalidateTags($tags);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ContentEntityBase:: |
protected | property | Language code identifying the entity active language. | |
ContentEntityBase:: |
protected | property | Local cache for the default language code. | |
ContentEntityBase:: |
protected | property | The default langcode entity key. | |
ContentEntityBase:: |
protected | property | Whether the revision translation affected flag has been enforced. | |
ContentEntityBase:: |
protected | property | Holds untranslatable entity keys such as the ID, bundle, and revision ID. | |
ContentEntityBase:: |
protected | property | Local cache for field definitions. | |
ContentEntityBase:: |
protected | property | The array of fields, each being an instance of FieldItemListInterface. | |
ContentEntityBase:: |
protected static | property | Local cache for fields to skip from the checking for translation changes. | |
ContentEntityBase:: |
protected | property | Indicates whether this is the default revision. | |
ContentEntityBase:: |
protected | property | The language entity key. | |
ContentEntityBase:: |
protected | property | Local cache for the available language objects. | |
ContentEntityBase:: |
protected | property | The loaded revision ID before the new revision was set. | |
ContentEntityBase:: |
protected | property | Boolean indicating whether a new revision should be created on save. | |
ContentEntityBase:: |
protected | property | The revision translation affected entity key. | |
ContentEntityBase:: |
protected | property | Holds translatable entity keys such as the label. | |
ContentEntityBase:: |
protected | property | A flag indicating whether a translation object is being initialized. | |
ContentEntityBase:: |
protected | property | An array of entity translation metadata. | |
ContentEntityBase:: |
protected | property | Whether entity validation was performed. | |
ContentEntityBase:: |
protected | property | Whether entity validation is required before saving the entity. | |
ContentEntityBase:: |
protected | property | The plain data values of the contained fields. | |
ContentEntityBase:: |
public | function |
Checks data value access. Overrides EntityBase:: |
1 |
ContentEntityBase:: |
public | function |
Adds a new translation to the translatable object. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityBase:: |
|
ContentEntityBase:: |
public static | function |
Provides field definitions for a specific bundle. Overrides FieldableEntityInterface:: |
4 |
ContentEntityBase:: |
protected | function | Clear entity translation object cache to remove stale references. | |
ContentEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ContentEntityBase:: |
public | function |
Gets a field item list. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Gets the value of the given entity key, if defined. | 1 |
ContentEntityBase:: |
public | function |
Gets the definition of a contained field. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of all field item lists. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Returns an array of field names to skip in ::hasTranslationChanges. | 1 |
ContentEntityBase:: |
public | function | ||
ContentEntityBase:: |
protected | function | ||
ContentEntityBase:: |
public | function |
Gets the loaded Revision ID of the entity. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the revision identifier of the entity. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Gets a translated field. | |
ContentEntityBase:: |
public | function |
Gets a translation of the data. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the languages the data is translated to. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translation status. Overrides TranslationStatusInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translatable object referring to the original language. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Checks there is a translation for the given language code. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines if the current translation of the entity has unsaved changes. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the identifier. Overrides EntityBase:: |
|
ContentEntityBase:: |
protected | function | Instantiates a translation object for an existing translation. | |
ContentEntityBase:: |
public | function |
Checks if this entity is the default revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the translation is the default one. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks if untranslatable fields should affect only the default translation. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks if this entity is the latest revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether this is the latest revision affecting this translation. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines whether a new revision should be created on save. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the translation is new. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the current translation is affected by the current revision. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks if the revision translation affected flag value has been enforced. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translation support status. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityBase:: |
2 |
ContentEntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function |
Reacts to changes to a field. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase:: |
5 |
ContentEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
5 |
ContentEntityBase:: |
public | function |
Acts on a revision before it gets saved. Overrides RevisionableInterface:: |
2 |
ContentEntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityBase:: |
1 |
ContentEntityBase:: |
public | function |
Removes the translation identified by the given language code. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Sets a field value. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Populates the local cache for the default language code. | |
ContentEntityBase:: |
public | function |
Enforces an entity to be saved as a new revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Marks the current revision translation as affected. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Enforces the revision translation affected flag value. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
|
ContentEntityBase:: |
protected | function | Updates language for already instantiated fields. | |
ContentEntityBase:: |
public | function |
Updates the loaded Revision ID with the revision ID. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function | Updates the original values with the interim changes. | |
ContentEntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function |
Validates the currently set values. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the entity object was a default revision when it was saved. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function | Magic method: Implements a deep clone. | |
ContentEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function | Implements the magic method for getting object properties. | |
ContentEntityBase:: |
public | function | Implements the magic method for isset(). | |
ContentEntityBase:: |
public | function | Implements the magic method for setting object properties. | |
ContentEntityBase:: |
public | function |
Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function | Implements the magic method for unset(). | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets the original ID. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
protected static | function | Invalidates an entity's cache tags upon delete. | 1 |
EntityBase:: |
public | function |
Determines whether the entity is new. Overrides EntityInterface:: |
2 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
16 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityInterface:: |
3 |
EntityBase:: |
public | function |
Sets the original ID. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
EntityChangesDetectionTrait:: |
protected | function | Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck | |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
ScheduledTransition:: |
public static | function |
Provides base field definitions for an entity type. Overrides ContentEntityBase:: |
|
ScheduledTransition:: |
public | function |
Get the author for this scheduled transition. Overrides ScheduledTransitionInterface:: |
|
ScheduledTransition:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
|
ScheduledTransition:: |
public | function |
Get the time this scheduled transition was created. Overrides ScheduledTransitionInterface:: |
|
ScheduledTransition:: |
public | function |
Get the entity this scheduled transition is for. Overrides ScheduledTransitionInterface:: |
|
ScheduledTransition:: |
public | function |
Get the revision this scheduled transition is for. Overrides ScheduledTransitionInterface:: |
|
ScheduledTransition:: |
public | function |
Get the language of the revision this scheduled transition is for. Overrides ScheduledTransitionInterface:: |
|
ScheduledTransition:: |
public | function |
Get the options. Overrides ScheduledTransitionInterface:: |
|
ScheduledTransition:: |
public | function |
Get the new state for this scheduled transition. Overrides ScheduledTransitionInterface:: |
|
ScheduledTransition:: |
public | function |
Get the time this scheduled transition should execute. Overrides ScheduledTransitionInterface:: |
|
ScheduledTransition:: |
public | function |
Get the workflow for this scheduled transition. Overrides ScheduledTransitionInterface:: |
|
ScheduledTransition:: |
protected | function |
Invalidates an entity's cache tags upon save. Overrides EntityBase:: |
|
ScheduledTransition:: |
public | constant | Option to recreate non default head. | |
ScheduledTransition:: |
public | function |
Sets the lock time. Overrides ScheduledTransitionInterface:: |
|
ScheduledTransition:: |
public | function |
Sets the transition time. Overrides ScheduledTransitionInterface:: |
|
ScheduledTransitionInterface:: |
public | constant | Entity operation for rescheduling transitions for a scheduled transition. | |
ScheduledTransitionInterface:: |
public | constant | Option to schedule latest revision. | |
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function | ||
TranslationStatusInterface:: |
constant | Status code identifying a newly created translation. | ||
TranslationStatusInterface:: |
constant | Status code identifying an existing translation. | ||
TranslationStatusInterface:: |
constant | Status code identifying a removed translation. |