Issue #3153956 by clayfreeman, Spokje, andypost, longwave: Remove code related... (3b4a427f) · Commits · project / drupal

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

deleted100644 → 0

+0 −174

Original line number	Diff line number	Diff line
		<?php

		namespace Drupal\Component\Plugin;

		use Drupal\Component\Plugin\Context\ContextInterface;
		use Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface;
		use Drupal\Component\Plugin\Exception\ContextException;
		use Drupal\Component\Plugin\Context\Context;
		use Symfony\Component\Validator\ConstraintViolationList;

		@trigger_error(__NAMESPACE__ . '\ContextAwarePluginBase is deprecated in drupal:9.1.0 and is removed from drupal:10.0.0 without replacement. See https://www.drupal.org/node/3120980', E_USER_DEPRECATED);

		/**
		* Base class for plugins that are context aware.
		*
		* @deprecated in drupal:9.1.0 and is removed from drupal:10.0.0 without
		* replacement.
		*
		* @see https://www.drupal.org/node/3120980
		*/
		abstract class ContextAwarePluginBase extends PluginBase implements ContextAwarePluginInterface {

		/**
		* The data objects representing the context of this plugin.
		*
		* @var \Drupal\Component\Plugin\Context\ContextInterface[]
		*/
		protected $context = [];

		/**
		* Overrides \Drupal\Component\Plugin\PluginBase::__construct().
		*
		* Overrides the construction of context aware plugins to allow for
		* unvalidated constructor based injection of contexts.
		*
		* @param array $configuration
		* The plugin configuration, i.e. an array with configuration values keyed
		* by configuration option name. The special key 'context' may be used to
		* initialize the defined contexts by setting it to an array of context
		* values keyed by context names.
		* @param string $plugin_id
		* The plugin_id for the plugin instance.
		* @param mixed $plugin_definition
		* The plugin implementation definition.
		*/
		public function __construct(array $configuration, $plugin_id, $plugin_definition) {
		$context_configuration = $configuration['context'] ?? [];
		unset($configuration['context']);

		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);
		}

		/**
		* Creates context objects from any context mappings in configuration.
		*
		* @param array $context_configuration
		* An associative array of context names and values.
		*
		* @return \Drupal\Component\Plugin\Context\ContextInterface[]
		* An array of context objects.
		*/
		protected function createContextFromConfiguration(array $context_configuration) {
		$contexts = [];
		foreach ($context_configuration as $key => $value) {
		$context_definition = $this->getContextDefinition($key);
		$contexts[$key] = new Context($context_definition, $value);
		}
		return $contexts;
		}

		/**
		* {@inheritdoc}
		*/
		public function getContextDefinitions() {
		$definition = $this->getPluginDefinition();
		if ($definition instanceof ContextAwarePluginDefinitionInterface) {
		return $definition->getContextDefinitions();
		}
		else {
		return !empty($definition['context_definitions']) ? $definition['context_definitions'] : [];
		}
		}

		/**
		* {@inheritdoc}
		*/
		public function getContextDefinition($name) {
		$definition = $this->getPluginDefinition();
		if ($definition instanceof ContextAwarePluginDefinitionInterface) {
		if ($definition->hasContextDefinition($name)) {
		return $definition->getContextDefinition($name);
		}
		}
		elseif (!empty($definition['context_definitions'][$name])) {
		return $definition['context_definitions'][$name];
		}
		throw new ContextException(sprintf("The %s context is not a valid context.", $name));
		}

		/**
		* {@inheritdoc}
		*/
		public function getContexts() {
		// Make sure all context objects are initialized.
		foreach ($this->getContextDefinitions() as $name => $definition) {
		$this->getContext($name);
		}
		return $this->context;
		}

		/**
		* {@inheritdoc}
		*/
		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, ContextInterface $context) {
		$this->context[$name] = $context;
		}

		/**
		* {@inheritdoc}
		*/
		public function getContextValues() {
		$values = [];
		foreach ($this->getContextDefinitions() as $name => $definition) {
		$values[$name] = isset($this->context[$name]) ? $this->context[$name]->getContextValue() : NULL;
		}
		return $values;
		}

		/**
		* {@inheritdoc}
		*/
		public function getContextValue($name) {
		return $this->getContext($name)->getContextValue();
		}

		/**
		* {@inheritdoc}
		*/
		public function setContextValue($name, $value) {
		$this->context[$name] = new Context($this->getContextDefinition($name), $value);
		return $this;
		}

		/**
		* {@inheritdoc}
		*/
		public function validateContexts() {
		$violations = new ConstraintViolationList();
		// @todo: Implement symfony validator API to let the validator traverse
		// and set property paths accordingly.

		foreach ($this->getContexts() as $context) {
		$violations->addAll($context->validate());
		}
		return $violations;
		}

		}

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

