DrupalPractice standard¶

Core's phpcs.xml.dist runs only ExpectedException, ExceptionT, GlobalFunction, NamespacedDependency and part of VariableAnalysis from this standard. The rules and the analyzer checks that port the other sniffs are off in Drupal core.

DrupalPractice.Commenting.CommentEmptyLine¶

The rule leaves the blank line between a comment and a closing bracket to the formatter. Before the closing brace of a class, interface, trait or enum with members the formatter always writes one, and Coder reports it. A // comment with no text is reported by Mago's no-empty-comment, and a comment after code on the same line by drupal/post-statement-comment. The rule skips a comment right before the docblock of a declaration, where FunctionSpacing asks for the blank line, and a // @code example.

DrupalPractice.FunctionCalls.InsecureUnserialize¶

The rule skips a payload built with serialize() in the same function and a call that spreads its arguments, which are both reported by Coder, and reads a named options argument by its name. It also reports \unserialize() and (TRUE), which Coder misses.

DrupalPractice.Objects.GlobalClass¶

Coder reports a static load() or loadMultiple() call on one of 46 core entity classes, written with an imported name, in the same classes as its GlobalDrupal sniff. The analyzer check takes every entity class and a name written in full, and checks the classes of drupal/global-drupal-call. It skips a first-class callable, a constructor with a nullable parameter, deprecated code, anonymous classes and test code, which Coder reports.

DrupalPractice.Objects.GlobalDrupal¶

Coder reports a \Drupal:: call in a non-static method of a service, of a class that implements ContainerInjectionInterface, or of a class that extends one of 12 base classes such as FormBase. It reads the services from the nearest, shortest-named services file, so it misses a service whose id names its class. In a module that also has a drush.services.yml with a shorter name than the module's own file, it reads that one, and misses the module's services. The analyzer check reads the services file named after each module and profile, and core's, so it doesn't read drush.services.yml. It also reports entity handlers, container derivers, hook classes and subclasses of those base classes. It skips a constructor with a nullable parameter, deprecated code, anonymous classes and test code, which Coder reports.

DrupalPractice.Objects.UnusedPrivateMethod¶

The analyzer also reports an unused private static method, an unused private method of an enum, and a private method that is called only from its own body, which Coder skips. Coder reports a private __destruct() and a private method that is called only as $other->helper(), self::helper(), static::helper() or [self::class, 'helper']; the analyzer doesn't report any of them.

VariableAnalysis.CodeAnalysis.VariableAnalysis¶

Coder's ruleset skips *.tpl.php files, and so do drupal/unused-variable and drupal/variable-redeclaration. mago analyze checks them.

• UndefinedUnsetVariable: An unset() of a variable that was never set. Not ported. Core's phpcs.xml.dist turns this code off. Coder doesn't count an element write such as $x['k'] = 1 as setting $x, so it also reports unset($x['k']) after one. mago analyze reports such a variable as undefined-variable at its first element write. A read after unset() is UndefinedVariable, which Coder's ruleset turns off, and mago analyze reports it as possibly-undefined-variable.

Checks for the Drupal 7 API¶

These checks look for Drupal 7 functions, hooks and arrays, such as check_plain(), hook_menu() or $form_state['input'], and Coder runs some of them only on a Drupal 7 module. Most aren't ported. On Drupal 8 and later most of those functions don't exist, and mago analyze reports a call to one as an unknown function. The notes say where a check has a Drupal 8 form that something else reports. The Drupal 7 checks of the Drupal standard are on the Drupal standard page, since core's config still runs them.