You are here

Home » API reference » Workspace 8 » Toolbar.php

class Toolbar in Workspace 8

Service for hooks and utilities related to Toolbar integration.

Hierarchy

Expanded class hierarchy of Toolbar

1 string reference to 'Toolbar'
workspace.services.yml in ./workspace.services.yml
workspace.services.yml
1 service uses Toolbar
workspace.toolbar in ./workspace.services.yml
Drupal\workspace\Toolbar

File

src/Toolbar.php, line 22

Namespace

Drupal\workspace
View source 
class Toolbar {
  use StringTranslationTrait;
  use MessengerTrait;

  /**
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * @var \Drupal\multiversion\Workspace\WorkspaceManagerInterface
   */
  protected $workspaceManager;

  /**
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * Constructs a new Toolbar.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   * @param \Drupal\multiversion\Workspace\WorkspaceManagerInterface $workspace_manager
   *   The workspace manager service.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder service.
   * @param AccountInterface $current_user
   *   The current user service.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, WorkspaceManagerInterface $workspace_manager, FormBuilderInterface $form_builder, AccountInterface $current_user) {
    $this->entityTypeManager = $entity_type_manager;
    $this->workspaceManager = $workspace_manager;
    $this->formBuilder = $form_builder;
    $this->currentUser = $current_user;
  }

  /**
   * Hook bridge;  Responds to hook_toolbar().
   *
   * @see hook_toolbar().
   */
  public function toolbar() {
    $items = [];
    $active = $this->workspaceManager
      ->getActiveWorkspace();
    $user = \Drupal::currentUser();
    $access = $user
      ->hasPermission('view_any_workspace');
    if ($access) {
      $items['changes'] = [
        '#type' => 'toolbar_item',
        '#weight' => 130,
        'tab' => [
          '#type' => 'link',
          '#title' => $this
            ->t('Changes'),
          '#url' => Url::fromRoute('entity.workspace.changes', [
            'workspace' => $active
              ->id(),
          ]),
          '#attributes' => [
            'title' => $this
              ->t('View changes on the current workspace'),
            'class' => [
              'toolbar-icon',
              'toolbar-icon-changes',
            ],
          ],
        ],
        '#wrapper_attributes' => [
          'class' => [
            'workspace-toolbar-tab',
          ],
        ],
        '#attached' => [
          'library' => [
            'workspace/drupal.workspace.toolbar',
          ],
        ],
      ];
    }
    $items['workspace_switcher'] = [
      // Include the toolbar_tab_wrapper to style the link like a toolbar tab.
      // Exclude the theme wrapper if custom styling is desired.
      '#type' => 'toolbar_item',
      '#weight' => 125,
      '#wrapper_attributes' => [
        'class' => [
          'workspace-toolbar-tab',
        ],
      ],
      '#attached' => [
        'library' => [
          'workspace/drupal.workspace.toolbar',
        ],
      ],
    ];
    $items['workspace_switcher']['tab'] = [
      '#type' => 'link',
      '#title' => $this
        ->t('@active', [
        '@active' => $active
          ->label(),
      ]),
      '#url' => Url::fromRoute('entity.workspace.collection'),
      '#attributes' => [
        'title' => $this
          ->t('Switch workspaces'),
        'class' => [
          'toolbar-icon',
          'toolbar-icon-workspace',
        ],
      ],
    ];
    $create_link = [
      '#type' => 'link',
      '#title' => t('Add workspace'),
      '#url' => Url::fromRoute('entity.workspace.add'),
      '#options' => [
        'attributes' => [
          'class' => [
            'add-workspace',
          ],
        ],
      ],
    ];
    $items['workspace_switcher']['tray'] = [
      '#heading' => $this
        ->t('Switch to workspace'),
      '#pre_render' => [
        'workspace.toolbar:preRenderWorkspaceSwitcherForms',
      ],
      // This wil get filled in via pre-render.
      'workspace_forms' => [],
      'create_link' => $create_link,
      '#cache' => [
        'contexts' => $this->entityTypeManager
          ->getDefinition('workspace')
          ->getListCacheContexts(),
        'tags' => $this->entityTypeManager
          ->getDefinition('workspace')
          ->getListCacheTags(),
      ],
      '#attributes' => [
        'class' => [
          'toolbar-menu',
        ],
      ],
    ];
    $last_replication_failed = \Drupal::state()
      ->get('workspace.last_replication_failed', FALSE);
    $update_access = $user
      ->hasPermission('update any workspace from upstream');
    $has_upstream = isset($active->upstream) && !$active->upstream
      ->isEmpty();
    if ($has_upstream) {
      $update_in_queue = $this->entityTypeManager
        ->getStorage('replication')
        ->getQuery()
        ->condition('source', $active->upstream->target_id)
        ->condition('target', WorkspacePointer::loadFromWorkspace($active)
        ->id())
        ->condition('replication_status', [
        Replication::QUEUED,
        Replication::REPLICATING,
      ], 'IN')
        ->execute();
      if (!empty($update_in_queue)) {
        $this
          ->messenger()
          ->addWarning(t('Users are only allowed to create one push and one pull deployment between the same source and target workspace. New deployments are only allowed after the currently queued deployment finish.'));
      }
    }
    if ($update_access && $has_upstream && !$last_replication_failed && empty($update_in_queue)) {
      $items['workspace_update'] = [
        '#type' => 'toolbar_item',
        '#weight' => 124,
        'tab' => [
          '#type' => 'link',
          '#title' => t('Update'),
          '#url' => Url::fromRoute('workspace.update.form'),
          '#attributes' => [
            'title' => t('Update current workspace from upstream'),
            'class' => [
              'toolbar-icon',
              'toolbar-icon-workspace-update',
              'use-ajax',
            ],
            'data-dialog-type' => 'modal',
            'data-dialog-options' => json_encode([
              'width' => '50%',
            ]),
          ],
        ],
        '#wrapper_attributes' => [
          'class' => [
            'workspace-update-toolbar-tab',
          ],
        ],
        '#attached' => [
          'library' => [
            'workspace/drupal.workspace.toolbar',
          ],
        ],
      ];
    }
    return $items;
  }

