Contrib.social

Space in `match (..)`.

Open on Drupal.org →
Created on 5 December 2023, over 1 year ago

Problem/Motivation

Normally, we ask that a space is put between a control structure keyword and the opening parentheses.
This is the case for `if (..)`, `foreach (..)` etc, and is enforced by the phpcs rules.

However, it is not currently enforced for `match (..)`.
In fact, we see it with and without the space:

With space:

~/projects/d8/www $ ag --count "(return|=) match \(" core/
core/tests/Drupal/Tests/Core/Cache/ChainedFastBackendFactoryTest.php:1
core/lib/Drupal/Core/Config/Schema/Mapping.php:1
core/lib/Drupal/Core/StringTranslation/ByteSizeMarkup.php:1
core/modules/system/system.install:1
core/modules/block_content/tests/src/Functional/Rest/BlockContentResourceTestBase.php:2
core/modules/block_content/src/BlockContentAccessControlHandler.php:1
core/modules/field_ui/tests/src/FunctionalJavascript/ManageFieldsTest.php:1
core/modules/jsonapi/tests/src/Functional/BlockContentTest.php:1

Without space:

~/projects/d8/www $ ag --count "(return|=) match\(" core/
core/lib/Drupal/Core/Database/StatementWrapperIterator.php:3
core/lib/Drupal/Core/Database/StatementPrefetchIterator.php:1
core/modules/pgsql/src/Driver/Database/pgsql/Schema.php:1
core/modules/field_ui/src/Form/EntityDisplayModeFormBase.php:3
core/modules/jsonapi/tests/src/Functional/FileTest.php:1
core/modules/ckeditor5/src/Plugin/Validation/Constraint/SourceEditingRedundantTagsConstraintValidator.php:1
core/modules/file/tests/src/Functional/Rest/FileResourceTestBase.php:1

Benefits

Consistency..

Three supporters required

  1. https://www.drupal.org/u/ → {userid} (date that user added support)
  2. https://www.drupal.org/u/ → {userid} (date that user added support)
  3. https://www.drupal.org/u/ → {userid} (date that user added support)

Proposed changes

https://www.drupal.org/docs/develop/standards/php/php-coding-standards#c... →
Explicitly mention `match (..)` as a control statement.

A match statement should have a space between the match keyword and the opening parenthesis.

return match ($value) {
  5 => 'win',
  default => 'loss',
};

Note that "match" can also be a method name.
In that case, no space should be added:

return $this->match($value);

Remaining tasks

  2. Add supporters
  3. Create a Change Record
  4. Review by the Coding Standards Committee
  5. Coding Standards Committee takes action as required
  6. Tagged with 'Needs documentation edits' if Core is not affected
  7. Discussed by the Core Committer Committee, if it impacts Drupal Core
  8. Documentation updates
    1. Edit all pages
    2. Publish change record
    3. Remove 'Needs documentation edits' tag
  9. If applicable, create follow-up issues for PHPCS rules/sniffs changes

For a full explanation of these steps see the Coding Standards project page →

📌 Task
Status

Active

Component

Coding Standards

Created by

🇩🇪Germany donquixote

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024