class WorkspacesHooks

Hook implementations for workspaces.

Hierarchy

Expanded class hierarchy of WorkspacesHooks

File

core/modules/workspaces/src/Hook/WorkspacesHooks.php, line 20

Namespace

Drupal\workspaces\Hook
View source
class WorkspacesHooks {
  use StringTranslationTrait;
  public function __construct(protected WorkspaceManagerInterface $workspaceManager, protected WorkspaceInformationInterface $workspaceInfo, protected EntityDefinitionUpdateManagerInterface $entityDefinitionUpdateManager, protected CacheTagsInvalidatorInterface $cacheTagsInvalidator) {
  }
  
  /**
   * Implements hook_help().
   */
  public function help(string $route_name, RouteMatchInterface $route_match) : string {
    $output = '';
    switch ($route_name) {
      // Main module help for the Workspaces module.
      case 'help.page.workspaces':
        $output = '';
        $output .= '<h2>' . $this->t('About') . '</h2>';
        $output .= '<p>' . $this->t('The Workspaces module allows workspaces to be defined and switched between. Content is then assigned to the active workspace when created. For more information, see the <a href=":workspaces">online documentation for the Workspaces module</a>.', [
          ':workspaces' => 'https://www.drupal.org/docs/8/core/modules/workspace/overview',
        ]) . '</p>';
        break;

    }
    return $output;
  }
  
  /**
   * Implements hook_module_preinstall().
   */
  public function modulePreinstall(string $module) : void {
    if ($module !== 'workspaces') {
      return;
    }
    foreach ($this->entityDefinitionUpdateManager
      ->getEntityTypes() as $entity_type) {
      if ($this->workspaceInfo
        ->isEntityTypeSupported($entity_type)) {
        $entity_type->setRevisionMetadataKey('workspace', 'workspace');
        $this->entityDefinitionUpdateManager
          ->updateEntityType($entity_type);
      }
    }
  }
  
  /**
   * Implements hook_ENTITY_TYPE_update() for 'menu_link_content' entities.
   */
  public function menuLinkContentUpdate(EntityInterface $entity) : void {
    /** @var \Drupal\menu_link_content\MenuLinkContentInterface $entity */
    if ($entity->getLoadedRevisionId() != $entity->getRevisionId()) {
      // We are not updating the menu tree definitions when a custom menu link
      // entity is saved as a pending revision (because the parent can not be
      // changed), so we need to clear the system menu cache manually. However,
      // inserting or deleting a custom menu link updates the menu tree
      // definitions, so we don't have to do anything in those cases.
      $cache_tags = Cache::buildTags('config:system.menu', [
        $entity->getMenuName(),
      ], '.');
      $this->cacheTagsInvalidator
        ->invalidateTags($cache_tags);
    }
  }
  
  /**
   * Implements hook_cron().
   */
  public function cron() : void {
    $this->workspaceManager
      ->purgeDeletedWorkspacesBatch();
  }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 1
WorkspacesHooks::cron public function Implements hook_cron().
WorkspacesHooks::help public function Implements hook_help().
WorkspacesHooks::menuLinkContentUpdate public function Implements hook_ENTITY_TYPE_update() for &#039;menu_link_content&#039; entities.
WorkspacesHooks::modulePreinstall public function Implements hook_module_preinstall().
WorkspacesHooks::__construct public function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.