deleted100644 → 0

+0 −40

Original line number	Diff line number	Diff line
		<?php

		namespace Drupal\Core\Plugin;

		use Drupal\Component\Plugin\ContextAwarePluginBase as ComponentContextAwarePluginBase;
		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;

		@trigger_error(__NAMESPACE__ . '\ContextAwarePluginBase is deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Use \Drupal\Core\Plugin\ContextAwarePluginTrait instead. 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;

		/**
		* {@inheritdoc}
		*
		* @return \Drupal\Core\Plugin\Context\ContextInterface[]
		*/
		protected function createContextFromConfiguration(array $context_configuration) {
		// This method is overridden so that it will use
		// \Drupal\Core\Plugin\Context\Context instead.
		$contexts = [];
		foreach ($context_configuration as $key => $value) {
		$context_definition = $this->getContextDefinition($key);
		$contexts[$key] = new Context($context_definition, $value);
		}
		return $contexts;
		}

		}

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

+0 −34

Original line number	Diff line number	Diff line
		@@ -28,18 +28,6 @@ trait ContextAwarePluginTrait {
		*/
		protected $context = [];

		/**
		* Tracks whether the context has been initialized from configuration.
		*
		* @var bool
		*
		* @todo Remove this in Drupal 10.0.x.
		* See https://www.drupal.org/project/drupal/issues/3153956.
		*
		* @internal
		*/
		protected $initializedContextConfig = FALSE;

		/**
		* {@inheritdoc}
		*/
		@@ -58,28 +46,6 @@ public function getContexts() {
		* The context object.
		*/
		public function getContext($name) {
		// @todo Remove this entire block in Drupal 10.0.x.
		// See https://www.drupal.org/project/drupal/issues/3153956.
		if (!$this->initializedContextConfig) {
		$this->initializedContextConfig = TRUE;
		if ($this instanceof ConfigurableInterface) {
		$configuration = $this->getConfiguration();
		}
		else {
		$reflection = new \ReflectionProperty($this, 'configuration');
		$reflection->setAccessible(TRUE);
		$configuration = $reflection->getValue($this);
		}

		if (isset($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 $key => $value) {
		$context_definition = $this->getContextDefinition($key);
		$this->context[$key] = new Context($context_definition, $value);
		}
		}
		}

		// Check for a valid context value.
		if (!isset($this->context[$name])) {
		$this->context[$name] = new Context($this->getContextDefinition($name));

core/tests/Drupal/KernelTests/Core/Plugin/Context/ContextAwarePluginBaseTest.php

deleted100644 → 0

+0 −97

Original line number	Diff line number	Diff line
		<?php

		namespace Drupal\KernelTests\Core\Plugin\Context;

		use Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface;
		use Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionTrait;
		use Drupal\Component\Plugin\Definition\PluginDefinition;
		use Drupal\Component\Plugin\Exception\ContextException;
		use Drupal\Core\DependencyInjection\ContainerBuilder;
		use Drupal\Core\Plugin\Context\ContextDefinition;
		use Drupal\Core\Plugin\ContextAwarePluginBase;
		use Drupal\Core\TypedData\DataDefinition;
		use Drupal\Core\TypedData\Plugin\DataType\StringData;
		use Drupal\Core\TypedData\TypedDataManagerInterface;
		use Drupal\KernelTests\KernelTestBase;

		/**
		* @coversDefaultClass \Drupal\Core\Plugin\ContextAwarePluginBase
		*
		* @group Plugin
		* @group legacy
		*/
		class ContextAwarePluginBaseTest extends KernelTestBase {

		/**
		* The plugin instance under test.
		*
		* @var \Drupal\Core\Plugin\ContextAwarePluginBase
		*/
		private $plugin;

		/**
		* {@inheritdoc}
		*/
		protected function setUp(): void {
		parent::setUp();
		$configuration = [
		'context' => [
		'nato_letter' => 'Alpha',
		],
		];
		$plugin_definition = new TestPluginDefinition();
		$plugin_definition->addContextDefinition('nato_letter', ContextDefinition::create('string'));
		$this->plugin = $this->getMockBuilder(ContextAwarePluginBase::class)
		->setConstructorArgs([$configuration, 'the_sisko', $plugin_definition])
		->onlyMethods(['setContext'])
		->getMockForAbstractClass();
		}

		/**
		* @covers ::getContextDefinitions
		*/
		public function testGetContextDefinitions() {
		$this->assertIsArray($this->plugin->getContextDefinitions());
		}

		/**
		* @covers ::getContextDefinition
		*/
		public function testGetContextDefinition() {
		// The context is not defined, so an exception will be thrown.
		$this->expectException(ContextException::class);
		$this->expectExceptionMessage('The person context is not a valid context.');
		$this->plugin->getContextDefinition('person');
		}

		/**
		* @covers ::getContextValue
		*/
		public function testGetContextValue() {
		// Assert that the context value passed in the plugin configuration is
		// available.
		$this->assertSame('Alpha', $this->plugin->getContextValue('nato_letter'));
		}

		/**
		* @covers ::setContextValue
		*/
		public function testSetContextValue() {
		$typed_data_manager = $this->prophesize(TypedDataManagerInterface::class);
		$container = new ContainerBuilder();
		$container->set('typed_data_manager', $typed_data_manager->reveal());
		\Drupal::setContainer($container);

		$this->plugin->getPluginDefinition()->addContextDefinition('foo', new ContextDefinition('string'));

		$this->plugin->expects($this->exactly(1))->method('setContext');
		$this->plugin->setContextValue('foo', new StringData(new DataDefinition(), 'bar'));
		}

		}

		class TestPluginDefinition extends PluginDefinition implements ContextAwarePluginDefinitionInterface {

		use ContextAwarePluginDefinitionTrait;

		}

core/tests/Drupal/KernelTests/Core/Plugin/Context/ContextAwarePluginTraitTest.php

+0 −28

Original line number	Diff line number	Diff line
		@@ -75,34 +75,6 @@ public function testGetContextValue() {
		$this->assertSame('Alpha', $this->plugin->getContextValue('nato_letter'));
		}

		/**
		* @covers ::getContextValue
		* @group legacy
		*/
		public function testGetContextValueFromConfiguration() {
		$this->expectDeprecation('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');
		$configuration = [
		'context' => [
		'nato_letter' => 'Alpha',
		],
		];
		$this->plugin = new TestContextAwarePlugin($configuration, 'the_sisko', $this->plugin->getPluginDefinition());
		// Assert that the context value passed in the plugin configuration is
		// available.
		$this->assertSame('Alpha', $this->plugin->getContextValue('nato_letter'));
		}

		/**
		* @covers ::getContextValue
		* @group legacy
		*/
		public function testConfigurableGetContextValueFromConfiguration() {
		$this->expectDeprecation('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');
		// Assert that the context value passed in the plugin configuration is
		// available.
		$this->assertSame('Alpha', $this->configurablePlugin->getContextValue('nato_letter'));
		}

		/**
		* @covers ::setContextValue
		*/