Issue #3507052 by quietone, borisson_, alexpott: Enable LineLength for core/includes, lib, profiles, recipes and themes

Author: catch

includes/common.inc

@@ -84,17 +84,19 @@ const CSS_BASE = -200;
 const CSS_LAYOUT = -100;
 
 /**
- * The default weight for CSS rules that style design components (and their associated states and themes.)
+ * The default weight for CSS rules that style design components.
+ *
+ * This applies to the associated states and themes of the component.
  */
 const CSS_COMPONENT = 0;
 
 /**
- * The default weight for CSS rules that style states and are not included with components.
+ * The default weight for rules that style states not included with components.
  */
 const CSS_STATE = 100;
 
 /**
- * The default weight for CSS rules that style themes and are not included with components.
+ * The default weight for rules that style themes not included with components.
  */
 const CSS_THEME = 200;
 
@@ -342,7 +344,10 @@ function show(&$element) {
 }
 
 /**
- * Rebuilds the container, flushes all persistent caches, resets all variables, and rebuilds all data structures.
+ * Re-initializes the entire system.
+ *
+ * To re-initialize the system, the container is rebuilt, all persistent caches
+ * are flushed, all variables are reset and all data structures are rebuilt.
  *
  * At times, it is necessary to re-initialize the entire system to account for
  * changed or new code. This function:

lib/Drupal/Component/Plugin/Factory/DefaultFactory.php

@@ -17,7 +17,7 @@
 class DefaultFactory implements FactoryInterface {
 
   /**
-   * The object that retrieves the definitions of the plugins that this factory instantiates.
+   * The object that gets the plugin definitions that this factory instantiates.
    *
    * The plugin definition includes the plugin class and possibly other
    * information necessary for proper instantiation.

lib/Drupal/Component/Plugin/Factory/ReflectionFactory.php

@@ -32,7 +32,7 @@ public function createInstance($plugin_id, array $configuration = []) {
   }
 
   /**
-   * Inspects the plugin class and build a list of arguments for the constructor.
+   * Inspects the plugin class and builds a list of constructor arguments.
    *
    * This is provided as a helper method so factories extending this class can
    * replace this and insert their own reflection logic.

lib/Drupal/Core/Access/AccessManagerInterface.php

@@ -12,7 +12,7 @@
 interface AccessManagerInterface {
 
   /**
-   * Checks a named route with parameters against applicable access check services.
+   * Checks a named route with parameters against access check services.
    *
    * Determines whether the route is accessible or not.
    *

lib/Drupal/Core/Access/AccessResult.php

@@ -98,7 +98,7 @@ public static function forbiddenIf($condition, $reason = NULL) {
   }
 
   /**
-   * Creates an allowed access result if the permission is present, neutral otherwise.
+   * Creates an access result if the permission is present, neutral otherwise.
    *
    * Checks the permission and adds a 'user.permissions' cache context.
    *
@@ -121,7 +121,7 @@ public static function allowedIfHasPermission(AccountInterface $account, $permis
   }
 
   /**
-   * Creates an allowed access result if the permissions are present, neutral otherwise.
+   * Creates an access result if the permissions are present, neutral otherwise.
    *
    * Checks the permission and adds a 'user.permissions' cache contexts.
    *

lib/Drupal/Core/Access/AccessResultForbidden.php

@@ -3,7 +3,7 @@
 namespace Drupal\Core\Access;
 
 /**
- * Value object indicating a forbidden access result, with cacheability metadata.
+ * Value object for a forbidden access result, with cacheability metadata.
  */
 class AccessResultForbidden extends AccessResult implements AccessResultReasonInterface {
 

lib/Drupal/Core/Ajax/OpenModalDialogCommand.php

@@ -3,7 +3,7 @@
 namespace Drupal\Core\Ajax;
 
 /**
- * Defines an AJAX command to open certain content in a dialog in a modal dialog.
+ * An AJAX command to open certain content in a dialog in a modal dialog.
  *
  * @ingroup ajax
  */

lib/Drupal/Core/Asset/LibraryDiscoveryParser.php

@@ -634,8 +634,8 @@ protected function setOverrideValue(array &$library, array $sub_key, array $over
   protected function resolveThemeAssetPath($theme_path, $overriding_asset) {
     if ($overriding_asset[0] !== '/' && !$this->isValidUri($overriding_asset)) {
       // The destination is not an absolute path and it's not a URI (e.g.
-      // public://generated_js/example.js or https://example.com/js/my_js.js), so
-      // it's relative to the theme.
+      // public://generated_js/example.js or https://example.com/js/my_js.js),
+      // so it's relative to the theme.
       return '/' . $theme_path . '/' . $overriding_asset;
     }
     return $overriding_asset;

lib/Drupal/Core/Cache/Context/AccountPermissionsCacheContext.php

@@ -6,7 +6,7 @@
 use Drupal\Core\Session\PermissionsHashGeneratorInterface;
 
 /**
- * Defines the AccountPermissionsCacheContext service, for "per permission" caching.
+ * The account permission cache context for "per permission" caching.
  *
  * Cache context ID: 'user.permissions'.
  */

lib/Drupal/Core/Cache/Context/CalculatedCacheContextInterface.php

@@ -36,7 +36,7 @@ public static function getLabel();
   public function getContext($parameter = NULL);
 
   /**
-   * Gets the cacheability metadata for the context based on the parameter value.
+   * Gets cacheability metadata for the context based on the parameter value.
    *
    * There are three valid cases for the returned CacheableMetadata object:
    * - An empty object means this can be optimized away safely.

lib/Drupal/Core/Cache/MemoryCache/LruMemoryCache.php

@@ -79,8 +79,8 @@ public function set($cid, $data, $expire = Cache::PERMANENT, array $tags = []):
     }
     elseif (count($this->cache) > $this->allowedSlots - 1) {
       // Remove one item from the cache to ensure we remain within the allowed
-      // number of slots. Avoid using array_slice() because it makes a copy of the
-      // array, and avoid using array_splice() or array_shift() because they
+      // number of slots. Avoid using array_slice() because it makes a copy of
+      // the array, and avoid using array_splice() or array_shift() because they
       // re-index numeric keys.
       unset($this->cache[array_key_first($this->cache)]);
     }

lib/Drupal/Core/Config/ConfigManagerInterface.php

@@ -134,7 +134,7 @@ public function findConfigEntityDependencies($type, array $names);
   public function findConfigEntityDependenciesAsEntities($type, array $names);
 
   /**
-   * Lists which config entities to update and delete on removal of a dependency.
+   * Lists config entities to update and delete on removal of a dependency.
    *
    * @param string $type
    *   The type of dependency being checked. Either 'module', 'theme', 'config'

lib/Drupal/Core/Config/Entity/ConfigEntityBase.php

@@ -233,7 +233,7 @@ public function createDuplicate() {
   }
 
   /**
-   * Helper callback for uasort() to sort configuration entities by weight and label.
+   * Callback for uasort() to sort configuration entities by weight and label.
    */
   public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {
     $a_weight = $a->weight ?? 0;

lib/Drupal/Core/Config/FileStorage.php

@@ -63,7 +63,7 @@ public function getFilePath($name) {
   }
 
   /**
-   * Returns the file extension used by the file storage for all configuration files.
+   * Gets the extension used by the file storage for all configuration files.
    *
    * @return string
    *   The file extension.

lib/Drupal/Core/Database/Log.php

@@ -18,7 +18,9 @@
 class Log {
 
   /**
-   * Cache of logged queries. This will only be used if the query logger is enabled.
+   * Cache of logged queries.
+   *
+   * This will only be used if the query logger is enabled.
    *
    * @var array
    * The structure for the logging array is as follows:

lib/Drupal/Core/Database/Query/SelectInterface.php

@@ -152,7 +152,7 @@ public function escapeLike($string);
   public function escapeField($string);
 
   /**
-   * Compiles and returns an associative array of the arguments for this prepared statement.
+   * Compiles and returns an array of the arguments for this prepared statement.
    *
    * @param \Drupal\Core\Database\Query\PlaceholderInterface|null $queryPlaceholder
    *   When collecting the arguments of a subquery, the main placeholder

lib/Drupal/Core/Database/Schema.php

@@ -143,7 +143,7 @@ protected function executeDdlStatement(string $sql, array $arguments = [], array
   }
 
   /**
-   * Build a condition to match a table name against a standard information_schema.
+   * Builds a condition to match a table name against the information_schema.
    *
    * The information_schema is a SQL standard that provides information about
    * the database server and the databases, schemas, tables, columns and users
@@ -676,7 +676,7 @@ protected function createTableSql($name, $table) {
   }
 
   /**
-   * Return an array of field names from an array of key/index column specifiers.
+   * Gets an array of field names from an array of key/index column specifiers.
    *
    * This is usually an identity function but if a key/index uses a column
    * prefix specification, this function extracts just the name.

lib/Drupal/Core/Database/StatementInterface.php

@@ -151,7 +151,8 @@ public function fetchAssoc();
    * @param int|null $column_index
    *   If $mode is FetchAs::Column, the index of the column to fetch.
    * @param array $constructor_arguments
-   *   If $mode is FetchAs::ClassObject, the arguments to pass to the constructor.
+   *   If $mode is FetchAs::ClassObject, the arguments to pass to the
+   *   constructor.
    *
    * @return array
    *   An array of results.

lib/Drupal/Core/Database/TransactionOutOfOrderException.php

@@ -3,6 +3,9 @@
 namespace Drupal\Core\Database;
 
 /**
- * Exception thrown when a rollBack() resulted in other active transactions being rolled-back.
+ * Exception thrown transactions are out of order.
+ *
+ * This is thrown when a rollBack() resulted in other active transactions being
+ * rolled-back.
  */
 class TransactionOutOfOrderException extends TransactionException implements DatabaseException {}

lib/Drupal/Core/DependencyInjection/Compiler/BackwardsCompatibilityClassLoaderPass.php

@@ -8,7 +8,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
- * Defines a compiler pass to merge moved classes into a single container parameter.
+ * Compiler pass to merge moved classes into a single container parameter.
  */
 class BackwardsCompatibilityClassLoaderPass implements CompilerPassInterface {
 

lib/Drupal/Core/DrupalKernel.php

@@ -1468,7 +1468,7 @@ protected function getHttpKernel() {
   }
 
   /**
-   * Returns the active configuration storage to use during building the container.
+   * Gets the active configuration storage to use during building the container.
    *
    * @return \Drupal\Core\Config\StorageInterface
    *   The configuration storage.

lib/Drupal/Core/Entity/EntityLastInstalledSchemaRepositoryInterface.php

@@ -125,7 +125,7 @@ public function deleteLastInstalledDefinition($entity_type_id);
   public function getLastInstalledFieldStorageDefinitions($entity_type_id);
 
   /**
-   * Stores the entity type's field storage definitions in the application state.
+   * Puts the entity type's field storage definitions in the application state.
    *
    * @param string $entity_type_id
    *   The entity type identifier.

lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionInterface.php

@@ -63,7 +63,7 @@ public function countReferenceableEntities($match = NULL, $match_operator = 'CON
   public function validateReferenceableEntities(array $ids);
 
   /**
-   * Allows the selection to alter the SelectQuery generated by EntityFieldQuery.
+   * Allows altering the SelectQuery generated by EntityFieldQuery.
    *
    * @param \Drupal\Core\Database\Query\SelectInterface $query
    *   A Select Query object.

lib/Drupal/Core/Entity/EntityTypeInterface.php

@@ -736,8 +736,8 @@ public function getListCacheTags();
   /**
    * The list cache tags associated with a specific bundle.
    *
-   * Enables code listing entities of this type and bundle to ensure that newly created
-   * entities show up immediately.
+   * Enables code listing entities of this type and bundle to ensure that newly
+   * created entities show up immediately.
    *
    * @return string[]
    *   An array of the cache tags for this bundle.

lib/Drupal/Core/Entity/EntityTypeListenerInterface.php

@@ -3,7 +3,7 @@
 namespace Drupal\Core\Entity;
 
 /**
- * Defines an interface for reacting to entity type creation, deletion, and updates.
+ * Interface for entity type create, delete and update operations.
  */
 interface EntityTypeListenerInterface {
 

lib/Drupal/Core/Entity/Query/ConditionAggregateBase.php

@@ -3,7 +3,7 @@
 namespace Drupal\Core\Entity\Query;
 
 /**
- * Defines a common base class for all aggregation entity condition implementations.
+ * A common base class for all aggregation entity condition implementations.
  */
 abstract class ConditionAggregateBase extends ConditionFundamentals implements ConditionAggregateInterface {
 

lib/Drupal/Core/Extension/ExtensionNameLengthException.php

@@ -3,6 +3,6 @@
 namespace Drupal\Core\Extension;
 
 /**
- * Exception thrown when the extension's name length exceeds the allowed maximum.
+ * Exception thrown when the extension's name length exceeds the maximum.
  */
 class ExtensionNameLengthException extends \Exception {}

lib/Drupal/Core/Extension/InstallRequirementsInterface.php

@@ -16,11 +16,12 @@ interface InstallRequirementsInterface {
    * During the 'install' phase, modules can for example assert that
    * library or server versions are available or sufficient.
    * Note that the installation of a module can happen during installation of
-   * Drupal itself (by install.php) with an installation profile or later by hand.
-   * As a consequence, install-time requirements must be checked without access
-   * to the full Drupal API, because it is not available during install.php.
-   * If a requirement has a severity of REQUIREMENT_ERROR, install.php will abort
-   * or at least the module will not install.
+   * Drupal itself (by install.php) with an installation profile or later by
+   * hand. As a consequence, install-time requirements must be checked without
+   * access to the full Drupal API, because it is not available during
+   * install.php.
+   * If a requirement has a severity of REQUIREMENT_ERROR, install.php will
+   * abort or at least the module will not install.
    * Other severity levels have no effect on the installation.
    * Module dependencies do not belong to these installation requirements,
    * but should be defined in the module's .info.yml file.

lib/Drupal/Core/Extension/ModuleHandler.php

@@ -202,8 +202,10 @@ protected function add($type, $name, $path) {
     // A module freshly added will not be registered on the container yet.
     // ProceduralCall service does not yet know about it.
     // Note in HookCollectorPass:
+    // phpcs:ignore Drupal.Files.LineLength
     // - $container->register(ProceduralCall::class, ProceduralCall::class)->addArgument($collector->includes);
-    // Load all includes so the legacy section of invoke can handle hooks in includes.
+    // Load all includes so the legacy section of invoke can handle hooks in
+    // includes.
     $hook_collector->loadAllIncludes();
     // Register procedural implementations.
     foreach ($hook_collector->getImplementations() as $hook => $moduleImplements) {

lib/Drupal/Core/Field/FieldStorageDefinitionListenerInterface.php

@@ -3,7 +3,7 @@
 namespace Drupal\Core\Field;
 
 /**
- * Defines an interface for reacting to field storage definition creation, deletion, and updates.
+ * Interface for field storage definition create, delete and update operations.
  */
 interface FieldStorageDefinitionListenerInterface {
 

lib/Drupal/Core/Field/WidgetBase.php

@@ -625,6 +625,7 @@ public static function setWidgetState(array $parents, $field_name, FormStateInte
    */
   protected static function getWidgetStateParents(array $parents, $field_name) {
     // Field processing data is placed at
+    // phpcs:ignore Drupal.Files.LineLength
     // $form_state->get(['field_storage', '#parents', ...$parents..., '#fields', $field_name]),
     // to avoid clashes between field names and $parents parts.
     return array_merge(['field_storage', '#parents'], $parents, ['#fields', $field_name]);

lib/Drupal/Core/Form/FormState.php

@@ -383,7 +383,7 @@ class FormState implements FormStateInterface {
   protected $has_file_element;
 
   /**
-   * Contains references to details elements to render them within vertical tabs.
+   * The references to details elements to render them within vertical tabs.
    *
    * This property is uncacheable.
    *

lib/Drupal/Core/Language/LanguageInterface.php

@@ -36,7 +36,7 @@ interface LanguageInterface {
    * Should be used when we explicitly know that the data referred has no
    * linguistic content.
    *
-   * See https://www.w3.org/International/questions/qa-no-language#nonlinguistic.
+   * @see https://www.w3.org/International/questions/qa-no-language#nonlinguistic
    */
   const LANGCODE_NOT_APPLICABLE = 'zxx';
 

lib/Drupal/Core/Routing/UrlGenerator.php

@@ -196,13 +196,24 @@ protected function doGenerate(array $variables, array $defaults, array $tokens,
     // variables up to the start of the path must be supplied to there is no
     // gap.
     $optional = TRUE;
-    // Structure of $tokens from the compiled route:
-    // If the path is /admin/config/user-interface/shortcut/manage/{shortcut_set}/add-link-inline
-    // [ [ 0 => 'text', 1 => '/add-link-inline' ], [ 0 => 'variable', 1 => '/', 2 => '[^/]++', 3 => 'shortcut_set' ], [ 0 => 'text', 1 => '/admin/config/user-interface/shortcut/manage' ] ]
+    // The structure of the tokens array varies according to the compiled route.
+    // Examples:
+    // @code
+    // [
+    //  [0 => 'text', 1 => '/add-link-inline'],
+    //  [0 => 'variable', 1 => '/', 2 => '[^/]++', 3 => 'shortcut_set'],
+    //  [0 => 'text', 1 => '/admin/config/user-interface/shortcut/manage'],
+    // ]
+    // @endcode
+    // This is the structure for the "shortcut.link_add_inline" route.
     //
-    // For a simple fixed path, there is just one token.
-    // If the path is /admin/config
-    // [ [ 0 => 'text', 1 => '/admin/config' ] ]
+    // @code
+    // [
+    //   [ 0 => 'text', 1 => '/admin/config' ]
+    // ]
+    // @endcode
+    // This is the structure for a simple fixed path, "/admin/config:. there is
+    // just one token.
     foreach ($tokens as $token) {
       if ('variable' === $token[0]) {
         if (!$optional || !array_key_exists($token[3], $defaults) || (isset($mergedParams[$token[3]]) && (string) $mergedParams[$token[3]] !== (string) $defaults[$token[3]])) {