class VocabularyContext in Context Breadcrumb 8

Sets the current taxonomy term as a context on taxonomy term routes.

Hierarchy

• class \Drupal\context_breadcrumb\ContextProvider\VocabularyContext implements ContextProviderInterface uses StringTranslationTrait

1 string reference to 'VocabularyContext'

context_breadcrumb.services.yml in ./context_breadcrumb.services.yml

context_breadcrumb.services.yml

1 service uses VocabularyContext

context_breadcrumb.vocabulary_context in ./context_breadcrumb.services.yml

Drupal\context_breadcrumb\ContextProvider\VocabularyContext

File

src/ContextProvider/VocabularyContext.php, line 17

Namespace

Drupal\context_breadcrumb\ContextProvider

class VocabularyContext implements ContextProviderInterface {
  use StringTranslationTrait;

  /**
   * The route match object.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Constructs a new TaxonomyTermRouteContext.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match object.
   */
  public function __construct(RouteMatchInterface $route_match) {
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  public function getRuntimeContexts(array $unqualified_context_ids) {
    $result = [];
    $context_definition = new EntityContextDefinition('entity:taxonomy_term', NULL, FALSE);
    $value = NULL;
    if (($route_object = $this->routeMatch
      ->getRouteObject()) && ($route_contexts = $route_object
      ->getOption('parameters')) && isset($route_contexts['taxonomy_term'])) {
      if ($taxonomy_term = $this->routeMatch
        ->getParameter('taxonomy_term')) {
        $value = $taxonomy_term;
      }
    }
    elseif ($this->routeMatch
      ->getRouteName() == 'entity.taxonomy_term.add_form') {
      $vocabulary = $this->routeMatch
        ->getParameter('taxonomy_vocabulary');
      $value = Term::create([
        'vid' => $vocabulary
          ->id(),
      ]);
    }
    $cacheability = new CacheableMetadata();
    $cacheability
      ->setCacheContexts([
      'route',
    ]);
    $context = new Context($context_definition, $value);
    $context
      ->addCacheableDependency($cacheability);
    $result['taxonomy_term'] = $context;
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function getAvailableContexts() {
    $context = new Context(new EntityContextDefinition('entity:taxonomy_term', $this
      ->t('Taxonomy Term from URL')));
    return [
      'taxonomy_term' => $context,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
VocabularyContext::$routeMatch	protected	property	The route match object.
VocabularyContext::getAvailableContexts	public	function	Gets all available contexts for the purposes of configuration. Overrides ContextProviderInterface::getAvailableContexts
VocabularyContext::getRuntimeContexts	public	function	Gets runtime context values for the given context IDs. Overrides ContextProviderInterface::getRuntimeContexts
VocabularyContext::__construct	public	function	Constructs a new TaxonomyTermRouteContext.