Issue #3250349 by alexpott:... (bb486268) · Commits · project / drupal

core/lib/Drupal/Core/Datetime/Element/Datelist.php

+8 −3

Original line number	Diff line number	Diff line
		@@ -3,9 +3,13 @@
		namespace Drupal\Core\Datetime\Element;

		use Drupal\Component\Utility\NestedArray;
		use Drupal\Component\Utility\Variable;
		use Drupal\Core\Datetime\DateHelper;
		use Drupal\Core\Datetime\DrupalDateTime;
		use Drupal\Core\Form\FormStateInterface;
		use Drupal\Core\Security\DoTrustedCallbackTrait;
		use Drupal\Core\Security\StaticTrustedCallbackHelper;
		use Drupal\Core\Security\TrustedCallbackInterface;

		/**
		* Provides a datelist element.
		@@ -14,6 +18,8 @@
		*/
		class Datelist extends DateElementBase {

		use DoTrustedCallbackTrait;

		/**
		* {@inheritdoc}
		*/
		@@ -261,9 +267,8 @@ public static function processDatelist(&$element, FormStateInterface $form_state
		// Allows custom callbacks to alter the element.
		if (!empty($element['#date_date_callbacks'])) {
		foreach ($element['#date_date_callbacks'] as $callback) {
		if (function_exists($callback)) {
		$callback($element, $form_state, $date);
		}
		$message = sprintf('Datelist element #date_date_callbacks callbacks must be methods of a class that implements \Drupal\Core\Security\TrustedCallbackInterface or be an anonymous function. The callback was %s. Support for this callback implementation is deprecated in drupal:9.3.0 and will be removed in drupal:10.0.0. See https://www.drupal.org/node/3217966', Variable::callableToString($callback));
		StaticTrustedCallbackHelper::callback($callback, [&$element, $form_state, $date], $message, TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION);
		}
		}

core/tests/Drupal/KernelTests/Core/Datetime/DatelistElementFormTest.php

0 → 100644

+140 −0

Original line number	Diff line number	Diff line
		<?php

		namespace Drupal\KernelTests\Core\Datetime;

		use Drupal\Component\Utility\Variable;
		use Drupal\Core\Datetime\DrupalDateTime;
		use Drupal\Core\Form\FormInterface;
		use Drupal\Core\Form\FormState;
		use Drupal\Core\Form\FormStateInterface;
		use Drupal\Core\Security\TrustedCallbackInterface;
		use Drupal\KernelTests\KernelTestBase;

		/**
		* Tests Datelist functionality.
		*
		* @group Form
		*/
		class DatelistElementFormTest extends KernelTestBase implements FormInterface, TrustedCallbackInterface {

		/**
		* Modules to enable.
		*
		* @var array
		*/
		protected static $modules = ['datetime', 'system'];

		/**
		* Sets up the test.
		*/
		protected function setUp(): void {
		parent::setUp();
		}

		/**
		* {@inheritdoc}
		*/
		public function getFormId() {
		return 'test_datelist_element';
		}

		/**
		* {@inheritdoc}
		*/
		public function datelistDateCallbackTrusted(array &$element, FormStateInterface $form_state, DrupalDateTime $date = NULL) {
		$element['datelistDateCallbackExecuted'] = [
		'#value' => TRUE,
		];
		$form_state->set('datelistDateCallbackExecuted', TRUE);
		}

		/**
		* {@inheritdoc}
		*/
		public function datelistDateCallback(array &$element, FormStateInterface $form_state, DrupalDateTime $date = NULL) {
		$element['datelistDateCallbackExecuted'] = [
		'#value' => TRUE,
		];
		$form_state->set('datelistDateCallbackExecuted', TRUE);
		}

		/**
		* {@inheritdoc}
		*/
		public function buildForm(array $form, FormStateInterface $form_state, string $date_callback = 'datelistDateCallbackTrusted') {

		$form['datelist_element'] = [
		'#title' => 'datelist test',
		'#type' => 'datelist',
		'#default_value' => new DrupalDateTime('2000-01-01 00:00:00'),
		'#date_part_order' => [
		'month',
		'day',
		'year',
		'hour',
		'minute', 'ampm',
		],
		'#date_text_parts' => ['year'],
		'#date_year_range' => '2010:2020',
		'#date_increment' => 15,
		'#date_date_callbacks' => [[$this, $date_callback]],
		];

		$form['submit'] = [
		'#type' => 'submit',
		'#value' => t('Submit'),
		];

		return $form;
		}

		/**
		* {@inheritdoc}
		*/
		public function submitForm(array &$form, FormStateInterface $form_state) {}

		/**
		* Form validation handler.
		*
		* @param array $form
		* An associative array containing the structure of the form.
		* @param \Drupal\Core\Form\FormStateInterface $form_state
		* The current state of the form.
		*/
		public function validateForm(array &$form, FormStateInterface $form_state) {}

		/**
		* Tests that trusted callbacks are executed.
		*/
		public function testDatelistElement() {
		$form_state = new FormState();
		$form = \Drupal::formBuilder()->buildForm($this, $form_state);
		$this->render($form);

		$this->assertTrue($form['datelist_element']['datelistDateCallbackExecuted']['#value']);
		$this->assertTrue($form_state->get('datelistDateCallbackExecuted'));
		}

		/**
		* Tests that deprecations are raised if untrusted callbacks are used.
		*
		* @group legacy
		*/
		public function testDatelistElementUntrustedCallbacks() : void {
		$form = \Drupal::formBuilder()->getForm($this, 'datelistDateCallback');
		$this->expectDeprecation(sprintf('Datelist element #date_date_callbacks callbacks must be methods of a class that implements \Drupal\Core\Security\TrustedCallbackInterface or be an anonymous function. The callback was %s. Support for this callback implementation is deprecated in drupal:9.3.0 and will be removed in drupal:10.0.0. See https://www.drupal.org/node/3217966', Variable::callableToString([$this, 'datelistDateCallback'])));
		$this->render($form);

		$this->assertTrue($form['datelist_element']['datelistDateCallbackExecuted']['#value']);
		}

		/**
		* {@inheritdoc}
		*/
		public static function trustedCallbacks() {
		return [
		'datelistDateCallbackTrusted',
		];
		}

		}