Issue #3529274 by acbramley, smustgrave: ViewsConfigUpdater... (e19ac2e6) · Commits · project / drupal

core/.phpstan-baseline.php

+0 −12

Original line number	Diff line number	Diff line
		@@ -41930,18 +41930,6 @@
		'count' => 1,
		'path' => __DIR__ . '/modules/views/src/Views.php',
		];
		$ignoreErrors[] = [
		'message' => '#^Method Drupal\\\\views\\\\ViewsConfigUpdater\\:\\:create\$\$ has no return type specified\\.$#',
		'identifier' => 'missingType.return',
		'count' => 1,
		'path' => __DIR__ . '/modules/views/src/ViewsConfigUpdater.php',
		];
		$ignoreErrors[] = [
		'message' => '#^Method Drupal\\\\views\\\\ViewsConfigUpdater\\:\\:setDeprecationsEnabled\$\$ has no return type specified\\.$#',
		'identifier' => 'missingType.return',
		'count' => 1,
		'path' => __DIR__ . '/modules/views/src/ViewsConfigUpdater.php',
		];
		$ignoreErrors[] = [
		'message' => '#^Method Drupal\\\\views\\\\ViewsData\\:\\:cacheSet\$\$ has no return type specified\\.$#',
		'identifier' => 'missingType.return',

core/modules/views/src/Hook/ViewsHooks.php

+1 −1

Original line number	Diff line number	Diff line
		@@ -375,7 +375,7 @@ public function localTasksAlter(&$local_tasks): void {
		#[Hook('view_presave')]
		public function viewPresave(ViewEntityInterface $view): void {
		/** @var \Drupal\views\ViewsConfigUpdater $config_updater */
		$config_updater = \Drupal::classResolver(ViewsConfigUpdater::class);
		$config_updater = \Drupal::service(ViewsConfigUpdater::class);
		$config_updater->updateAll($view);
		}

core/modules/views/src/ViewsConfigUpdater.php

+20 −81

Original line number	Diff line number	Diff line
		@@ -4,106 +4,38 @@

		use Drupal\Component\Plugin\PluginManagerInterface;
		use Drupal\Core\Config\TypedConfigManagerInterface;
		use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
		use Drupal\Core\Entity\EntityFieldManagerInterface;
		use Drupal\Core\Entity\EntityTypeManagerInterface;
		use Symfony\Component\DependencyInjection\ContainerInterface;
		use Symfony\Component\DependencyInjection\Attribute\Autowire;

		/**
		* Provides a BC layer for modules providing old configurations.
		*
		* @internal
		*/
		class ViewsConfigUpdater implements ContainerInjectionInterface {

		/**
		* The entity type manager.
		*
		* @var \Drupal\Core\Entity\EntityTypeManagerInterface
		*/
		protected $entityTypeManager;

		/**
		* The entity field manager.
		*
		* @var \Drupal\Core\Entity\EntityFieldManagerInterface
		*/
		protected $entityFieldManager;

		/**
		* The typed config manager.
		*
		* @var \Drupal\Core\Config\TypedConfigManagerInterface
		*/
		protected $typedConfigManager;

		/**
		* The views data service.
		*
		* @var \Drupal\views\ViewsData
		*/
		protected $viewsData;

		/**
		* The formatter plugin manager service.
		*
		* @var \Drupal\Component\Plugin\PluginManagerInterface
		*/
		protected $formatterPluginManager;
		class ViewsConfigUpdater {

		/**
		* Flag determining whether deprecations should be triggered.
		*
		* @var bool
		*/
		protected $deprecationsEnabled = TRUE;
		protected bool $deprecationsEnabled = TRUE;

		/**
		* Stores which deprecations were triggered.
		*
		* @var bool
		*/
		protected $triggeredDeprecations = [];
		protected array $triggeredDeprecations = [];

		/**
		* ViewsConfigUpdater constructor.
		*
		* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
		* The entity type manager.
		* @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
		* The entity field manager.
		* @param \Drupal\Core\Config\TypedConfigManagerInterface $typed_config_manager
		* The typed config manager.
		* @param \Drupal\views\ViewsData $views_data
		* The views data service.
		* @param \Drupal\Component\Plugin\PluginManagerInterface $formatter_plugin_manager
		* The formatter plugin manager service.
		*/
		public function __construct(
		EntityTypeManagerInterface $entity_type_manager,
		EntityFieldManagerInterface $entity_field_manager,
		TypedConfigManagerInterface $typed_config_manager,
		ViewsData $views_data,
		PluginManagerInterface $formatter_plugin_manager,
		private readonly EntityTypeManagerInterface $entityTypeManager,
		private readonly EntityFieldManagerInterface $entityFieldManager,
		private readonly TypedConfigManagerInterface $typedConfigManager,
		private readonly ViewsData $viewsData,
		#[Autowire(service: 'plugin.manager.field.formatter')]
		private readonly PluginManagerInterface $formatterPluginManager,
		) {
		$this->entityTypeManager = $entity_type_manager;
		$this->entityFieldManager = $entity_field_manager;
		$this->typedConfigManager = $typed_config_manager;
		$this->viewsData = $views_data;
		$this->formatterPluginManager = $formatter_plugin_manager;
		}

		/**
		* {@inheritdoc}
		*/
		public static function create(ContainerInterface $container) {
		return new static(
		$container->get('entity_type.manager'),
		$container->get('entity_field.manager'),
		$container->get('config.typed'),
		$container->get('views.views_data'),
		$container->get('plugin.manager.field.formatter')
		);
		}

		/**
		@@ -112,10 +44,17 @@ public static function create(ContainerInterface $container) {
		* @param bool $enabled
		* Whether deprecations should be enabled.
		*/
		public function setDeprecationsEnabled($enabled) {
		public function setDeprecationsEnabled(bool $enabled): void {
		$this->deprecationsEnabled = $enabled;
		}

		/**
		* Whether deprecations are enabled.
		*/
		public function areDeprecationsEnabled(): bool {
		return $this->deprecationsEnabled;
		}

		/**
		* Performs all required updates.
		*
		@@ -259,7 +198,7 @@ public function processEntityArgumentUpdate(ViewEntityInterface $view): bool {
		}

		$deprecations_triggered = &$this->triggeredDeprecations['2640994'][$view->id()];
		if ($this->deprecationsEnabled && $changed && !$deprecations_triggered) {
		if ($this->areDeprecationsEnabled() && $changed && !$deprecations_triggered) {
		$deprecations_triggered = TRUE;
		@trigger_error(sprintf('The update to convert "numeric" arguments to "entity_target_id" for entity reference fields for view "%s" is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Profile, module and theme provided configuration should be updated. See https://www.drupal.org/node/3441945', $view->id()), E_USER_DEPRECATED);
		}
		@@ -351,7 +290,7 @@ public function processTableCssClassUpdate(ViewEntityInterface $view): bool {
		}

		$deprecations_triggered = &$this->triggeredDeprecations['table_css_class'][$view->id()];
		if ($this->deprecationsEnabled && $changed && !$deprecations_triggered) {
		if ($this->areDeprecationsEnabled() && $changed && !$deprecations_triggered) {
		$deprecations_triggered = TRUE;
		@trigger_error(sprintf('The update to add a default table CSS class for view "%s" is deprecated in drupal:11.2.0 and is removed from drupal:12.0.0. Profile, module and theme provided configuration should be updated. See https://www.drupal.org/node/3499943', $view->id()), E_USER_DEPRECATED);
		}

core/modules/views/tests/modules/views_test_config_updater/src/Hook/ViewsTestConfigUpdaterHooks.php

0 → 100644

+34 −0

Original line number	Diff line number	Diff line
		<?php

		declare(strict_types=1);

		namespace Drupal\views_test_config_updater\Hook;

		use Drupal\Core\Hook\Attribute\Hook;
		use Drupal\Core\KeyValueStore\KeyValueFactoryInterface;
		use Drupal\views\ViewEntityInterface;
		use Drupal\views\ViewsConfigUpdater;
		use Symfony\Component\DependencyInjection\Attribute\Autowire;

		/**
		* Hooks for the views_test_config_updater module.
		*/
		class ViewsTestConfigUpdaterHooks {

		public function __construct(
		protected readonly ViewsConfigUpdater $viewsConfigUpdater,
		#[Autowire(service: 'keyvalue')]
		protected readonly KeyValueFactoryInterface $keyValueFactory,
		) {

		}

		/**
		* Implements hook_ENTITY_TYPE_presave().
		*/
		#[Hook('view_presave')]
		public function viewPresave(ViewEntityInterface $view): void {
		$this->keyValueFactory->get('views_test_config_updater')->set('deprecations_enabled', $this->viewsConfigUpdater->areDeprecationsEnabled());
		}

		}

core/modules/views/tests/modules/views_test_config_updater/views_test_config_updater.info.yml

0 → 100644

+6 −0

Original line number	Diff line number	Diff line
		name: 'Views Test Config Updater'
		type: module
		package: Testing
		version: VERSION
		dependencies:
		- drupal:views