interface WorkspaceInterface
Same name and namespace in other branches
- 9 core/modules/workspaces/src/WorkspaceInterface.php \Drupal\workspaces\WorkspaceInterface
- 10 core/modules/workspaces/src/WorkspaceInterface.php \Drupal\workspaces\WorkspaceInterface
- 11.x core/modules/workspaces/src/WorkspaceInterface.php \Drupal\workspaces\WorkspaceInterface
Defines an interface for the workspace entity type.
Hierarchy
- interface \Drupal\Core\Entity\ContentEntityInterface implements \Drupal\Core\Entity\Traversable, \Drupal\Core\Entity\FieldableEntityInterface, \Drupal\Core\Entity\TranslatableRevisionableInterface, \Drupal\Core\Entity\SynchronizableInterface; interface \Drupal\Core\Entity\EntityChangedInterface implements \Drupal\Core\Entity\EntityInterface; interface \Drupal\user\EntityOwnerInterface
- interface \Drupal\workspaces\WorkspaceInterface implements \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\Entity\EntityChangedInterface, \Drupal\user\EntityOwnerInterface
Expanded class hierarchy of WorkspaceInterface
All classes that implement WorkspaceInterface
8 files declare their use of WorkspaceInterface
- content_moderation.module in core/
modules/ content_moderation/ content_moderation.module - Contains content_moderation.module.
- SessionWorkspaceNegotiator.php in core/
modules/ workspaces/ src/ Negotiator/ SessionWorkspaceNegotiator.php - TestWorkspaceNegotiator.php in core/
modules/ workspaces/ tests/ modules/ workspace_update_test/ src/ Negotiator/ TestWorkspaceNegotiator.php - Workspace.php in core/
modules/ workspaces/ src/ Entity/ Workspace.php - WorkspaceMergeForm.php in core/
modules/ workspaces/ src/ Form/ WorkspaceMergeForm.php
File
-
core/
modules/ workspaces/ src/ WorkspaceInterface.php, line 12
Namespace
Drupal\workspacesView source
interface WorkspaceInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface {
/**
* The ID of the default workspace.
*
* @deprecated in drupal:8.8.0 and is removed from drupal:9.0.0. Use
* \Drupal\workspaces\WorkspaceManager::hasActiveWorkspace() instead.
*
* @see https://www.drupal.org/node/3071527
*/
const DEFAULT_WORKSPACE = 'live';
/**
* Publishes the contents of this workspace to the default (Live) workspace.
*/
public function publish();
/**
* Determines whether the workspace is the default one or not.
*
* @return bool
* TRUE if this workspace is the default one (e.g 'Live'), FALSE otherwise.
*
* @deprecated in drupal:8.8.0 and is removed from drupal:9.0.0. Use
* \Drupal\workspaces\WorkspaceManager::hasActiveWorkspace() instead.
*
* @see https://www.drupal.org/node/3071527
*/
public function isDefaultWorkspace();
/**
* Gets the workspace creation timestamp.
*
* @return int
* Creation timestamp of the workspace.
*/
public function getCreatedTime();
/**
* Sets the workspace creation timestamp.
*
* @param int $timestamp
* The workspace creation timestamp.
*
* @return $this
*/
public function setCreatedTime($timestamp);
/**
* Determines whether the workspace has a parent.
*
* @return bool
* TRUE if the workspace has a parent, FALSE otherwise.
*/
public function hasParent();
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | 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 | ||
EntityChangedInterface::getChangedTime | public | function | Gets the timestamp of the last entity change for the current translation. | |||
EntityChangedInterface::getChangedTimeAcrossTranslations | public | function | Gets the timestamp of the last entity change across all translations. | |||
EntityChangedInterface::setChangedTime | public | function | Sets the timestamp of the last entity change for the current translation. | |||
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::link | Deprecated | public | function | Deprecated way of generating a link to the entity. See toLink(). | 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::url | Deprecated | public | function | Gets the public URL for this entity. | 2 | |
EntityInterface::urlInfo | Deprecated | public | function | Gets the URL object for the entity. | 2 | |
EntityInterface::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | 2 | ||
EntityOwnerInterface::getOwner | public | function | Returns the entity owner's user entity. | 1 | ||
EntityOwnerInterface::getOwnerId | public | function | Returns the entity owner's user ID. | 1 | ||
EntityOwnerInterface::setOwner | public | function | Sets the entity owner's user entity. | 1 | ||
EntityOwnerInterface::setOwnerId | public | function | Sets the entity owner's user ID. | 1 | ||
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 | ||
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 | ||
WorkspaceInterface::DEFAULT_WORKSPACE | Deprecated | constant | The ID of the default workspace. | |||
WorkspaceInterface::getCreatedTime | public | function | Gets the workspace creation timestamp. | 1 | ||
WorkspaceInterface::hasParent | public | function | Determines whether the workspace has a parent. | 1 | ||
WorkspaceInterface::isDefaultWorkspace | Deprecated | public | function | Determines whether the workspace is the default one or not. | 1 | |
WorkspaceInterface::publish | public | function | Publishes the contents of this workspace to the default (Live) workspace. | 1 | ||
WorkspaceInterface::setCreatedTime | public | function | Sets the workspace creation timestamp. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.