Merge pull request #101 from localgovdrupal/1.x

Release 1.0.0-beta9

Author: andybroomfield

localgov_forms.install

@@ -6,12 +6,13 @@
  */
 
 use Drupal\Component\Serialization\Yaml;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Drupal\webform\Entity\WebformOptions;
 
 /**
  * Implements hook_install().
  */
-function localgov_forms_install() {
+function localgov_forms_install(): void {
 
   // Override Webforms default configuration.
   $config = \Drupal::configFactory()->getEditable('localgov_forms.webform.settings');
@@ -24,7 +25,7 @@ function localgov_forms_install() {
  *
  * Creates a Webform option for Local custodian codes.
  */
-function localgov_forms_update_8001() {
+function localgov_forms_update_8001(): ?TranslatableMarkup {
 
   $has_local_custodian_codes_option = Drupal::service('entity_type.manager')->getStorage('webform_options')->load('local_custodian_codes_gb');
   if ($has_local_custodian_codes_option) {
@@ -39,4 +40,6 @@ function localgov_forms_update_8001() {
   $local_custodian_codes_option = Yaml::decode(file_get_contents(__DIR__ . '/config/install/webform.webform_options.local_custodian_codes_gb.yml'));
   $new_local_custodian_codes_option = WebformOptions::create($local_custodian_codes_option);
   $new_local_custodian_codes_option->save();
+
+  return NULL;
 }

localgov_forms.module

@@ -10,7 +10,7 @@ use Drupal\Core\Render\Element;
 /**
  * Implements hook_theme().
  */
-function localgov_forms_theme() {
+function localgov_forms_theme(): array {
   return [
     // Form element: localgov_webform_uk_address.
     'localgov_forms_uk_address_lookup' => [
@@ -29,7 +29,7 @@ function localgov_forms_theme() {
  * Makes sub-elements available within the `content` variable.  Mostly lifted
  * from _template_preprocess_webform_composite().
  */
-function template_preprocess_localgov_forms_uk_address_lookup(array &$variables) {
+function template_preprocess_localgov_forms_uk_address_lookup(array &$variables): void {
 
   $element = $variables['element'];
   foreach (Element::children($element) as $key) {
@@ -44,14 +44,14 @@ function template_preprocess_localgov_forms_uk_address_lookup(array &$variables)
 /**
  * Prepares variables for the UK address element template.
  */
-function template_preprocess_localgov_forms_uk_address(array &$variables) {
+function template_preprocess_localgov_forms_uk_address(array &$variables): void {
 
   template_preprocess_localgov_forms_uk_address_lookup($variables);
 }
 
 /**
  * Implements hook_preprocess_hook() for hook_preprocess_webform().
  */
-function localgov_forms_preprocess_webform(array &$variables) {
+function localgov_forms_preprocess_webform(array &$variables): void {
   $variables['#attached']['library'][] = 'localgov_forms/localgov_forms.form_errors';
 }

localgov_forms.tokens.inc

@@ -16,7 +16,7 @@ use Drupal\webform\Utility\WebformDateHelper;
  *
  * Token declarations.
  */
-function localgov_forms_token_info() {
+function localgov_forms_token_info(): array {
 
   return [
     'tokens' => [
@@ -42,7 +42,7 @@ function localgov_forms_token_info() {
  *
  * @see system_tokens()
  */
-function localgov_forms_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) {
+function localgov_forms_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata): array {
 
   $replacements = [];
 

modules/localgov_forms_date/css/date.css

@@ -4,17 +4,17 @@
 }
 
 .localgov-forms-date div[class*="-day"] {
-  margin-left: 0em;
   flex: 1;
   max-width: 100%;
   margin-top: 0.5em;
   margin-right: 0.5em;
+  margin-left: 0;
 }
 
 .localgov-forms-date div[class*="-month"] {
   flex: 2;
-  margin: 0.5em;
   max-width: 100%;
+  margin: 0.5em;
 }
 
 .localgov-forms-date div[class*="-year"] {

modules/localgov_forms_date/localgov_forms_date.install

@@ -10,7 +10,7 @@ use Drupal\Component\Serialization\Yaml;
 /**
  * Adds a UK short date style e.g dd-mm-yyyy.
  */
-function localgov_forms_date_update_8001() {
+function localgov_forms_date_update_8001(): void {
   $config_id = 'core.date_format.localgov_forms_date_short_date';
   $config_path = \Drupal::service('extension.list.module')->getPath('localgov_forms_date');
   $uk_short_html_date_config = Yaml::decode(file_get_contents($config_path . '/config/install/' . $config_id . '.yml'));
@@ -20,7 +20,7 @@ function localgov_forms_date_update_8001() {
 /**
  * Adds a UK short date style e.g dd-mm-yyyy HH:mm:ss.
  */
-function localgov_forms_date_update_8002() {
+function localgov_forms_date_update_8002(): void {
   $config_id = 'core.date_format.localgov_forms_date_datetime';
   $config_path = \Drupal::service('extension.list.module')->getPath('localgov_forms_date');
   $uk_html_datetime_config = Yaml::decode(file_get_contents($config_path . '/config/install/' . $config_id . '.yml'));
@@ -30,7 +30,7 @@ function localgov_forms_date_update_8002() {
 /**
  * Adds a UUID to LocalGov Forms Date formats.
  */
-function localgov_forms_date_update_8003() {
+function localgov_forms_date_update_8003(): void {
   $localgov_date_formats = [
     'core.date_format.localgov_forms_date_short_date',
     'core.date_format.localgov_forms_date_datetime',

modules/localgov_forms_date/localgov_forms_date.module

@@ -8,7 +8,7 @@
 /**
  * Datetime Form preprocess function.
  */
-function localgov_forms_date_preprocess_datetime_form(array &$variables) {
+function localgov_forms_date_preprocess_datetime_form(array &$variables): void {
   // Check that this is a localgov_forms_date form element.
   if ($variables['element']['#type'] === 'localgov_forms_date') {
     $variables['attributes']['class'][] = 'localgov-forms-date';

modules/localgov_forms_date/src/Element/LocalgovFormsDate.php

@@ -132,7 +132,7 @@ private static function restoreUnprocessedDate(array &$element) :void {
    * be set in the UI which should take precedence over
    * the default error message.
    */
-  public static function validateDatelist(&$element, FormStateInterface $form_state, &$complete_form) {
+  public static function validateDatelist(&$element, FormStateInterface $form_state, &$complete_form): void {
     $input_exists = FALSE;
     $input = NestedArray::getValue($form_state->getValues(), $element['#parents'], $input_exists);
 

modules/localgov_forms_date/src/Plugin/WebformElement/LocalgovFormsDate.php

@@ -65,7 +65,7 @@ public function form(array $form, FormStateInterface $form_state) {
   /**
    * {@inheritdoc}
    */
-  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
+  public function validateConfigurationForm(array &$form, FormStateInterface $form_state): void {
     parent::validateConfigurationForm($form, $form_state);
     $values = $form_state->getValues();
     $values['date_part_order'] = ['day', 'month', 'year'];
@@ -77,7 +77,7 @@ public function validateConfigurationForm(array &$form, FormStateInterface $form
   /**
    * After build handler for Datelist element.
    */
-  public static function afterBuild(array $element, FormStateInterface $form_state) {
+  public static function afterBuild(array $element, FormStateInterface $form_state): array {
     $element = parent::afterBuild($element, $form_state);
 
     // Set the property of the date of birth elements.
@@ -112,7 +112,7 @@ public static function afterBuild(array $element, FormStateInterface $form_state
    *
    * @see Drupal\Webform\Plugin\WebformElement\DateBase::setDefaultValue()
    */
-  public function setDefaultValue(array &$element) {
+  public function setDefaultValue(array &$element): void {
 
     $orig_type = $element['#type'];
     $element['#type'] = 'datelist';
@@ -127,7 +127,7 @@ public function setDefaultValue(array &$element) {
    * date validation error messages display in
    * a UK Style format e.g dd-mm-yyyy.
    */
-  public static function validateDate(&$element, FormStateInterface $form_state, &$complete_form) {
+  public static function validateDate(&$element, FormStateInterface $form_state, &$complete_form): void {
 
     // Adds a  short date and short date time format.
     $localgov_forms_short_date_format = DateFormat::load('localgov_forms_date_short_date')->getPattern();

modules/localgov_forms_date/tests/modules/localgov_forms_date_test/localgov_forms_date_test.info.yml

@@ -5,5 +5,5 @@ package: Testing
 core_version_requirement: ^8.8 || ^9 || ^10
 
 dependencies:
-- webform:webform
-- localgov_forms:localgov_forms_date
+  - webform:webform
+  - localgov_forms:localgov_forms_date

modules/localgov_forms_date/tests/src/Kernel/DateWebformElementTest.php

@@ -17,7 +17,7 @@ class DateWebformElementTest extends KernelTestBase {
   /**
    * Tests a webform with our date field.
    */
-  public function testFormSubmission() {
+  public function testFormSubmission(): void {
 
     $this->passCase();
     $this->failCaseWithInvalidDay();
@@ -28,7 +28,7 @@ public function testFormSubmission() {
   /**
    * Tests valid date.
    */
-  protected function passCase() {
+  protected function passCase(): void {
 
     $form_state = new FormState();
     $form_state->setValue('date',
@@ -42,7 +42,7 @@ protected function passCase() {
   /**
    * Tests date with invalid day.
    */
-  protected function failCaseWithInvalidDay() {
+  protected function failCaseWithInvalidDay(): void {
 
     $form_state = new FormState();
     $form_state->setValue('date', ['day' => '1D']);
@@ -55,7 +55,7 @@ protected function failCaseWithInvalidDay() {
   /**
    * Tests date with nonnumeric day.
    */
-  protected function failCaseWithNonNumericDay() {
+  protected function failCaseWithNonNumericDay(): void {
 
     $form_state = new FormState();
     $form_state->setValue('date',
@@ -69,7 +69,7 @@ protected function failCaseWithNonNumericDay() {
   /**
    * Tests date with invalid year.
    */
-  protected function failCaseWithInvalidYear() {
+  protected function failCaseWithInvalidYear(): void {
 
     $form_state = new FormState();
     $form_state->setValue('date',
@@ -83,7 +83,7 @@ protected function failCaseWithInvalidYear() {
   /**
    * {@inheritdoc}
    */
-  protected function setUp() :void {
+  protected function setUp(): void {
 
     parent::setUp();