class Workspace

Same name in other branches
  1. 8.9.x core/modules/workspaces/src/Entity/Workspace.php \Drupal\workspaces\Entity\Workspace
  2. 10 core/modules/workspaces/src/Entity/Workspace.php \Drupal\workspaces\Entity\Workspace
  3. 11.x core/modules/workspaces/src/Entity/Workspace.php \Drupal\workspaces\Entity\Workspace

The workspace entity class.

Plugin annotation


@ContentEntityType(
  id = "workspace",
  label = @Translation("Workspace"),
  label_collection = @Translation("Workspaces"),
  label_singular = @Translation("workspace"),
  label_plural = @Translation("workspaces"),
  label_count = @PluralTranslation(
    singular = "@count workspace",
    plural = "@count workspaces"
  ),
  handlers = {
    "list_builder" = "\Drupal\workspaces\WorkspaceListBuilder",
    "view_builder" = "Drupal\workspaces\WorkspaceViewBuilder",
    "access" = "Drupal\workspaces\WorkspaceAccessControlHandler",
    "route_provider" = {
      "html" = "\Drupal\Core\Entity\Routing\AdminHtmlRouteProvider",
    },
    "form" = {
      "default" = "\Drupal\workspaces\Form\WorkspaceForm",
      "add" = "\Drupal\workspaces\Form\WorkspaceForm",
      "edit" = "\Drupal\workspaces\Form\WorkspaceForm",
      "delete" = "\Drupal\workspaces\Form\WorkspaceDeleteForm",
      "activate" = "\Drupal\workspaces\Form\WorkspaceActivateForm",
    },
  },
  admin_permission = "administer workspaces",
  base_table = "workspace",
  revision_table = "workspace_revision",
  data_table = "workspace_field_data",
  revision_data_table = "workspace_field_revision",
  field_ui_base_route = "entity.workspace.collection",
  entity_keys = {
    "id" = "id",
    "revision" = "revision_id",
    "uuid" = "uuid",
    "label" = "label",
    "uid" = "uid",
    "owner" = "uid",
  },
  links = {
    "canonical" = "/admin/config/workflow/workspaces/manage/{workspace}",
    "add-form" = "/admin/config/workflow/workspaces/add",
    "edit-form" = "/admin/config/workflow/workspaces/manage/{workspace}/edit",
    "delete-form" = "/admin/config/workflow/workspaces/manage/{workspace}/delete",
    "activate-form" = "/admin/config/workflow/workspaces/manage/{workspace}/activate",
    "collection" = "/admin/config/workflow/workspaces",
  },
)

Hierarchy

Expanded class hierarchy of Workspace

14 files declare their use of Workspace
InstallUninstallTest.php in core/modules/system/tests/src/Functional/Module/InstallUninstallTest.php
PathWorkspacesTest.php in core/modules/workspaces/tests/src/Functional/PathWorkspacesTest.php
TestWorkspaceNegotiator.php in core/modules/workspaces/tests/modules/workspace_update_test/src/Negotiator/TestWorkspaceNegotiator.php
WorkspaceAccessTest.php in core/modules/workspaces/tests/src/Kernel/WorkspaceAccessTest.php
WorkspaceCacheContextTest.php in core/modules/workspaces/tests/src/Functional/WorkspaceCacheContextTest.php

... See full list

48 string references to 'Workspace'
ActiveWorkspaceCheck::access in core/modules/workspaces/src/Access/ActiveWorkspaceCheck.php
Checks access.
ActiveWorkspaceCheckTest::providerTestAccess in core/modules/workspaces/tests/src/Unit/ActiveWorkspaceCheckTest.php
Provides data for the testAccess method.
EntityAccess::entityCreateAccess in core/modules/workspaces/src/EntityAccess.php
Implements a hook bridge for hook_entity_create_access().
EntityAccess::entityOperationAccess in core/modules/workspaces/src/EntityAccess.php
Implements a hook bridge for hook_entity_access().
EntityOperations::entityPresave in core/modules/workspaces/src/EntityOperations.php
Acts on an entity before it is created or updated.

... See full list

File

core/modules/workspaces/src/Entity/Workspace.php, line 66

Namespace

Drupal\workspaces\Entity
View source
class Workspace extends ContentEntityBase implements WorkspaceInterface {
    use EntityChangedTrait;
    use EntityOwnerTrait;
    
