Updated Drupal to 8.6. This goes with the following updates because it's possible...

[yaffs-website] / web / core / modules / workspaces / src / Entity / Workspace.php

diff --git a/web/core/modules/workspaces/src/Entity/Workspace.php b/web/core/modules/workspaces/src/Entity/Workspace.php
new file mode 100644 (file)
index 0000000..44a7915
--- /dev/null
+++ b/web/core/modules/workspaces/src/Entity/Workspace.php
@@ -0,0 +1,201 @@
+<?php
+
+namespace Drupal\workspaces\Entity;
+
+use Drupal\Core\Entity\ContentEntityBase;
+use Drupal\Core\Entity\EntityChangedTrait;
+use Drupal\Core\Entity\EntityStorageInterface;
+use Drupal\Core\Entity\EntityTypeInterface;
+use Drupal\Core\Field\BaseFieldDefinition;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\user\UserInterface;
+use Drupal\workspaces\WorkspaceInterface;
+
+/**
+ * The workspace entity class.
+ *
+ * @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",
+ *     "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",
+ *       "deploy" = "\Drupal\workspaces\Form\WorkspaceDeployForm",
+ *     },
+ *   },
+ *   admin_permission = "administer workspaces",
+ *   base_table = "workspace",
+ *   revision_table = "workspace_revision",
+ *   data_table = "workspace_field_data",
+ *   revision_data_table = "workspace_field_revision",
+ *   entity_keys = {
+ *     "id" = "id",
+ *     "revision" = "revision_id",
+ *     "uuid" = "uuid",
+ *     "label" = "label",
+ *     "uid" = "uid",
+ *   },
+ *   links = {
+ *     "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",
+ *     "deploy-form" = "/admin/config/workflow/workspaces/manage/{workspace}/deploy",
+ *     "collection" = "/admin/config/workflow/workspaces",
+ *   },
+ * )
+ */
+class Workspace extends ContentEntityBase implements WorkspaceInterface {
+
+  use EntityChangedTrait;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
+    $fields = parent::baseFieldDefinitions($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'] = BaseFieldDefinition::create('entity_reference')
+      ->setLabel(new TranslatableMarkup('Owner'))
+      ->setDescription(new TranslatableMarkup('The workspace owner.'))
+      ->setRevisionable(TRUE)
+      ->setSetting('target_type', 'user')
+      ->setDefaultValueCallback('Drupal\workspaces\Entity\Workspace::getCurrentUserId')
+      ->setDisplayOptions('form', [
+        'type' => 'entity_reference_autocomplete',
+        'weight' => 5,
+      ])
+      ->setDisplayConfigurable('form', TRUE);
+
+    $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 workspaces was created.'));
+
+    return $fields;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function publish() {
+    return \Drupal::service('workspaces.operation_factory')->getPublisher($this)->publish();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function isDefaultWorkspace() {
+    return $this->id() === static::DEFAULT_WORKSPACE;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCreatedTime() {
+    return $this->get('created')->value;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setCreatedTime($created) {
+    return $this->set('created', (int) $created);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getOwner() {
+    return $this->get('uid')->entity;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setOwner(UserInterface $account) {
+    return $this->set('uid', $account->id());
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getOwnerId() {
+    return $this->get('uid')->target_id;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setOwnerId($uid) {
+    return $this->set('uid', $uid);
+  }
+
+  /**
+   * {@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', []);
+    unset($entities[static::DEFAULT_WORKSPACE]);
+    $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();
+  }
+
+  /**
+   * Default value callback for 'uid' base field definition.
+   *
+   * @see ::baseFieldDefinitions()
+   *
+   * @return int[]
+   *   An array containing the ID of the current user.
+   */
+  public static function getCurrentUserId() {
+    return [\Drupal::currentUser()->id()];
+  }
+
+}