class WorkspacePointer in Workspace 8
Defines the Workspace pointer entity.
Plugin annotation
@ContentEntityType(
  id = "workspace_pointer",
  label = @Translation("Workspace pointer"),
  base_table = "workspace_pointer",
  entity_keys = {
    "id" = "id",
    "revision" = "revision_id",
    "label" = "name",
    "uuid" = "uuid",
  },
  local = TRUE,
  multiversion = FALSE
)
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\workspace\Entity\WorkspacePointer implements WorkspacePointerInterface uses EntityChangedTrait
 
 
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
Expanded class hierarchy of WorkspacePointer
9 files declare their use of WorkspacePointer
- ReplicationSettingsPageTest.php in tests/src/ Functional/ ReplicationSettingsPageTest.php 
- ReplicatorTest.php in tests/src/ Functional/ ReplicatorTest.php 
- Toolbar.php in src/Toolbar.php 
- workspace.module in ./workspace.module 
- WorkspaceConfigForm.php in src/Form/ WorkspaceConfigForm.php 
File
- src/Entity/ WorkspacePointer.php, line 34 
Namespace
Drupal\workspace\EntityView source
class WorkspacePointer extends ContentEntityBase implements WorkspacePointerInterface {
  use EntityChangedTrait;
  /**
   * {@inheritdoc}
   */
  public static function preCreate(EntityStorageInterface $storage_controller, array &$values) {
    parent::preCreate($storage_controller, $values);
  }
  /**
   * @inheritDoc
   */
  public function label() {
    $label = parent::label();
    if (empty($label) && !empty($this
      ->getWorkspace())) {
      $label = $this
        ->getWorkspace()
        ->label();
    }
    return $label;
  }
  /**
   * {@inheritdoc}
   */
  public function getName() {
    return $this
      ->get('name')->value;
  }
  /**
   * {@inheritdoc}
   */
  public function setName($name) {
    $this
      ->set('name', $name);
    return $this;
  }
  /**
   * {@inheritdoc}
   */
  public function getCreatedTime() {
    return $this
      ->get('created')->value;
  }
  /**
   * {@inheritdoc}
   */
  public function setCreatedTime($timestamp) {
    $this
      ->set('created', $timestamp);
    return $this;
  }
  /**
   * {@inheritdoc}
   */
  public function setWorkspace(WorkspaceInterface $workspace) {
    $this
      ->set('workspace_pointer', $workspace
      ->id());
    return $this;
  }
  /**
   * {@inheritdoc}
   */
  public function setWorkspaceId($workspace_id) {
    $this
      ->set('workspace_pointer', $workspace_id);
    return $this;
  }
  /**
   * {@inheritdoc}
   */
  public function getWorkspace() {
    $ws = $this
      ->get('workspace_pointer')->entity;
    return $ws;
  }
  /**
   * {@inheritdoc}
   */
  public function getWorkspaceId() {
    return $this
      ->get('workspace_pointer')->target_id;
  }
  /**
   * {@inheritdoc}
   */
  public function setWorkspaceAvailable($available = TRUE) {
    $this
      ->set('workspace_available', $available);
    return $this;
  }
  /**
   * {@inheritdoc}
   */
  public function getWorkspaceAvailable() {
    return (bool) $this
      ->get('workspace_available')->value;
  }
  /**
   * {@inheritdoc}
   */
  public function generateReplicationId(WorkspacePointerInterface $target, ReplicationTaskInterface $task = NULL) {
    $request = \Drupal::request();
    $uuid = MD5($request
      ->getHost() . $request
      ->getPort());
    $source_name = $this
      ->label();
    if ($this
      ->getWorkspace() instanceof WorkspaceInterface) {
      $source_name = $this
        ->getWorkspace()
        ->getMachineName();
    }
    $target_name = $target
      ->label();
    if ($target
      ->getWorkspace() instanceof WorkspaceInterface) {
      $target_name = $target
        ->getWorkspace()
        ->getMachineName();
    }
    if ($task) {
      return \md5($uuid . $source_name . $target_name . var_export($task
        ->getDocIds(), TRUE) . ($task
        ->getCreateTarget() ? '1' : '0') . ($task
        ->getContinuous() ? '1' : '0') . $task
        ->getFilter() . '' . $task
        ->getStyle() . var_export($task
        ->getHeartbeat(), TRUE));
    }
    return \md5($uuid . $source_name . $target_name);
  }
  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields['id'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('ID'))
      ->setDescription(t('The ID of the Workspace pointer entity.'))
      ->setReadOnly(TRUE);
    $fields['uuid'] = BaseFieldDefinition::create('uuid')
      ->setLabel(t('UUID'))
      ->setDescription(t('The UUID of the Workspace pointer entity.'))
      ->setReadOnly(TRUE);
    $fields['revision_id'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Revision ID'))
      ->setDescription(t('The revision ID of the workspace pointer entity.'))
      ->setReadOnly(TRUE)
      ->setSetting('unsigned', TRUE);
    $fields['name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Name'))
      ->setDescription(t('The name of the Workspace pointer entity.'))
      ->setSettings([
      'max_length' => 512,
      'text_processing' => 0,
    ])
      ->setRevisionable(TRUE)
      ->setDefaultValue('')
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setDescription(t('The time that the entity was created.'))
      ->setRevisionable(TRUE);
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The time that the entity was last edited.'))
      ->setRevisionable(TRUE);
    $fields['workspace_pointer'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Workspace'))
      ->setDescription(t('A reference to the workspace'))
      ->setSetting('target_type', 'workspace')
      ->setRevisionable(TRUE);
    // This field will keep the information about the availability of the
    // remote workspace, which is checked on every cron run. This value is not
    // used when doing the replication, because during replication the
    // availability of the remote workspaces is checked with HTTP requests.
    // This value is used to restrict the user to select from UI a remote
    // workspace as target when it is not available.
    $fields['workspace_available'] = BaseFieldDefinition::create('boolean')
      ->setLabel(new TranslatableMarkup('Workspace available'))
      ->setDescription(t('Keeps the availability of the referenced ' . 'workspace, this flag might not be accurate, the availability should ' . 'be checked regularly (it is checked on cron run).'))
      ->setRevisionable(TRUE)
      ->setDefaultValue(TRUE);
    return $fields;
  }
  /**
   * Load a workspace pointer for the given workspace.
   *
   * @param \Drupal\multiversion\Entity\WorkspaceInterface $workspace
   *   The workspace entity to get the workspace pointer for.
   *
   * @return \Drupal\workspace\WorkspacePointerInterface
   *   The workspace pointer for the given workspace.
   */
  public static function loadFromWorkspace(WorkspaceInterface $workspace) {
    $pointers = \Drupal::service('entity_type.manager')
      ->getStorage('workspace_pointer')
      ->loadByProperties([
      'workspace_pointer' => $workspace
        ->id(),
    ]);
    return reset($pointers);
  }
}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 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 | Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface:: | 2 | 
| 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:: | protected | function | Invalidates an entity's cache tags upon save. | 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 | 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. | |
| EntityChangedTrait:: | public | function | Gets the timestamp of the last entity change for the current translation. | |
| EntityChangedTrait:: | public | function | Returns the timestamp of the last entity change across all translations. | |
| EntityChangedTrait:: | public | function | Sets the timestamp of the last entity change for the current translation. | |
| 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 | ||
| 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. | ||
| WorkspacePointer:: | public static | function | Provides base field definitions for an entity type. Overrides ContentEntityBase:: | |
| WorkspacePointer:: | public | function | Overrides WorkspacePointerInterface:: | |
| WorkspacePointer:: | public | function | Gets the Workspace pointer creation timestamp. Overrides WorkspacePointerInterface:: | |
| WorkspacePointer:: | public | function | Gets the Workspace pointer name. Overrides WorkspacePointerInterface:: | |
| WorkspacePointer:: | public | function | Returns the referenced workspace entity. Overrides WorkspacePointerInterface:: | |
| WorkspacePointer:: | public | function | Returns the availability of the workspace. Overrides WorkspacePointerInterface:: | |
| WorkspacePointer:: | public | function | Returns the referenced workspace ID. Overrides WorkspacePointerInterface:: | |
| WorkspacePointer:: | public | function | @inheritDoc Overrides ContentEntityBase:: | |
| WorkspacePointer:: | public static | function | Load a workspace pointer for the given workspace. | |
| WorkspacePointer:: | public static | function | Changes the values of an entity before it is created. Overrides EntityBase:: | |
| WorkspacePointer:: | public | function | Sets the Workspace pointer creation timestamp. Overrides WorkspacePointerInterface:: | |
| WorkspacePointer:: | public | function | Sets the Workspace pointer name. Overrides WorkspacePointerInterface:: | |
| WorkspacePointer:: | public | function | Sets the Workspace this pointer references. Overrides WorkspacePointerInterface:: | |
| WorkspacePointer:: | public | function | Sets the availability of the workspace. Overrides WorkspacePointerInterface:: | |
| WorkspacePointer:: | public | function | Sets the referenced workspace ID. Overrides WorkspacePointerInterface:: | 
