Add ContextHandler::applyRuntimeContext()

Created on 14 May 2017, about 7 years ago

Updated 30 January 2023, over 1 year ago

Problem/Motivation

ContextHandler and LazyContextRepository were written separately, but are always used together.
The existing pattern is this:

if ($plugin instanceof ContextAwarePluginInterface) {
  $contexts = \Drupal::service('context.repository')->getRuntimeContexts(array_values($plugin->getContextMapping()));
  \Drupal::service('context.handler')->applyContextMapping($plugin, $contexts);
}

This is done in every usage of ContextHandler::applyContextMapping in core, and every one I've seen in contrib.

Proposed resolution

Add a ContextHandler::applyRuntimeContext() method to encapsulate this.
It becomes a lot more clear how to get contexts into your plugins this way.

Remaining tasks

Change record, possibly?

User interface changes

N/A

API changes

ContextHandlerInterface is expanded, but this is a complex service with very specific logic that was adapted straight from CTools. There is little reason to swap out this service, and even less reason to bypass subclassing ContextHandler.

Data model changes

N/A

📌 Task

Status

Needs work

Version

10.1 ✨

Component

Plugin →

Last updated about 15 hours ago

Maintained by
🇺🇸United States @EclipseGc
🇺🇸United States @effulgentsia
🇺🇸United States @tim.plunkett

Created by

🇺🇸United States tim.plunkett Philadelphia

Live updates comments and jobs are added and updated live.

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment over 1 year ago →
needs-review-queue-bot
The Needs Review Queue Bot → tested this issue. It either no longer applies to Drupal core, or fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.
Open in Jenkins → Open on Drupal.org →
Environment: PHP 8.1 & MySQL 5.7
last update about 1 year ago
Patch Failed to Apply

contrib.social Blog FAQ Discussions

Production build 0.69.0 2024