Class Drupal\workspaces\Entity\Workspace - Source Code

    
        
namespace Drupal\workspaces\Entity;

use Drupal\Core\Entity\Attribute\ContentEntityType;
use Drupal\Core\Entity\ContentEntityBase;
use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\Routing\AdminHtmlRouteProvider;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\user\EntityOwnerTrait;
use Drupal\views\EntityViewsData;
use Drupal\workspaces\Entity\Handler\IgnoredWorkspaceHandler;
use Drupal\workspaces\Form\WorkspaceActivateForm;
use Drupal\workspaces\Form\WorkspaceDeleteForm;
use Drupal\workspaces\Form\WorkspaceForm;
use Drupal\workspaces\Hook\WorkspacesHooks;
use Drupal\workspaces\Provider\DefaultWorkspaceProvider;
use Drupal\workspaces\Provider\WorkspaceProviderCollector;
use Drupal\workspaces\Provider\WorkspaceProviderInterface;
use Drupal\workspaces\WorkspaceAccessControlHandler;
use Drupal\workspaces\WorkspaceInterface;
use Drupal\workspaces\WorkspaceListBuilder;
use Drupal\workspaces\WorkspaceViewBuilder;

/**
 * The workspace entity class.
 */
#[ContentEntityType(
  id: 'workspace',
  label: new TranslatableMarkup('Workspace'),
  label_collection: new TranslatableMarkup('Workspaces'),
  label_singular: new TranslatableMarkup('workspace'),
  label_plural: new TranslatableMarkup('workspaces'),
  entity_keys: [
    'id' => 'id',
    'revision' => 'revision_id',
    'uuid' => 'uuid',
    'label' => 'label',
    'uid' => 'uid',
    'owner' => 'uid',
  ],
  handlers: [
    'list_builder' => WorkspaceListBuilder::class,
    'view_builder' => WorkspaceViewBuilder::class,
    'access' => WorkspaceAccessControlHandler::class,
    'views_data' => EntityViewsData::class,
    'route_provider' => [
      'html' => AdminHtmlRouteProvider::class,
    ],
    'form' => [
      'default' => WorkspaceForm::class,
      'add' => WorkspaceForm::class,
      'edit' => WorkspaceForm::class,
      'delete' => WorkspaceDeleteForm::class,
      'activate' => WorkspaceActivateForm::class,
    ],
    'workspace' => IgnoredWorkspaceHandler::class,
  ],
  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',
  ],
  admin_permission: 'administer workspaces',
  base_table: 'workspace',
  data_table: 'workspace_field_data',
  revision_table: 'workspace_revision',
  revision_data_table: 'workspace_field_revision',
  label_count: [
    'singular' => '@count workspace',
    'plural' => '@count workspaces',
  ],
  field_ui_base_route: 'entity.workspace.collection',
)]
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['provider'] = BaseFieldDefinition::create('string')
      ->setLabel(new TranslatableMarkup('Provider'))
      ->setDescription(new TranslatableMarkup('The workspace provider.'))
      ->setSetting('max_length', 128)
      ->setRequired(TRUE)
      ->setReadOnly(TRUE)
      ->setDefaultValue(DefaultWorkspaceProvider::getId())
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE);

    $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 function getProvider(): WorkspaceProviderInterface {
    /** @var \Drupal\workspaces\Provider\WorkspaceProviderCollector $provider_collector */
    $provider_collector = \Drupal::service(WorkspaceProviderCollector::class);
    return $provider_collector->getProvider($this->get('provider')->value);
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE): void {
    parent::postSave($storage, $update);

    // When a new workspace has been saved, we need to copy all the associations
    // of its parent.
    if (!$update && $this->hasParent()) {
      \Drupal::service('workspaces.tracker')->initializeWorkspace($this);
    }
    \Drupal::service('workspaces.repository')->resetCache();
  }

  /**
   * {@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);

    /** @var \Drupal\workspaces\WorkspaceManagerInterface $workspace_manager */
    $workspace_manager = \Drupal::service('workspaces.manager');
    /** @var \Drupal\workspaces\WorkspaceTrackerInterface $workspace_tracker */
    $workspace_tracker = \Drupal::service('workspaces.tracker');

    // Gather the list of deleted workspace IDs, since the passed-in array is
    // not required to be keyed by them.
    $workspaces_ids = array_map(fn($entity) => $entity->id(), $entities);

    // Disable the currently active workspace if it has been deleted.
    if ($workspace_manager->hasActiveWorkspace()
      && in_array($workspace_manager->getActiveWorkspace()->id(), $workspaces_ids, TRUE)
    ) {
      $workspace_manager->switchToLive();
    }

    // Non-empty workspaces will have to go through the revision purging process
    // from \Drupal\workspaces\Hook\WorkspacesHooks::cron().
    $workspace_ids_to_purge = [];
    foreach ($workspaces_ids as $workspace_id) {
      if ($workspace_tracker->getTrackedEntities($workspace_id)) {
        $workspace_ids_to_purge[$workspace_id] = $workspace_id;
      }
    }
    if ($workspace_ids_to_purge) {
      $state = \Drupal::state();
      $deleted_workspace_ids = $state->get('workspace.deleted', []);
      $state->set('workspace.deleted', $deleted_workspace_ids + $workspace_ids_to_purge);

      // Trigger a batch purge to allow workspaces with few revisions to be
      // deleted immediately.
      // @todo This is temporary until batch purging is converted to use queues.
      // @see https://www.drupal.org/i/3553654
      \Drupal::service(WorkspacesHooks::class)->cron();
    }
  }

}