Problem/Motivation
PHP has several modifiers that can be applied to method definitions:
public,protected,private
static
abstract, final
We have not defined the order of those modifiers in the coding standards. In Drupal core we have some typical patterns:
"public" before "static"
"abstract" before "protected"
"public" and "final" mixed
The original proposal here, which became RTBC, used text from PSR-2 which is now deprecated. The new proposal is to use the text from PSR12, section 4.3 and 4.6.
Benefits
If we adopted this change, the Drupal Project would benefit by ...
Three supporters required
-
https://www.drupal.org/u/drunken-monkey →
(2017-03-01)
-
https://www.drupal.org/u/wim-leers →
(2017-03-01)
-
https://www.drupal.org/u/borisson_ →
(2017-10-18)
Proposed changes
Provide all proposed changes to the Drupal
Coding standards →
. Give a link to each section that will be changed, and show the current text and proposed text as in the following layout:
Visibility
All methods and properties of classes must specify their visibility: public, protected, or private. The PHP 4-style "var" declaration must not be used.
The use of public properties is strongly discouraged, as it allows for unwanted side effects. It also exposes implementation-specific details, which in turn makes swapping out a class for another implementation (one of the key reasons to use objects) much harder. Properties should be considered internal to a class.
Visibility
Methods and Functions
Visibility must be declared on all methods.
Method names must not be prefixed with a single underscore to indicate protected or private visibility. That is, an underscore prefix explicitly has no meaning.
Method and function names must not be declared with space after the method name. The closing brace must go on the next line following the body. There must not be a space after the opening parenthesis, and there must not be a space before the closing parenthesis.
Properties
Visibility must be declared on all properties.
The use of public properties is strongly discouraged, as it allows for unwanted side effects. It also exposes implementation-specific details, which in turn makes swapping out a class for another implementation (one of the key reasons to use objects) much harder. Properties should be considered internal to a class.
Extract from PSR-12 section 4.4
abstract, final, and static
When present, the abstract and final declarations must precede the visibility declaration.
When present, the static declaration must come after the visibility declaration.
Extract from PSR-12 section 4.6
Remaining tasks
- Create a Change Record
- Review by the Coding Standards Committee
- Coding Standards Committee takes action as required
- /li>
- Final review by Coding Standards Committee
- Documentation updates
- Edit all pages
- Publish change record
- Remove 'Needs documentation edits' tag
- If applicable, create follow-up issues for PHPCS rules/sniffs changes
For a full explanation of these steps see the
Coding Standards project page →