Issue #2273381 by clayfreeman, tim.plunkett, andypost, dawehner, EclipseGc,... (bc0cbe87) · Commits · project / drupal

core/lib/Drupal/Component/Plugin/ContextAwarePluginBase.php

+3 −0

Original line number	Diff line number	Diff line
		@@ -42,6 +42,9 @@ public function __construct(array $configuration, $plugin_id, $plugin_definition

		parent::__construct($configuration, $plugin_id, $plugin_definition);

		if ($context_configuration) {
		@trigger_error('Passing context values to plugins via configuration is deprecated in drupal:9.1.0 and will be removed before drupal:10.0.0. Instead, call ::setContextValue() on the plugin itself. See https://www.drupal.org/node/3120980', E_USER_DEPRECATED);
		}
		$this->context = $this->createContextFromConfiguration($context_configuration);
		}

core/lib/Drupal/Core/Block/BlockBase.php

+5 −2

Original line number	Diff line number	Diff line
		@@ -3,7 +3,9 @@
		namespace Drupal\Core\Block;

		use Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait;
		use Drupal\Core\Plugin\ContextAwarePluginBase;
		use Drupal\Core\Plugin\ContextAwarePluginInterface;
		use Drupal\Core\Plugin\ContextAwarePluginTrait;
		use Drupal\Core\Plugin\PluginBase;
		use Drupal\Core\Plugin\PluginWithFormsInterface;
		use Drupal\Core\Render\PreviewFallbackInterface;

		@@ -16,9 +18,10 @@
		*
		* @ingroup block_api
		*/
		abstract class BlockBase extends ContextAwarePluginBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface {
		abstract class BlockBase extends PluginBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface, ContextAwarePluginInterface {

		use BlockPluginTrait;
		use ContextAwarePluginTrait;
		use ContextAwarePluginAssignmentTrait;

		}

core/lib/Drupal/Core/Condition/ConditionManager.php

+1 −0

Original line number	Diff line number	Diff line
		@@ -60,6 +60,7 @@ public function createInstance($plugin_id, array $configuration = []) {

		// If we receive any context values via config set it into the plugin.
		if (!empty($configuration['context'])) {
		@trigger_error('Passing context values to plugins via configuration is deprecated in drupal:9.1.0 and will be removed before drupal:10.0.0. Instead, call ::setContextValue() on the plugin itself. See https://www.drupal.org/node/3120980', E_USER_DEPRECATED);
		foreach ($configuration['context'] as $name => $context) {
		$plugin->setContextValue($name, $context);
		}

core/lib/Drupal/Core/Executable/ExecutablePluginBase.php

+7 −2

Original line number	Diff line number	Diff line
		@@ -2,13 +2,18 @@

		namespace Drupal\Core\Executable;

		use Drupal\Core\Plugin\ContextAwarePluginBase;
		use Drupal\Component\Plugin\Exception\PluginException;
		use Drupal\Core\Cache\CacheableDependencyInterface;
		use Drupal\Core\Plugin\ContextAwarePluginInterface;
		use Drupal\Core\Plugin\ContextAwarePluginTrait;
		use Drupal\Core\Plugin\PluginBase;

		/**
		* Provides the basic architecture for executable plugins.
		*/
		abstract class ExecutablePluginBase extends ContextAwarePluginBase implements ExecutableInterface {
		abstract class ExecutablePluginBase extends PluginBase implements ExecutableInterface, CacheableDependencyInterface, ContextAwarePluginInterface {

		use ContextAwarePluginTrait;

		/**
		* Gets an array of definitions of available configuration options.

core/lib/Drupal/Core/Plugin/ContextAwarePluginBase.php

+4 −140

Original line number	Diff line number	Diff line
		@@ -3,21 +3,20 @@
		namespace Drupal\Core\Plugin;

		use Drupal\Component\Plugin\ContextAwarePluginBase as ComponentContextAwarePluginBase;
		use Drupal\Component\Plugin\Exception\ContextException;
		use Drupal\Component\Plugin\PluginHelper;
		use Drupal\Core\Cache\Cache;
		use Drupal\Core\Cache\CacheableDependencyInterface;
		use Drupal\Core\DependencyInjection\DependencySerializationTrait;
		use Drupal\Core\Plugin\Context\Context;
		use Drupal\Core\StringTranslation\StringTranslationTrait;
		use Drupal\Core\TypedData\TypedDataTrait;
		use Drupal\Component\Plugin\Context\ContextInterface as ComponentContextInterface;
		use Drupal\Core\Plugin\Context\ContextInterface;

		@trigger_error(__NAMESPACE__ . '\ContextAwarePluginBase is deprecated in drupal:9.1.0 and will be removed before drupal:10.0.0. Instead, use \Drupal\Core\Plugin\ContextAwarePluginTrait. See https://www.drupal.org/node/3120980', E_USER_DEPRECATED);

		/**
		* Base class for plugins that are context aware.
		*/
		abstract class ContextAwarePluginBase extends ComponentContextAwarePluginBase implements ContextAwarePluginInterface, CacheableDependencyInterface {

		use ContextAwarePluginTrait;
		use TypedDataTrait;
		use StringTranslationTrait;
		use DependencySerializationTrait;
		@@ -38,139 +37,4 @@ protected function createContextFromConfiguration(array $context_configuration)
		return $contexts;
		}

		/**
		* {@inheritdoc}
		*
		* This code is identical to the Component in order to pick up a different
		* Context class.
		*
		* @return \Drupal\Core\Plugin\Context\ContextInterface
		* The context object.
		*/
		public function getContext($name) {
		// Check for a valid context value.
		if (!isset($this->context[$name])) {
		$this->context[$name] = new Context($this->getContextDefinition($name));
		}
		return $this->context[$name];
		}

		/**
		* {@inheritdoc}
		*/
		public function setContext($name, ComponentContextInterface $context) {
		// Check that the context passed is an instance of our extended interface.
		if (!$context instanceof ContextInterface) {
		throw new ContextException("Passed $name context must be an instance of \\Drupal\\Core\\Plugin\\Context\\ContextInterface");
		}
		parent::setContext($name, $context);
		}

		/**
		* {@inheritdoc}
		*/
		public function setContextValue($name, $value) {
		$this->setContext($name, Context::createFromContext($this->getContext($name), $value));
		return $this;
		}

		/**
		* {@inheritdoc}
		*/
		public function getContextMapping() {
		$configuration = PluginHelper::isConfigurable($this) ? $this->getConfiguration() : $this->configuration;
		return isset($configuration['context_mapping']) ? $configuration['context_mapping'] : [];
		}

		/**
		* {@inheritdoc}
		*/
		public function setContextMapping(array $context_mapping) {
		if (PluginHelper::isConfigurable($this)) {
		$configuration = $this->getConfiguration();
		$configuration['context_mapping'] = array_filter($context_mapping);
		$this->setConfiguration($configuration);
		}
		else {
		$this->configuration['context_mapping'] = $context_mapping;
		}
		return $this;
		}

		/**
		* {@inheritdoc}
		*
		* @return \Drupal\Core\Plugin\Context\ContextDefinitionInterface[]
		*/
		public function getContextDefinitions() {
		return parent::getContextDefinitions();
		}

		/**
		* {@inheritdoc}
		*
		* @return \Drupal\Core\Plugin\Context\ContextDefinitionInterface
		*/
		public function getContextDefinition($name) {
		return parent::getContextDefinition($name);
		}

		/**
		* Wraps the context handler.
		*
		* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
		*/
		protected function contextHandler() {
		return \Drupal::service('context.handler');
		}

		/**
		* {@inheritdoc}
		*/
		public function getCacheContexts() {
		$cache_contexts = [];
		// Applied contexts can affect the cache contexts when this plugin is
		// involved in caching, collect and return them.
		foreach ($this->getContexts() as $context) {
		/** @var $context \Drupal\Core\Cache\CacheableDependencyInterface */
		if ($context instanceof CacheableDependencyInterface) {
		$cache_contexts = Cache::mergeContexts($cache_contexts, $context->getCacheContexts());
		}
		}
		return $cache_contexts;
		}

		/**
		* {@inheritdoc}
		*/
		public function getCacheTags() {
		$tags = [];
		// Applied contexts can affect the cache tags when this plugin is
		// involved in caching, collect and return them.
		foreach ($this->getContexts() as $context) {
		/** @var $context \Drupal\Core\Cache\CacheableDependencyInterface */
		if ($context instanceof CacheableDependencyInterface) {
		$tags = Cache::mergeTags($tags, $context->getCacheTags());
		}
		}
		return $tags;
		}

		/**
		* {@inheritdoc}
		*/
		public function getCacheMaxAge() {
		$max_age = Cache::PERMANENT;

		// Applied contexts can affect the cache max age when this plugin is
		// involved in caching, collect and return them.
		foreach ($this->getContexts() as $context) {
		/** @var $context \Drupal\Core\Cache\CacheableDependencyInterface */
		if ($context instanceof CacheableDependencyInterface) {
		$max_age = Cache::mergeMaxAges($max_age, $context->getCacheMaxAge());
		}
		}
		return $max_age;
		}

		}