EditTab.php in Workbench Moderation 8

Namespace

Drupal\workbench_moderation\Plugin\Menu

File

src/Plugin/Menu/EditTab.php

<?php

namespace Drupal\workbench_moderation\Plugin\Menu;

use Drupal\Core\Menu\LocalTaskDefault;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Core\StringTranslation\TranslationInterface;
use Drupal\workbench_moderation\ModerationInformation;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * Defines a class for making the edit tab use 'Edit draft' or 'New draft'.
 */
class EditTab extends LocalTaskDefault implements ContainerFactoryPluginInterface {
  use StringTranslationTrait;

  /**
   * The moderatio information service.
   *
   * @var \Drupal\workbench_moderation\ModerationInformation
   */
  protected $moderationInfo;

  /**
   * The entity.
   *
   * @var \Drupal\Core\Entity\ContentEntityInterface
   */
  protected $entity;

  /**
   * Constructs a new EditTab object.
   *
   * @param array $configuration
   *   Plugin configuration.
   * @param string $plugin_id
   *   Plugin ID.
   * @param mixed $plugin_definition
   *   Plugin definition.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The translation service.
   * @param \Drupal\workbench_moderation\ModerationInformation $moderation_information
   *   The moderation information.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, TranslationInterface $string_translation, ModerationInformation $moderation_information) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->stringTranslation = $string_translation;
    $this->moderationInfo = $moderation_information;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('string_translation'), $container
      ->get('workbench_moderation.moderation_information'));
  }

  /**
   * {@inheritdoc}
   */
  public function getRouteParameters(RouteMatchInterface $route_match) {

    // Override the node here with the latest revision.
    $this->entity = $route_match
      ->getParameter($this->pluginDefinition['entity_type_id']);
    return parent::getRouteParameters($route_match);
  }

  /**
   * {@inheritdoc}
   */
  public function getTitle(Request $request = NULL) {
    if (!$this->moderationInfo
      ->isModeratableEntity($this->entity)) {

      // Moderation isn't enabled.
      return parent::getTitle($request);
    }

    // @todo write a test for this.
    return $this->moderationInfo
      ->isLiveRevision($this->entity) ? $this
      ->t('New draft') : $this
      ->t('Edit draft');
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {

    // @todo write a test for this.
    $tags = parent::getCacheTags();

    // Tab changes if node or node-type is modified.
    $tags = array_merge($tags, $this->entity
      ->getCacheTags());
    $tags[] = $this->entity
      ->getEntityType()
      ->getBundleEntityType() . ':' . $this->entity
      ->bundle();
    return $tags;
  }

}

Classes

Name	Description
EditTab	Defines a class for making the edit tab use 'Edit draft' or 'New draft'.