    /**
     * {@inheritdoc}
     */
    public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
        $fields = parent::baseFieldDefinitions($entity_type);
        $fields += static::ownerBaseFieldDefinitions($entity_type);
        $fields['id'] = BaseFieldDefinition::create('string')->setLabel(new TranslatableMarkup('Workspace ID'))
            ->setDescription(new TranslatableMarkup('The workspace ID.'))
            ->setSetting('max_length', 128)
            ->setRequired(TRUE)
            ->addConstraint('UniqueField')
            ->addConstraint('DeletedWorkspace')
            ->addPropertyConstraints('value', [
            'Regex' => [
                'pattern' => '/^[a-z0-9_]+$/',
            ],
        ]);
        $fields['label'] = BaseFieldDefinition::create('string')->setLabel(new TranslatableMarkup('Workspace name'))
            ->setDescription(new TranslatableMarkup('The workspace name.'))
            ->setRevisionable(TRUE)
            ->setSetting('max_length', 128)
            ->setRequired(TRUE);
        $fields['uid']->setLabel(new TranslatableMarkup('Owner'))
            ->setDescription(new TranslatableMarkup('The workspace owner.'))
            ->setDisplayOptions('form', [
            'type' => 'entity_reference_autocomplete',
            'weight' => 5,
        ])
            ->setDisplayConfigurable('form', TRUE);
        $fields['parent'] = BaseFieldDefinition::create('entity_reference')->setLabel(new TranslatableMarkup('Parent'))
            ->setDescription(new TranslatableMarkup('The parent workspace.'))
            ->setSetting('target_type', 'workspace')
            ->setReadOnly(TRUE)
            ->setDisplayConfigurable('form', TRUE)
            ->setDisplayOptions('form', [
            'type' => 'options_select',
            'weight' => 10,
        ]);
        $fields['changed'] = BaseFieldDefinition::create('changed')->setLabel(new TranslatableMarkup('Changed'))
            ->setDescription(new TranslatableMarkup('The time that the workspace was last edited.'))
            ->setRevisionable(TRUE);
        $fields['created'] = BaseFieldDefinition::create('created')->setLabel(new TranslatableMarkup('Created'))
            ->setDescription(new TranslatableMarkup('The time that the workspace was created.'));
        return $fields;
    }
    
    /**
     * {@inheritdoc}
     */
    public function publish() {
        return \Drupal::service('workspaces.operation_factory')->getPublisher($this)
            ->publish();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCreatedTime() {
        return $this->get('created')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setCreatedTime($created) {
        return $this->set('created', (int) $created);
    }
    
    /**
     * {@inheritdoc}
     */
    public function hasParent() {
        return !$this->get('parent')
            ->isEmpty();
    }
    
    /**
     * {@inheritdoc}
     */
    public static function preDelete(EntityStorageInterface $storage, array $entities) {
        parent::preDelete($storage, $entities);
        $workspace_tree = \Drupal::service('workspaces.repository')->loadTree();
        // Ensure that workspaces that have descendants can not be deleted.
        foreach ($entities as $entity) {
            if (!empty($workspace_tree[$entity->id()]['descendants'])) {
                throw new \InvalidArgumentException("The {$entity->label()} workspace can not be deleted because it has child workspaces.");
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function postDelete(EntityStorageInterface $storage, array $entities) {
        parent::postDelete($storage, $entities);
        // Add the IDs of the deleted workspaces to the list of workspaces that will
        // be purged on cron.
        $state = \Drupal::state();
        $deleted_workspace_ids = $state->get('workspace.deleted', []);
        $deleted_workspace_ids += array_combine(array_keys($entities), array_keys($entities));
        $state->set('workspace.deleted', $deleted_workspace_ids);
        // Trigger a batch purge to allow empty workspaces to be deleted
        // immediately.
        \Drupal::service('workspaces.manager')->purgeDeletedWorkspacesBatch();
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title 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
ContentEntityBase::bundle public function Gets the bundle of the entity. Overrides EntityBase::bundle
ContentEntityBase::bundleFieldDefinitions public static function 4
ContentEntityBase::clearTranslationCache protected function Clear entity translation object cache to remove stale references.
ContentEntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityBase::create
ContentEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ContentEntityBase::get public function
ContentEntityBase::getEntityKey protected function Gets the value of the given entity key, if defined. 1
ContentEntityBase::getFieldDefinition public function
ContentEntityBase::getFieldDefinitions public function
ContentEntityBase::getFields public function
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
ContentEntityBase::getRevisionId public function
ContentEntityBase::getTranslatableFields public function
ContentEntityBase::getTranslatedField protected function Gets a translated field.
ContentEntityBase::getTranslation public function
ContentEntityBase::getTranslationLanguages public function
ContentEntityBase::getTranslationStatus public function Returns the translation status. Overrides TranslationStatusInterface::getTranslationStatus
ContentEntityBase::getUntranslated public function
ContentEntityBase::hasField public function
ContentEntityBase::hasTranslation public function
ContentEntityBase::hasTranslationChanges public function
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
ContentEntityBase::isDefaultTranslation public function
ContentEntityBase::isDefaultTranslationAffectedOnly public function
ContentEntityBase::isLatestRevision public function
ContentEntityBase::isLatestTranslationAffectedRevision public function
ContentEntityBase::isNewRevision public function
ContentEntityBase::isNewTranslation public function
ContentEntityBase::isRevisionTranslationAffected public function
ContentEntityBase::isRevisionTranslationAffectedEnforced public function
ContentEntityBase::isTranslatable public function
ContentEntityBase::isValidationRequired public function
ContentEntityBase::label public function Gets the label of the entity. Overrides EntityBase::label 6
ContentEntityBase::language public function Gets the language of the entity. Overrides EntityBase::language
ContentEntityBase::onChange public function
ContentEntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityBase::postCreate 1
ContentEntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave 9
ContentEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 8
ContentEntityBase::preSaveRevision public function 3
ContentEntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityBase::referencedEntities 1
ContentEntityBase::removeTranslation public function
ContentEntityBase::set public function
ContentEntityBase::setDefaultLangcode protected function Populates the local cache for the default language code.
ContentEntityBase::setNewRevision public function
ContentEntityBase::setRevisionTranslationAffected public function
ContentEntityBase::setRevisionTranslationAffectedEnforced public function
ContentEntityBase::setValidationRequired public function
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
ContentEntityBase::updateOriginalValues public function Updates the original values with the interim changes.
ContentEntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase::uuid
ContentEntityBase::validate public function 1
ContentEntityBase::wasDefaultRevision public function
ContentEntityBase::__clone public function Magic method: Implements a deep clone.
ContentEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct
ContentEntityBase::__get public function Implements the magic method for getting object properties.
ContentEntityBase::__isset public function Implements the magic method for isset().
ContentEntityBase::__set public function Implements the magic method for setting object properties.
ContentEntityBase::__sleep public function Overrides EntityBase::__sleep
ContentEntityBase::__unset public function Implements the magic method for unset().
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
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 1
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
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 4
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::getTypedDataClass private function Returns the typed data class name for this entity.
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. 2
EntityBase::isNew public function Determines whether the entity is new. Overrides EntityInterface::isNew 2
EntityBase::languageManager protected function Gets the language manager.
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::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 3
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
EntityBase::save public function Saves an entity permanently. Overrides EntityInterface::save 3
EntityBase::setOriginalId public function Sets the original ID. Overrides EntityInterface::setOriginalId 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl 2
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuidGenerator protected function Gets the UUID generator.
EntityChangedTrait::getChangedTime public function Gets the timestamp of the last entity change for the current translation.
EntityChangedTrait::getChangedTimeAcrossTranslations public function Returns the timestamp of the last entity change across all translations.
EntityChangedTrait::setChangedTime public function Sets the timestamp of the last entity change for the current translation.
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck
EntityOwnerTrait::getDefaultEntityOwner public static function Default value callback for 'owner' base field. 1
EntityOwnerTrait::getOwner public function 1
EntityOwnerTrait::getOwnerId public function
EntityOwnerTrait::ownerBaseFieldDefinitions public static function Returns an array of base field definitions for entity owners.
EntityOwnerTrait::setOwner public function
EntityOwnerTrait::setOwnerId public function
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Is entity being created updated or deleted through 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.
Workspace::baseFieldDefinitions public static function Overrides ContentEntityBase::baseFieldDefinitions
Workspace::getCreatedTime public function Gets the workspace creation timestamp. Overrides WorkspaceInterface::getCreatedTime
Workspace::hasParent public function Determines whether the workspace has a parent. Overrides WorkspaceInterface::hasParent
Workspace::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete
Workspace::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete
Workspace::publish public function Publishes the contents of this workspace to the default (Live) workspace. Overrides WorkspaceInterface::publish
Workspace::setCreatedTime public function Sets the workspace creation timestamp. Overrides WorkspaceInterface::setCreatedTime

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.