  /**
   * Prerender callback; Adds the workspace switcher forms to the render array.
   *
   * @param array $element
   *
   * @return array
   *   The modified $element.
   */
  public function preRenderWorkspaceSwitcherForms(array $element) {
    foreach ($this
      ->allWorkspaces() as $workspace) {
      $element['workspace_forms']['workspace_' . $workspace
        ->getMachineName()] = $this->formBuilder
        ->getForm(WorkspaceSwitcherForm::class, $workspace);
    }
    return $element;
  }

  /**
   * Returns a list of all defined and accessible workspaces.
   *
   * Note: This assumes that the total number of workspaces on the site is
   * very small.  If it's actually large this method will have memory issues.
   *
   * @return WorkspaceInterface[]
   */
  protected function allWorkspaces() {
    return array_filter($this->entityTypeManager
      ->getStorage('workspace')
      ->loadMultiple(), function (WorkspaceInterface $workspace) {
      return $workspace
        ->isPublished() && !$workspace
        ->getQueuedForDelete() && $workspace
        ->access('view', $this->currentUser);
    });
  }

}

Members

Namesort descending Modifiers Type Description Overrides
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
Toolbar::$currentUser protected property
Toolbar::$entityTypeManager protected property
Toolbar::$formBuilder protected property
Toolbar::$workspaceManager protected property
Toolbar::allWorkspaces protected function Returns a list of all defined and accessible workspaces.
Toolbar::preRenderWorkspaceSwitcherForms public function Prerender callback; Adds the workspace switcher forms to the render array.
Toolbar::toolbar public function Hook bridge; Responds to hook_toolbar().
Toolbar::__construct public function Constructs a new Toolbar.