diff --git a/core/core.api.php b/core/core.api.php index 639e55d..931af14 100644 --- a/core/core.api.php +++ b/core/core.api.php @@ -456,9 +456,9 @@ * * When you request a cache object, you can specify the bin name in your call to * \Drupal::cache(). Alternatively, you can request a bin by getting service - * "cache.nameofbin" from the container. The default bin is called "default", with - * service name "cache.default", it is used to store common and frequently used - * caches. + * "cache.nameofbin" from the container. The default bin is called "default", + * with service name "cache.default", it is used to store common and frequently + * used caches. * * Other common cache bins are the following: * - bootstrap: Data needed from the beginning to the end of most requests, diff --git a/core/includes/batch.inc b/core/includes/batch.inc index f84c01b..dcc7772 100644 --- a/core/includes/batch.inc +++ b/core/includes/batch.inc @@ -179,7 +179,8 @@ function _batch_progress_page() { 'batch_progress_meta_refresh', ), ), - // Adds JavaScript code and settings for clients where JavaScript is enabled. + // Adds JavaScript code and settings for clients where JavaScript is + // enabled. 'drupalSettings' => [ 'batch' => [ 'errorMessage' => $current_set['error_message'] . '
' . $batch['error_message'], diff --git a/core/includes/bootstrap.inc b/core/includes/bootstrap.inc index 71895b2..9325514 100644 --- a/core/includes/bootstrap.inc +++ b/core/includes/bootstrap.inc @@ -726,7 +726,7 @@ function drupal_installation_attempted() { * installation state. At all other times, the "install_profile" setting will be * available in settings.php. * - * @return string|null $profile + * @return string|null * The name of the installation profile or NULL if no installation profile is * currently active. This is the case for example during the first steps of * the installer or during unit tests. diff --git a/core/includes/common.inc b/core/includes/common.inc index 037c5b0..6ccd014 100644 --- a/core/includes/common.inc +++ b/core/includes/common.inc @@ -89,17 +89,20 @@ 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 (and their + * associated states and themes.). */ const CSS_COMPONENT = 0; /** - * The default weight for CSS rules that style states and are not included with components. + * The default weight for CSS rules that style states and are 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 CSS rules that style themes and are not included with + * components. */ const CSS_THEME = 200; @@ -688,13 +691,14 @@ function drupal_process_states(&$elements) { * - 'self' affects the dragged row itself. * - 'group' affects the dragged row, plus any children below it (the entire * dragged group). - * - 'group': A class name applied on all related form elements for this action. + * - 'group': A class name applied on all related form elements for this + * action. * - 'subgroup': (optional) If the group has several subgroups within it, this * string should contain the class name identifying fields in the same * subgroup. - * - 'source': (optional) If the $action is 'match', this string should contain - * the classname identifying what field will be used as the source value - * when matching the value in $subgroup. + * - 'source': (optional) If the $action is 'match', this string should + * contain the classname identifying what field will be used as the source + * value when matching the value in $subgroup. * - 'hidden': (optional) The column containing the field elements may be * entirely hidden from view dynamically when the JavaScript is loaded. Set * to FALSE if the column should not be hidden. @@ -1025,7 +1029,8 @@ function element_info_property($type, $property_name, $default = NULL) { } /** - * Flushes all persistent caches, resets all variables, and rebuilds all data structures. + * Flushes all persistent caches, resets all variables, and rebuilds all data + * structures. * * At times, it is necessary to re-initialize the entire system to account for * changed or new code. This function: diff --git a/core/includes/database.inc b/core/includes/database.inc index ff03885..29ba632 100644 --- a/core/includes/database.inc +++ b/core/includes/database.inc @@ -1015,8 +1015,11 @@ function db_drop_index($table, $name) { * * @deprecated as of Drupal 8.0.x, will be removed in Drupal 9.0.0. Instead, get * a database connection injected into your service from the container, get - * its schema driver, and call changeField() on it. For example, - * $injected_database->schema()->changeField($table, $field, $field_new, $spec, $keys_new); + * its schema driver, and call changeField() on it. For example: + * @code + * $schema = $injected_database->schema(); + * $schema->changeField($table, $field, $field_new, $spec, $keys_new); + * @endcode * * @see \Drupal\Core\Database\Schema::changeField() */ diff --git a/core/includes/errors.inc b/core/includes/errors.inc index e3ad1c8..7cb9eec 100644 --- a/core/includes/errors.inc +++ b/core/includes/errors.inc @@ -192,7 +192,8 @@ function _drupal_log_error($error, $fatal = FALSE) { if ($fatal) { if (error_displayable($error)) { // When called from JavaScript, simply output the error message. - // Should not translate the string to avoid errors producing more errors. + // Should not translate the string to avoid errors producing more + // errors. $response->setContent(SafeMarkup::format('%type: @message in %function (line %line of %file).', $error)); $response->send(); } @@ -250,8 +251,8 @@ function _drupal_log_error($error, $fatal = FALSE) { } if ($fatal) { - // We fallback to a maintenance page at this point, because the page generation - // itself can generate errors. + // We fallback to a maintenance page at this point, because the page + // generation itself can generate errors. // Should not translate the string to avoid errors producing more errors. $message = 'The website encountered an unexpected error. Please try again later.' . '
' . $message; diff --git a/core/includes/form.inc b/core/includes/form.inc index d44f404..0e09f8d 100644 --- a/core/includes/form.inc +++ b/core/includes/form.inc @@ -91,8 +91,8 @@ function form_select_options($element, $choices = NULL) { } $choices = $element['#options']; } - // array_key_exists() accommodates the rare event where $element['#value'] is NULL. - // isset() fails in this situation. + // array_key_exists() accommodates the rare event where $element['#value'] is + // NULL. isset() fails in this situation. $value_valid = isset($element['#value']) || array_key_exists('#value', $element); $value_is_array = $value_valid && is_array($element['#value']); // Check if the element is multiple select and no value has been selected. @@ -850,7 +850,8 @@ function batch_process($redirect = NULL, Url $url = NULL, $redirect_callback = N // Store the batch. \Drupal::service('batch.storage')->create($batch); - // Set the batch number in the session to guarantee that it will stay alive. + // Set the batch number in the session to guarantee that it will stay + // alive. $_SESSION['batches'][$batch['id']] = TRUE; // Redirect for processing. diff --git a/core/includes/install.core.inc b/core/includes/install.core.inc index ceb9982..c590662 100644 --- a/core/includes/install.core.inc +++ b/core/includes/install.core.inc @@ -1679,8 +1679,9 @@ function _install_prepare_import($langcodes, $server_pattern) { // Get the version information. if ($version = $matches[1]) { $info = _install_get_version_info($version); - // Picking the first file does not necessarily result in the right file. So - // we check if at least the major version number is available. + // Picking the first file does not necessarily result in the right + // file. So, we check if at least the major version number is + // available. if ($info['major']) { $core = $info['major'] . '.x'; $data = array( diff --git a/core/includes/install.inc b/core/includes/install.inc index 3a9c2bc..d78b850 100644 --- a/core/includes/install.inc +++ b/core/includes/install.inc @@ -114,9 +114,10 @@ function drupal_install_profile_distribution_name() { /** * Loads the installation profile, extracting its defined version. * - * @return string Distribution version defined in the profile's .info.yml file. - * Defaults to \Drupal::VERSION if no version is explicitly provided - * by the installation profile. + * @return string + * Distribution version defined in the profile's .info.yml file. Defaults to + * \Drupal::VERSION if no version is explicitly provided by the installation + * profile. * * @see install_profile_info() */ @@ -217,7 +218,8 @@ function drupal_rewrite_settings($settings = array(), $settings_file = NULL) { if (!isset($settings_file)) { $settings_file = \Drupal::service('site.path') . '/settings.php'; } - // Build list of setting names and insert the values into the global namespace. + // Build list of setting names and insert the values into the global + // namespace. $variable_names = array(); $settings_settings = array(); foreach ($settings as $setting => $data) { @@ -302,7 +304,8 @@ function drupal_rewrite_settings($settings = array(), $settings_file = NULL) { $value = _drupal_rewrite_settings_dump_one($current); // Unsetting $current would not affect $settings at all. unset($parent[$index]); - // Skip the semicolon because _drupal_rewrite_settings_dump_one() added one. + // Skip the semicolon because _drupal_rewrite_settings_dump_one() + // added one. $state = 'semicolon_skip'; } else { @@ -510,10 +513,10 @@ function drupal_install_config_directories() { ))); } elseif (is_writable($config_directories[CONFIG_SYNC_DIRECTORY])) { - // Put a README.txt into the sync config directory. This is required so that - // they can later be added to git. Since this directory is auto-created, we - // have to write out the README rather than just adding it to the drupal core - // repo. + // Put a README.txt into the sync config directory. This is required so + // that they can later be added to git. Since this directory is + // auto-created, we have to write out the README rather than just adding it + // to the drupal core repo. $text = 'This directory contains configuration to be imported into your Drupal site. To make this configuration active, visit admin/config/development/configuration/sync.' . ' For information about deploying configuration between servers, see https://www.drupal.org/documentation/administer/config'; file_put_contents(config_get_config_directory(CONFIG_SYNC_DIRECTORY) . '/README.txt', $text); } @@ -874,8 +877,8 @@ function install_goto($path) { * @return * The URL of the current script, with query parameters modified by the * passed-in $query. The URL is not sanitized, so it still needs to be run - * through \Drupal\Component\Utility\UrlHelper::filterBadProtocol() if it will be - * used as an HTML attribute value. + * through \Drupal\Component\Utility\UrlHelper::filterBadProtocol() if it + * will be used as an HTML attribute value. * * @see drupal_requirements_url() * @see Drupal\Component\Utility\UrlHelper::filterBadProtocol() diff --git a/core/includes/tablesort.inc b/core/includes/tablesort.inc index 95642b3..f01b27b 100644 --- a/core/includes/tablesort.inc +++ b/core/includes/tablesort.inc @@ -56,7 +56,8 @@ function tablesort_header(&$cell_content, array &$cell_attributes, array $header $image = drupal_render($tablesort_indicator); } else { - // If the user clicks a different header, we want to sort ascending initially. + // If the user clicks a different header, we want to sort ascending + // initially. $ts['sort'] = 'asc'; $image = ''; } diff --git a/core/includes/theme.inc b/core/includes/theme.inc index 9b89250..1403df8 100644 --- a/core/includes/theme.inc +++ b/core/includes/theme.inc @@ -711,7 +711,8 @@ function template_preprocess_links(&$variables) { $url = $link['url']; if ($url->isRouted()) { // Add a "data-drupal-link-system-path" attribute to let the - // drupal.active-link library know the path in a standardized manner. + // drupal.active-link library know the path in a standardized + // manner. $system_path = $url->getInternalPath(); // @todo System path is deprecated - use the route name and parameters. // Special case for the front page. @@ -957,8 +958,8 @@ function template_preprocess_table(&$variables) { // Track responsive classes for each column as needed. Only the header // cells for a column are marked up with the responsive classes by a - // module developer or themer. The responsive classes on the header cells - // must be transferred to the content cells. + // module developer or themer. The responsive classes on the header + // cells must be transferred to the content cells. if (!empty($cell['class']) && is_array($cell['class'])) { if (in_array(RESPONSIVE_PRIORITY_MEDIUM, $cell['class'])) { $responsive_classes[$responsive_index] = RESPONSIVE_PRIORITY_MEDIUM; diff --git a/core/includes/theme.maintenance.inc b/core/includes/theme.maintenance.inc index 80cc52c..2d42072 100644 --- a/core/includes/theme.maintenance.inc +++ b/core/includes/theme.maintenance.inc @@ -31,7 +31,8 @@ function _drupal_maintenance_theme() { require_once __DIR__ . '/database.inc'; Unicode::check(); - // Install and update pages are treated differently to prevent theming overrides. + // Install and update pages are treated differently to prevent theming + // overrides. if (defined('MAINTENANCE_MODE') && (MAINTENANCE_MODE == 'install' || MAINTENANCE_MODE == 'update')) { if (drupal_installation_attempted()) { $custom_theme = $GLOBALS['install_state']['theme']; diff --git a/core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php b/core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php index e564fd0..c7d6e6d 100644 --- a/core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php +++ b/core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php @@ -63,8 +63,8 @@ class AnnotatedClassDiscovery implements DiscoveryInterface { * (optional) An array of namespace that may contain plugin implementations. * Defaults to an empty array. * @param string $plugin_definition_annotation_name - * (optional) The name of the annotation that contains the plugin definition. - * Defaults to 'Drupal\Component\Annotation\Plugin'. + * (optional) The name of the annotation that contains the plugin + * definition. Defaults to 'Drupal\Component\Annotation\Plugin'. * @param string[] $annotation_namespaces * (optional) Additional namespaces to be scanned for annotation classes. */ @@ -124,7 +124,8 @@ public function getDefinitions() { if ($fileinfo->getExtension() == 'php') { if ($cached = $this->fileCache->get($fileinfo->getPathName())) { if (isset($cached['id'])) { - // Explicitly unserialize this to create a new object instance. + // Explicitly unserialize this to create a new object + // instance. $definitions[$cached['id']] = unserialize($cached['content']); } continue; diff --git a/core/lib/Drupal/Component/Datetime/DateTimePlus.php b/core/lib/Drupal/Component/Datetime/DateTimePlus.php index 56bd92f..2249f32 100644 --- a/core/lib/Drupal/Component/Datetime/DateTimePlus.php +++ b/core/lib/Drupal/Component/Datetime/DateTimePlus.php @@ -223,9 +223,9 @@ public static function createFromFormat($format, $time, $timezone = NULL, $setti else { // Functions that parse date is forgiving, it might create a date that // is not exactly a match for the provided value, so test for that by - // re-creating the date/time formatted string and comparing it to the input. For - // instance, an input value of '11' using a format of Y (4 digits) gets - // created as '0011' instead of '2011'. + // re-creating the date/time formatted string and comparing it to the + // input. For instance, an input value of '11' using a format of Y (4 + // digits) gets created as '0011' instead of '2011'. if ($date instanceof DateTimePlus) { $test_time = $date->format($format, $settings); } diff --git a/core/lib/Drupal/Component/FileCache/FileCacheFactory.php b/core/lib/Drupal/Component/FileCache/FileCacheFactory.php index 15b2026..d9d5a10 100644 --- a/core/lib/Drupal/Component/FileCache/FileCacheFactory.php +++ b/core/lib/Drupal/Component/FileCache/FileCacheFactory.php @@ -39,7 +39,8 @@ class FileCacheFactory { * The initialized FileCache object. */ public static function get($collection, $default_configuration = []) { - // If there is a special key in the configuration, disable FileCache completely. + // If there is a special key in the configuration, disable FileCache + // completely. if (!empty(static::$configuration[static::DISABLE_CACHE])) { return new NullFileCache('', ''); } diff --git a/core/lib/Drupal/Component/Gettext/PoStreamReader.php b/core/lib/Drupal/Component/Gettext/PoStreamReader.php index faaa95f..0e1511a 100644 --- a/core/lib/Drupal/Component/Gettext/PoStreamReader.php +++ b/core/lib/Drupal/Component/Gettext/PoStreamReader.php @@ -337,7 +337,8 @@ private function readLine() { $this->_current_item = array(); } elseif ($this->_context == 'MSGID') { - // We are currently already in the context, meaning we passed an id with no data. + // We are currently already in the context, meaning we passed an id + // with no data. $this->_errors[] = SafeMarkup::format('The translation stream %uri contains an error: "msgid" is unexpected on line %line.', $log_vars); return FALSE; } @@ -455,7 +456,8 @@ private function readLine() { return; } elseif ($line != '') { - // Anything that is not a token may be a continuation of a previous token. + // Anything that is not a token may be a continuation of a previous + // token. $quoted = $this->parseQuoted($line); if ($quoted === FALSE) { diff --git a/core/lib/Drupal/Component/Graph/Graph.php b/core/lib/Drupal/Component/Graph/Graph.php index 5d8d5ca..91006b9 100644 --- a/core/lib/Drupal/Component/Graph/Graph.php +++ b/core/lib/Drupal/Component/Graph/Graph.php @@ -50,8 +50,8 @@ public function __construct($graph) { * this vertex. * - 'reverse_paths': Contains a list of vertices that has a path from them * to this vertex. - * - 'weight': If there is a path from a vertex to another then the weight of - * the latter is higher. + * - 'weight': If there is a path from a vertex to another then the weight + * of the latter is higher. * - 'component': Vertices in the same component have the same component * identifier. */ @@ -99,7 +99,8 @@ public function searchAndSort() { * @see \Drupal\Component\Graph\Graph::searchAndSort() */ protected function depthFirstSearch(&$state, $start, &$component = NULL) { - // Assign new component for each new vertex, i.e. when not called recursively. + // Assign new component for each new vertex, i.e. when not called + // recursively. if (!isset($component)) { $component = $start; } diff --git a/core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php b/core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php index 5dc159f..c752eb4 100644 --- a/core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php +++ b/core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php @@ -18,7 +18,8 @@ class FileReadOnlyStorage implements PhpStorageInterface { * Constructs this FileStorage object. * * @param $configuration - * An associative array, containing at least two keys (the rest are ignored): + * An associative array, containing at least two keys (the rest are + * ignored): * - directory: The directory where the files should be stored. * - bin: The storage bin. Multiple storage objects can be instantiated with * the same configuration, but for different bins. diff --git a/core/lib/Drupal/Component/PhpStorage/FileStorage.php b/core/lib/Drupal/Component/PhpStorage/FileStorage.php index 1e6a2b3..4c9babc 100644 --- a/core/lib/Drupal/Component/PhpStorage/FileStorage.php +++ b/core/lib/Drupal/Component/PhpStorage/FileStorage.php @@ -59,7 +59,8 @@ public function save($name, $code) { } /** - * Returns the standard .htaccess lines that Drupal writes to file directories. + * Returns the standard .htaccess lines that Drupal writes to file + * directories. * * @param bool $private * (optional) Set to FALSE to return the .htaccess lines for an open and diff --git a/core/lib/Drupal/Component/Plugin/Discovery/StaticDiscoveryDecorator.php b/core/lib/Drupal/Component/Plugin/Discovery/StaticDiscoveryDecorator.php index 889d146..c2ee922 100644 --- a/core/lib/Drupal/Component/Plugin/Discovery/StaticDiscoveryDecorator.php +++ b/core/lib/Drupal/Component/Plugin/Discovery/StaticDiscoveryDecorator.php @@ -22,7 +22,7 @@ class StaticDiscoveryDecorator extends StaticDiscovery { protected $registerDefinitions; /** - * Constructs a \Drupal\Component\Plugin\Discovery\StaticDiscoveryDecorator object. + * Constructor. * * @param \Drupal\Component\Plugin\Discovery\DiscoveryInterface $decorated * The discovery object that is being decorated. diff --git a/core/lib/Drupal/Component/Plugin/Factory/DefaultFactory.php b/core/lib/Drupal/Component/Plugin/Factory/DefaultFactory.php index 2cca811..ae66303 100644 --- a/core/lib/Drupal/Component/Plugin/Factory/DefaultFactory.php +++ b/core/lib/Drupal/Component/Plugin/Factory/DefaultFactory.php @@ -17,7 +17,8 @@ class DefaultFactory implements FactoryInterface { /** - * The object that retrieves the definitions of the plugins that this factory instantiates. + * The object that retrieves the definitions of the plugins that this factory + * instantiates. * * The plugin definition includes the plugin class and possibly other * information necessary for proper instantiation. diff --git a/core/lib/Drupal/Component/Plugin/Factory/ReflectionFactory.php b/core/lib/Drupal/Component/Plugin/Factory/ReflectionFactory.php index 9954422..84d6910 100644 --- a/core/lib/Drupal/Component/Plugin/Factory/ReflectionFactory.php +++ b/core/lib/Drupal/Component/Plugin/Factory/ReflectionFactory.php @@ -32,7 +32,8 @@ public function createInstance($plugin_id, array $configuration = array()) { } /** - * Inspects the plugin class and build a list of arguments for the constructor. + * Inspects the plugin class and builds a list of arguments for the + * constructor. * * This is provided as a helper method so factories extending this class can * replace this and insert their own reflection logic. diff --git a/core/lib/Drupal/Component/Plugin/PluginManagerBase.php b/core/lib/Drupal/Component/Plugin/PluginManagerBase.php index 5fb32a2..e37ac06 100644 --- a/core/lib/Drupal/Component/Plugin/PluginManagerBase.php +++ b/core/lib/Drupal/Component/Plugin/PluginManagerBase.php @@ -27,7 +27,8 @@ protected $factory; /** - * The object that returns the preconfigured plugin instance appropriate for a particular runtime condition. + * The object that returns the preconfigured plugin instance appropriate for a + * particular runtime condition. * * @var \Drupal\Component\Plugin\Mapper\MapperInterface */ diff --git a/core/lib/Drupal/Component/Utility/DiffArray.php b/core/lib/Drupal/Component/Utility/DiffArray.php index 719049e..ced319e 100644 --- a/core/lib/Drupal/Component/Utility/DiffArray.php +++ b/core/lib/Drupal/Component/Utility/DiffArray.php @@ -21,8 +21,8 @@ class DiffArray { * The array to compare to. * * @return array - * Returns an array containing all the values from array1 that are not present - * in array2. + * Returns an array containing all the values from array1 that are not + * present in array2. */ public static function diffAssocRecursive(array $array1, array $array2) { $difference = array(); diff --git a/core/lib/Drupal/Component/Utility/Environment.php b/core/lib/Drupal/Component/Utility/Environment.php index bfee60c..36a621c 100644 --- a/core/lib/Drupal/Component/Utility/Environment.php +++ b/core/lib/Drupal/Component/Utility/Environment.php @@ -11,9 +11,9 @@ class Environment { * Compares the memory required for an operation to the available memory. * * @param string $required - * The memory required for the operation, expressed as a number of bytes with - * optional SI or IEC binary unit prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, 8bytes, - * 9mbytes). + * The memory required for the operation, expressed as a number of bytes + * with optional SI or IEC binary unit prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, + * 8bytes, 9mbytes). * @param $memory_limit * (optional) The memory limit for the operation, expressed as a number of * bytes with optional SI or IEC binary unit prefix (e.g. 2, 3K, 5MB, 10G, diff --git a/core/lib/Drupal/Component/Utility/Html.php b/core/lib/Drupal/Component/Utility/Html.php index 5456cfa..156e952 100644 --- a/core/lib/Drupal/Component/Utility/Html.php +++ b/core/lib/Drupal/Component/Utility/Html.php @@ -119,7 +119,8 @@ public static function cleanCssIdentifier($identifier, array $filter = array( // - ISO 10646 characters U+00A1 and higher // We strip out any character not in the above list. $identifier = preg_replace('/[^\x{002D}\x{0030}-\x{0039}\x{0041}-\x{005A}\x{005F}\x{0061}-\x{007A}\x{00A1}-\x{FFFF}]/u', '', $identifier); - // Identifiers cannot start with a digit, two hyphens, or a hyphen followed by a digit. + // Identifiers cannot start with a digit, two hyphens, or a hyphen followed + // by a digit. $identifier = preg_replace(array( '/^[0-9]/', '/^(-[0-9])|^(--)/' @@ -215,12 +216,12 @@ public static function getUniqueId($id) { public static function getId($id) { $id = str_replace([' ', '_', '[', ']'], ['-', '-', '-', ''], Unicode::strtolower($id)); - // As defined in http://www.w3.org/TR/html4/types.html#type-name, HTML IDs can - // only contain letters, digits ([0-9]), hyphens ("-"), underscores ("_"), - // colons (":"), and periods ("."). We strip out any character not in that - // list. Note that the CSS spec doesn't allow colons or periods in identifiers - // (http://www.w3.org/TR/CSS21/syndata.html#characters), so we strip those two - // characters as well. + // As defined in http://www.w3.org/TR/html4/types.html#type-name, HTML IDs + // can only contain letters, digits ([0-9]), hyphens ("-"), underscores + // ("_"), colons (":"), and periods ("."). We strip out any character not in + // that list. Note that the CSS spec doesn't allow colons or periods in + // identifiers (http://www.w3.org/TR/CSS21/syndata.html#characters), so we + // strip those two characters as well. $id = preg_replace('/[^A-Za-z0-9\-_]/', '', $id); // Removing multiple consecutive hyphens. @@ -402,9 +403,9 @@ public static function decodeEntities($text) { * Html::decodeEntities() will convert all HTML entities to UTF-8 bytes, * including "é" and "<" to "é" and "<". * - * When constructing @link theme_render render arrays @endlink passing the output of Html::escape() to - * '#markup' is not recommended. Use the '#plain_text' key instead and the - * renderer will autoescape the text. + * When constructing @link theme_render render arrays @endlink passing the + * output of Html::escape() to '#markup' is not recommended. Use the + * '#plain_text' key instead and the renderer will autoescape the text. * * @param string $text * The input text. diff --git a/core/lib/Drupal/Component/Utility/NestedArray.php b/core/lib/Drupal/Component/Utility/NestedArray.php index 0b7cf4f..6b52ad8 100644 --- a/core/lib/Drupal/Component/Utility/NestedArray.php +++ b/core/lib/Drupal/Component/Utility/NestedArray.php @@ -3,7 +3,7 @@ namespace Drupal\Component\Utility; /** - * Provides helpers to perform operations on nested arrays and array keys of variable depth. + * Performs operations on nested arrays and array keys of variable depth. * * @ingroup utility */ @@ -147,8 +147,8 @@ public static function &getValue(array &$array, array $parents, &$key_exists = N public static function setValue(array &$array, array $parents, $value, $force = FALSE) { $ref = &$array; foreach ($parents as $parent) { - // PHP auto-creates container arrays and NULL entries without error if $ref - // is NULL, but throws an error if $ref is set, but not an array. + // PHP auto-creates container arrays and NULL entries without error if + // $ref is NULL, but throws an error if $ref is set, but not an array. if ($force && isset($ref) && !is_array($ref)) { $ref = array(); } diff --git a/core/lib/Drupal/Component/Utility/Number.php b/core/lib/Drupal/Component/Utility/Number.php index 39143d9..15bfefa 100644 --- a/core/lib/Drupal/Component/Utility/Number.php +++ b/core/lib/Drupal/Component/Utility/Number.php @@ -48,8 +48,8 @@ public static function validStep($value, $step, $offset = 0.0) { // $remainder is a double precision floating point number. Remainders that // can't be represented with single precision floats are acceptable. The - // fractional part of a float has 24 bits. That means remainders smaller than - // $step * 2^-24 are acceptable. + // fractional part of a float has 24 bits. That means remainders smaller + // than $step * 2^-24 are acceptable. $computed_acceptable_error = (double)($step / pow(2.0, 24)); return $computed_acceptable_error >= $remainder || $remainder >= ($step - $computed_acceptable_error); diff --git a/core/lib/Drupal/Component/Utility/Random.php b/core/lib/Drupal/Component/Utility/Random.php index 3a00839..3ec83d7 100644 --- a/core/lib/Drupal/Component/Utility/Random.php +++ b/core/lib/Drupal/Component/Utility/Random.php @@ -131,7 +131,9 @@ public function name($length = 8, $unique = FALSE) { } /** - * Generate a string that looks like a word (letters only, alternating consonants and vowels). + * Generate a string that looks like a word. + * + * Use letters only, alternating consonants and vowels. * * @param int $length * The desired word length. diff --git a/core/lib/Drupal/Component/Utility/SortArray.php b/core/lib/Drupal/Component/Utility/SortArray.php index 2ef6223..789583c 100644 --- a/core/lib/Drupal/Component/Utility/SortArray.php +++ b/core/lib/Drupal/Component/Utility/SortArray.php @@ -55,8 +55,8 @@ public static function sortByWeightProperty($a, $b) { * Callback for uasort(). * * @param array $a - * First item for comparison. The compared items should be associative arrays - * that optionally include a 'title' key. + * First item for comparison. The compared items should be associative + * arrays that optionally include a 'title' key. * @param array $b * Second item for comparison. * @@ -73,8 +73,8 @@ public static function sortByTitleElement($a, $b) { * Callback for uasort(). * * @param array $a - * First item for comparison. The compared items should be associative arrays - * that optionally include a '#title' key. + * First item for comparison. The compared items should be associative + * arrays that optionally include a '#title' key. * @param array $b * Second item for comparison. * diff --git a/core/lib/Drupal/Component/Utility/Unicode.php b/core/lib/Drupal/Component/Utility/Unicode.php index f6b4668..9c6089e 100644 --- a/core/lib/Drupal/Component/Utility/Unicode.php +++ b/core/lib/Drupal/Component/Utility/Unicode.php @@ -12,17 +12,18 @@ class Unicode { /** * Matches Unicode characters that are word boundaries. * - * Characters with the following General_category (gc) property values are used - * as word boundaries. While this does not fully conform to the Word Boundaries - * algorithm described in http://unicode.org/reports/tr29, as PCRE does not - * contain the Word_Break property table, this simpler algorithm has to do. + * Characters with the following General_category (gc) property values are + * used as word boundaries. While this does not fully conform to the Word + * Boundaries algorithm described in http://unicode.org/reports/tr29, as PCRE + * does not contain the Word_Break property table, this simpler algorithm has + * to do. * - Cc, Cf, Cn, Co, Cs: Other. * - Pc, Pd, Pe, Pf, Pi, Po, Ps: Punctuation. * - Sc, Sk, Sm, So: Symbols. * - Zl, Zp, Zs: Separators. * - * Non-boundary characters include the following General_category (gc) property - * values: + * Non-boundary characters include the following General_category (gc) + * property values: * - Ll, Lm, Lo, Lt, Lu: Letters. * - Mc, Me, Mn: Combining Marks. * - Nd, Nl, No: Numbers. @@ -240,8 +241,8 @@ public static function convertToUtf8($data, $encoding) { /** * Truncates a UTF-8-encoded string safely to a number of bytes. * - * If the end position is in the middle of a UTF-8 sequence, it scans backwards - * until the beginning of the byte sequence. + * If the end position is in the middle of a UTF-8 sequence, it scans + * backwards until the beginning of the byte sequence. * * Use this function whenever you want to chop off a string at an unsure * location. On the other hand, if you're sure that you're splitting on a @@ -497,24 +498,25 @@ public static function substr($text, $start, $length = NULL) { * If TRUE, attempt to truncate on a word boundary. Word boundaries are * spaces, punctuation, and Unicode characters used as word boundaries in * non-Latin languages; see Unicode::PREG_CLASS_WORD_BOUNDARY for more - * information. If a word boundary cannot be found that would make the length - * of the returned string fall within length guidelines (see parameters - * $max_length and $min_wordsafe_length), word boundaries are ignored. + * information. If a word boundary cannot be found that would make the + * length of the returned string fall within length guidelines (see + * parameters $max_length and $min_wordsafe_length), word boundaries are + * ignored. * @param bool $add_ellipsis * If TRUE, add '...' to the end of the truncated string (defaults to * FALSE). The string length will still fall within $max_length. * @param int $min_wordsafe_length - * If $wordsafe is TRUE, the minimum acceptable length for truncation (before - * adding an ellipsis, if $add_ellipsis is TRUE). Has no effect if $wordsafe - * is FALSE. This can be used to prevent having a very short resulting string - * that will not be understandable. For instance, if you are truncating the - * string "See myverylongurlexample.com for more information" to a word-safe - * return length of 20, the only available word boundary within 20 characters - * is after the word "See", which wouldn't leave a very informative string. If - * you had set $min_wordsafe_length to 10, though, the function would realise - * that "See" alone is too short, and would then just truncate ignoring word - * boundaries, giving you "See myverylongurl..." (assuming you had set - * $add_ellipses to TRUE). + * If $wordsafe is TRUE, the minimum acceptable length for truncation + * (before adding an ellipsis, if $add_ellipsis is TRUE). Has no effect if + * $wordsafe is FALSE. This can be used to prevent having a very short + * resulting string that will not be understandable. For instance, if you + * are truncating the string "See myverylongurlexample.com for more + * information" to a word-safe return length of 20, the only available word + * boundary within 20 characters is after the word "See", which wouldn't + * leave a very informative string. If you had set $min_wordsafe_length to + * 10, though, the function would realise that "See" alone is too short, and + * would then just truncate ignoring word boundaries, giving you "See + * myverylongurl..." (assuming you had set $add_ellipses to TRUE). * * @return string * The truncated string. @@ -543,9 +545,9 @@ public static function truncate($string, $max_length, $wordsafe = FALSE, $add_el if ($wordsafe) { $matches = array(); - // Find the last word boundary, if there is one within $min_wordsafe_length - // to $max_length characters. preg_match() is always greedy, so it will - // find the longest string possible. + // Find the last word boundary, if there is one within + // $min_wordsafe_length to $max_length characters. preg_match() is always + // greedy, so it will find the longest string possible. $found = preg_match('/^(.{' . $min_wordsafe_length . ',' . $max_length . '})[' . Unicode::PREG_CLASS_WORD_BOUNDARY . ']/u', $string, $matches); if ($found) { $string = $matches[1]; @@ -639,7 +641,8 @@ public static function mimeHeaderDecode($header) { } return $data; }; - // First step: encoded chunks followed by other encoded chunks (need to collapse whitespace) + // First step: encoded chunks followed by other encoded chunks (need to + // collapse whitespace) $header = preg_replace_callback('/=\?([^?]+)\?(Q|B)\?([^?]+|\?(?!=))\?=\s+(?==\?)/', $callback, $header); // Second step: remaining chunks (do not collapse whitespace) return preg_replace_callback('/=\?([^?]+)\?(Q|B)\?([^?]+|\?(?!=))\?=/', $callback, $header); @@ -668,10 +671,10 @@ public static function caseFlip($matches) { * When text containing an invalid UTF-8 lead byte (0xC0 - 0xFF) is presented * as UTF-8 to Internet Explorer 6, the program may misinterpret subsequent * bytes. When these subsequent bytes are HTML control characters such as - * quotes or angle brackets, parts of the text that were deemed safe by filters - * end up in locations that are potentially unsafe; An onerror attribute that - * is outside of a tag, and thus deemed safe by a filter, can be interpreted - * by the browser as if it were inside the tag. + * quotes or angle brackets, parts of the text that were deemed safe by + * filters end up in locations that are potentially unsafe; An onerror + * attribute that is outside of a tag, and thus deemed safe by a filter, can + * be interpreted by the browser as if it were inside the tag. * * The function does not return FALSE for strings containing character codes * above U+10FFFF, even though these are prohibited by RFC 3629. diff --git a/core/lib/Drupal/Component/Utility/UrlHelper.php b/core/lib/Drupal/Component/Utility/UrlHelper.php index 1395d81..ddfabda 100644 --- a/core/lib/Drupal/Component/Utility/UrlHelper.php +++ b/core/lib/Drupal/Component/Utility/UrlHelper.php @@ -349,8 +349,8 @@ public static function stripDangerousProtocols($uri) { // We found a colon, possibly a protocol. Verify. $protocol = substr($uri, 0, $colonpos); // If a colon is preceded by a slash, question mark or hash, it cannot - // possibly be part of the URL scheme. This must be a relative URL, which - // inherits the (safe) protocol of the base document. + // possibly be part of the URL scheme. This must be a relative URL, + // which inherits the (safe) protocol of the base document. if (preg_match('![/?#]!', $protocol)) { break; } diff --git a/core/lib/Drupal/Component/Utility/Variable.php b/core/lib/Drupal/Component/Utility/Variable.php index 5a83079..28a3511 100644 --- a/core/lib/Drupal/Component/Utility/Variable.php +++ b/core/lib/Drupal/Component/Utility/Variable.php @@ -15,7 +15,8 @@ class Variable { * @param mixed $var * The variable to export. * @param string $prefix - * A prefix that will be added at the beginning of every lines of the output. + * A prefix that will be added at the beginning of every lines of the + * output. * * @return string * The variable exported in a way compatible to Drupal's coding standards. diff --git a/core/phpcs.xml.dist b/core/phpcs.xml.dist index e82c85a..7f0b18c 100644 --- a/core/phpcs.xml.dist +++ b/core/phpcs.xml.dist @@ -2,6 +2,7 @@ Default PHP CodeSniffer configuration for Drupal core. . + @@ -62,6 +63,7 @@ +