CodeExplorer
You are a developer and looking for Shopware projects?
Apply Now!
getTrackedEntities example
public function publish() {
if ($this->sourceWorkspace->hasParent()) {
throw new WorkspacePublishException('Only top-level workspaces can be published.');
}
if ($this->checkConflictsOnTarget()) {
throw new WorkspaceConflictException();
}
$tracked_entities = $this->workspaceAssociation->getTrackedEntities($this->sourceWorkspace->id());
$event = new WorkspacePrePublishEvent($this->sourceWorkspace, $tracked_entities);
$this->eventDispatcher->dispatch($event);
if ($event->isPublishingStopped()) {
throw new WorkspacePublishException((string) $event->getPublishingStoppedReason());
}
try {
$transaction = $this->database->startTransaction();
// @todo Handle the publishing of a workspace with a batch operation in // https://www.drupal.org/node/2958752.
protected function assertWorkspaceAssociation(array $expected, $entity_type_id) {
/** @var \Drupal\workspaces\WorkspaceAssociationInterface $workspace_association */
$workspace_association = \Drupal::service('workspaces.association');
foreach ($expected as $workspace_id => $expected_tracked_revision_ids) {
$tracked_entities = $workspace_association->getTrackedEntities($workspace_id, $entity_type_id);
$tracked_revision_ids = $tracked_entities[$entity_type_id] ?? [];
$this->assertEquals($expected_tracked_revision_ids, array_keys($tracked_revision_ids));
}
}
/** * Returns all the revisions which are not associated with any workspace. * * @param string $entity_type_id * An entity type ID to find revisions for. * @param int[]|string[]|null $entity_ids * (optional) An array of entity IDs to filter the results by. Defaults to * NULL. * * @return array * An array of entity IDs, keyed by revision IDs. */
$this->assertCount(2, $initial_revisions);
for ($i = 0; $i < 4; $i++) {
$workspace_1_node_1->setNewRevision(TRUE);
$workspace_1_node_1->save();
$workspace_1_node_2->setNewRevision(TRUE);
$workspace_1_node_2->save();
}
// The workspace should now track 2 nodes. $tracked_entities = $workspace_association->getTrackedEntities($workspace_1->id());
$this->assertCount(2, $tracked_entities['node']);
// Since all the revisions were created inside a workspace, including the // default one, 'workspace_1' should be tracking all 10 revisions. $associated_revisions = $workspace_association->getAssociatedRevisions($workspace_1->id(), 'node');
$this->assertCount(10, $associated_revisions);
// Check that we are allowed to delete the workspace. $this->assertTrue($workspace_1->access('delete', $admin));
// Delete the workspace and check that all the workspace_association
for ($i = 0; $i < 4; $i++) {
$workspace_1_node_1->setNewRevision(TRUE);
$workspace_1_node_1->save();
$workspace_1_node_2->setNewRevision(TRUE);
$workspace_1_node_2->save();
}
// The workspace should now track 2 nodes. $tracked_entities = $workspace_association->getTrackedEntities($workspace_1->id());
$this->assertCount(2, $tracked_entities['node']);
// Since all the revisions were created inside a workspace, including the // default one, 'workspace_1' should be tracking all 10 revisions. $associated_revisions = $workspace_association->getAssociatedRevisions($workspace_1->id(), 'node');
$this->assertCount(10, $associated_revisions);
// Check that we are allowed to delete the workspace. $this->assertTrue($workspace_1->access('delete', $admin));
// Delete the workspace and check that all the workspace_association
// Nothing to do for now, we can not get to a conflicting state because an
// entity which is being edited in a workspace can not be edited in any
// other workspace.
}
/** * {@inheritdoc} */
public function getDifferringRevisionIdsOnTarget() {
$target_revision_difference = [];
$tracked_entities_on_source = $this->workspaceAssociation->getTrackedEntities($this->sourceWorkspace->id());
$tracked_entities_on_target = $this->workspaceAssociation->getTrackedEntities($this->targetWorkspace->id());
foreach ($tracked_entities_on_target as $entity_type_id => $tracked_revisions) {
// Now we compare the revision IDs which are tracked by the target // workspace to those that are tracked by the source workspace, and the // difference between these two arrays gives us all the entities which // have a different revision ID on the target. if (!isset($tracked_entities_on_source[$entity_type_id])) {
$target_revision_difference[$entity_type_id] = $tracked_revisions;
}
elseif ($revision_difference = array_diff_key($tracked_revisions, $tracked_entities_on_source[$entity_type_id])) {
$target_revision_difference[$entity_type_id] = $revision_difference;
}
/** * {@inheritdoc} */
public function getDifferringRevisionIdsOnTarget() {
$target_revision_difference = [];
$tracked_entities_on_source = $this->workspaceAssociation->getTrackedEntities($this->sourceWorkspace->id());
$tracked_entities_on_target = $this->workspaceAssociation->getTrackedEntities($this->targetWorkspace->id());
foreach ($tracked_entities_on_target as $entity_type_id => $tracked_revisions) {
// Now we compare the revision IDs which are tracked by the target // workspace to those that are tracked by the source workspace, and the // difference between these two arrays gives us all the entities which // have a different revision ID on the target. if (!isset($tracked_entities_on_source[$entity_type_id])) {
$target_revision_difference[$entity_type_id] = $tracked_revisions;
}
elseif ($revision_difference = array_diff_key($tracked_revisions, $tracked_entities_on_source[$entity_type_id])) {
$target_revision_difference[$entity_type_id] = $revision_difference;
}
$workspace_tree = $this->workspaceRepository->loadTree();
if (!empty($workspace_tree[$this->entity->id()]['descendants'])) {
$form['description']['#markup'] = $this->t('The %label workspace can not be deleted because it has child workspaces.', [
'%label' => $this->entity->label(),
]);
$form['actions']['submit']['#disabled'] = TRUE;
return $form;
}
$tracked_entities = $this->workspaceAssociation->getTrackedEntities($this->entity->id());
$items = [];
foreach ($tracked_entities as $entity_type_id => $entity_ids) {
$revision_ids = $this->workspaceAssociation->getAssociatedRevisions($this->entity->id(), $entity_type_id, $entity_ids);
$label = $this->entityTypeManager->getDefinition($entity_type_id)->getLabel();
$items[] = $this->formatPlural(count($revision_ids), '1 @label revision.', '@count @label revisions.', ['@label' => $label]);
}
$form['revisions'] = [
'#theme' => 'item_list',
'#title' => $this->t('The following will also be deleted:'),
'#items' => $items,
];
if (!empty($workspace_tree[$this->entity->id()]['descendants'])) {
$form['description']['#markup'] = $this->t('The %label workspace can not be deleted because it has child workspaces.', [
'%label' => $this->entity->label(),
]);
$form['actions']['submit']['#disabled'] = TRUE;
return $form;
}
$tracked_entities = $this->workspaceAssociation->getTrackedEntities($this->entity->id());
$items = [];
foreach ($tracked_entities as $entity_type_id => $entity_ids) {
$revision_ids = $this->workspaceAssociation->getAssociatedRevisions($this->entity->id(), $entity_type_id, $entity_ids);
$label = $this->entityTypeManager->getDefinition($entity_type_id)->getLabel();
$items[] = $this->formatPlural(count($revision_ids), '1 @label revision.', '@count @label revisions.', ['@label' => $label]);
}
$form['revisions'] = [
'#theme' => 'item_list',
'#title' => $this->t('The following will also be deleted:'),
'#items' => $items,
];
}
/** * {@inheritdoc} */
public function trackEntity(RevisionableInterface $entity, WorkspaceInterface $workspace) {
// Determine all workspaces that might be affected by this change. $affected_workspaces = $this->workspaceRepository->getDescendantsAndSelf($workspace->id());
// Get the currently tracked revision for this workspace. $tracked = $this->getTrackedEntities($workspace->id(), $entity->getEntityTypeId(), [$entity->id()]);
$tracked_revision_id = NULL;
if (isset($tracked[$entity->getEntityTypeId()])) {
$tracked_revision_id = key($tracked[$entity->getEntityTypeId()]);
}
try {
$transaction = $this->database->startTransaction();
// Update all affected workspaces that were tracking the current revision. // This means they are inheriting content and should be updated. if ($tracked_revision_id) {
$entities = [];
// Only run if the entity type can belong to a workspace and we are in a // non-default workspace. if (!$this->workspaceManager->shouldAlterOperations($this->entityTypeManager->getDefinition($entity_type_id))) {
return $entities;
}
// Get a list of revision IDs for entities that have a revision set for the // current active workspace. If an entity has multiple revisions set for a // workspace, only the one with the highest ID is returned. if ($tracked_entities = $this->workspaceAssociation->getTrackedEntities($this->workspaceManager->getActiveWorkspace()->id(), $entity_type_id, $ids)) {
/** @var \Drupal\Core\Entity\RevisionableStorageInterface $storage */
$storage = $this->entityTypeManager->getStorage($entity_type_id);
// Swap out every entity which has a revision set for the current active // workspace. foreach ($storage->loadMultipleRevisions(array_keys($tracked_entities[$entity_type_id])) as $revision) {
$entities[$revision->id()] = $revision;
}
}
return $entities;
}
// Only run if the entity type can belong to a workspace and we are in a // non-default workspace. if (!$this->workspaceManager->shouldAlterOperations($this->entityTypeManager->getDefinition($entity_type_id))) {
return $entities;
}
// Get a list of revision IDs for entities that have a revision set for the // current active workspace. If an entity has multiple revisions set for a // workspace, only the one with the highest ID is returned. if ($tracked_entities = $this->workspaceAssociation->getTrackedEntities($this->workspaceManager->getActiveWorkspace()->id(), $entity_type_id, $ids)) {
/** @var \Drupal\Core\Entity\RevisionableStorageInterface $storage */
$storage = $this->entityTypeManager->getStorage($entity_type_id);
// Swap out every entity which has a revision set for the current active // workspace. foreach ($storage->loadMultipleRevisions(array_keys($tracked_entities[$entity_type_id])) as $revision) {
$entities[$revision->id()] = $revision;
}
}
return $entities;
}
/**
* Prevents a workspace from being published based on certain conditions.
*
* @param \Drupal\workspaces\Event\WorkspacePublishEvent $event
* The workspace publish event.
*/
public function onWorkspacePrePublish(WorkspacePublishEvent $event): void {
// Prevent a workspace from being published if there are any pending // revisions in a moderation state that doesn't create default revisions. $workspace = $event->getWorkspace();
$tracked_revisions = $this->workspaceAssociation->getTrackedEntities($workspace->id());
// Extract all the second-level keys (revision IDs) of the two-dimensional // array. $tracked_revision_ids = array_reduce(array_map('array_keys', $tracked_revisions), 'array_merge', []);
// Gather a list of moderation states that don't create a default revision. $workflow_non_default_states = [];
foreach ($this->entityTypeManager->getStorage('workflow')->loadByProperties(['type' => 'content_moderation']) as $workflow) {
/** @var \Drupal\content_moderation\Plugin\WorkflowType\ContentModerationInterface $workflow_type */
$workflow_type = $workflow->getTypePlugin();
// Find all workflows which are moderating entity types of the same type // to those that are tracked by the workspace.
public function onWorkspacePrePublish(WorkspacePublishEvent $event): void {
// Prevent a workspace from being published if there are any pending // revisions in a moderation state that doesn't create default revisions. $workspace = $event->getWorkspace();
$tracked_revisions = $this->workspaceAssociation->getTrackedEntities($workspace->id());
// Extract all the second-level keys (revision IDs) of the two-dimensional // array. $tracked_revision_ids = array_reduce(array_map('array_keys', $tracked_revisions), 'array_merge', []);
// Gather a list of moderation states that don't create a default revision. $workflow_non_default_states = [];
foreach ($this->entityTypeManager->getStorage('workflow')->loadByProperties(['type' => 'content_moderation']) as $workflow) {
/** @var \Drupal\content_moderation\Plugin\WorkflowType\ContentModerationInterface $workflow_type */
$workflow_type = $workflow->getTypePlugin();
// Find all workflows which are moderating entity types of the same type // to those that are tracked by the workspace.
parent::buildComponents($build, $entities, $displays, $view_mode);
$bundle_info = $this->bundleInfo->getAllBundleInfo();
$header = [
'title' => $this->t('Title'),
'type' => $this->t('Type'),
'changed' => $this->t('Last changed'),
'owner' => $this->t('Author'),
'operations' => $this->t('Operations'),
];
foreach ($entities as $build_id => $entity) {
$all_tracked_entities = $this->workspaceAssociation->getTrackedEntities($entity->id());
$build[$build_id]['changes']['overview'] = [
'#type' => 'item',
'#title' => $this->t('Workspace changes'),
];
$build[$build_id]['changes']['list'] = [
'#type' => 'table',
'#header' => $header,
'#empty' => $this->t('This workspace has no changes.'),
];
$bundle_info = $this->bundleInfo->getAllBundleInfo();
$header = [
'title' => $this->t('Title'),
'type' => $this->t('Type'),
'changed' => $this->t('Last changed'),
'owner' => $this->t('Author'),
'operations' => $this->t('Operations'),
];
foreach ($entities as $build_id => $entity) {
$all_tracked_entities = $this->workspaceAssociation->getTrackedEntities($entity->id());
$build[$build_id]['changes']['overview'] = [
'#type' => 'item',
'#title' => $this->t('Workspace changes'),
];
$build[$build_id]['changes']['list'] = [
'#type' => 'table',
'#header' => $header,
'#empty' => $this->t('This workspace has no changes.'),
];
return parent::loadTreeData($menu_name, $parameters);
}
/** * {@inheritdoc} */
protected function loadLinks($menu_name, MenuTreeParameters $parameters) {
$links = parent::loadLinks($menu_name, $parameters);
// Replace the menu link plugin definitions with workspace-specific ones. if ($active_workspace = $this->workspaceManager->getActiveWorkspace()) {
$tracked_revisions = $this->workspaceAssociation->getTrackedEntities($active_workspace->id());
if (isset($tracked_revisions['menu_link_content'])) {
/** @var \Drupal\menu_link_content\MenuLinkContentInterface[] $workspace_revisions */
$workspace_revisions = $this->entityTypeManager->getStorage('menu_link_content')->loadMultipleRevisions(array_keys($tracked_revisions['menu_link_content']));
foreach ($workspace_revisions as $workspace_revision) {
if (isset($links[$workspace_revision->getPluginId()])) {
$pending_plugin_definition = $workspace_revision->getPluginDefinition();
$links[$workspace_revision->getPluginId()] = [
'title' => serialize($pending_plugin_definition['title']),
'description' => serialize($pending_plugin_definition['description']),
'enabled' => (string) $pending_plugin_definition['enabled'],
'url' => $pending_plugin_definition['url'],
}
/** * {@inheritdoc} */
protected function loadLinks($menu_name, MenuTreeParameters $parameters) {
$links = parent::loadLinks($menu_name, $parameters);
// Replace the menu link plugin definitions with workspace-specific ones. if ($active_workspace = $this->workspaceManager->getActiveWorkspace()) {
$tracked_revisions = $this->workspaceAssociation->getTrackedEntities($active_workspace->id());
if (isset($tracked_revisions['menu_link_content'])) {
/** @var \Drupal\menu_link_content\MenuLinkContentInterface[] $workspace_revisions */
$workspace_revisions = $this->entityTypeManager->getStorage('menu_link_content')->loadMultipleRevisions(array_keys($tracked_revisions['menu_link_content']));
foreach ($workspace_revisions as $workspace_revision) {
if (isset($links[$workspace_revision->getPluginId()])) {
$pending_plugin_definition = $workspace_revision->getPluginDefinition();
$links[$workspace_revision->getPluginId()] = [
'title' => serialize($pending_plugin_definition['title']),
'description' => serialize($pending_plugin_definition['description']),
'enabled' => (string) $pending_plugin_definition['enabled'],
'url' => $pending_plugin_definition['url'],
protected function assertWorkspaceAssociations($entity_type_id, array $expected_latest_revisions, array $expected_all_revisions, array $expected_initial_revisions) {
$workspace_association = \Drupal::service('workspaces.association');
foreach ($expected_latest_revisions as $workspace_id => $expected_tracked_revision_ids) {
$tracked_entities = $workspace_association->getTrackedEntities($workspace_id, $entity_type_id);
$tracked_revision_ids = $tracked_entities[$entity_type_id] ?? [];
$this->assertEquals($expected_tracked_revision_ids, array_keys($tracked_revision_ids));
}
foreach ($expected_all_revisions as $workspace_id => $expected_all_revision_ids) {
$all_associated_revisions = $workspace_association->getAssociatedRevisions($workspace_id, $entity_type_id);
$this->assertEquals($expected_all_revision_ids, array_keys($all_associated_revisions));
}
foreach ($expected_initial_revisions as $workspace_id => $expected_initial_revision_ids) {
$initial_revisions = $workspace_association->getAssociatedInitialRevisions($workspace_id, $entity_type_id);