From 2dc84b0eef3d56db8ad992724acd60c309c0523c Mon Sep 17 00:00:00 2001 From: nod_ <nod_@598310.no-reply.drupal.org> Date: Fri, 31 Jan 2025 09:54:10 +0100 Subject: [PATCH] Issue #3497102 by quietone, smustgrave: Fix LineLength for doc block paragraphs --- core/core.api.php | 3 +- core/lib/Drupal.php | 18 +++--- core/lib/Drupal/Component/Utility/Html.php | 6 +- core/lib/Drupal/Component/Utility/Unicode.php | 25 ++++---- core/lib/Drupal/Core/Ajax/MessageCommand.php | 4 +- .../Core/Cache/CacheBackendInterface.php | 21 ++++--- core/lib/Drupal/Core/Database/Database.php | 7 ++- .../Drupal/Core/Database/Query/Condition.php | 5 +- .../Database/Query/PagerSelectExtender.php | 4 +- .../lib/Drupal/Core/Database/Query/Select.php | 4 +- .../Core/Database/Query/SelectExtender.php | 10 +-- .../Core/Database/Query/SelectInterface.php | 20 +++--- core/lib/Drupal/Core/Database/Schema.php | 39 ++++++------ .../Core/Database/StatementInterface.php | 4 +- .../lib/Drupal/Core/Database/database.api.php | 4 +- .../Drupal/Core/Datetime/DrupalDateTime.php | 4 +- .../Core/Datetime/Element/DateElementBase.php | 6 +- .../Drupal/Core/Datetime/Element/Datelist.php | 10 +-- .../Drupal/Core/Datetime/Element/Datetime.php | 13 ++-- .../Entity/Annotation/ContentEntityType.php | 10 +-- ...EntityDefinitionUpdateManagerInterface.php | 6 +- .../Core/Entity/EntityTypeInterface.php | 6 +- core/lib/Drupal/Core/Entity/entity.api.php | 4 +- .../Core/Extension/ModuleHandlerInterface.php | 6 +- core/lib/Drupal/Core/Extension/module.api.php | 4 +- .../Drupal/Core/Field/FieldItemInterface.php | 7 ++- .../Core/Field/FieldItemListInterface.php | 4 +- .../EntityReferenceItemInterface.php | 3 +- .../Form/FileTransferAuthorizeForm.php | 4 +- .../lib/Drupal/Core/Mail/MailFormatHelper.php | 5 +- .../Core/Menu/MenuLinkManagerInterface.php | 10 +-- .../PathProcessor/PathProcessorManager.php | 4 +- .../Core/Render/BareHtmlPageRenderer.php | 3 +- .../Drupal/Core/Render/Element/Actions.php | 10 +-- core/lib/Drupal/Core/Render/Element/Email.php | 3 +- .../Core/Render/Element/MachineName.php | 3 +- core/lib/Drupal/Core/Render/Element/Url.php | 3 +- .../Core/Render/PlaceholderingRenderCache.php | 3 +- core/lib/Drupal/Core/Render/theme.api.php | 16 +++-- .../Drupal/Core/StreamWrapper/LocalStream.php | 4 +- core/lib/Drupal/Core/Utility/link.api.php | 10 +-- core/modules/big_pipe/src/Render/BigPipe.php | 18 ++++-- core/modules/block/block.api.php | 10 +-- .../src/BlockContentViewBuilder.php | 8 +-- .../src/Hook/BlockContentHooks.php | 8 +-- .../src/Functional/BlockContentSaveTest.php | 4 +- .../ckeditor5/src/HTMLRestrictions.php | 4 +- .../src/Hook/ConfigTranslationTestHooks.php | 8 +-- .../src/Hook/ContentTranslationHooks.php | 45 +++++++------- .../contextual/src/Hook/ContextualHooks.php | 4 +- .../dblog/src/Controller/DbLogController.php | 6 +- core/modules/dblog/src/Hook/DblogHooks.php | 3 +- core/modules/editor/src/Hook/EditorHooks.php | 4 +- core/modules/field/src/Hook/FieldHooks.php | 47 +++++++------- .../src/Plugin/Field/FieldType/FileItem.php | 4 +- .../tests/file_test/src/FileTestHelper.php | 3 +- core/modules/image/src/Hook/ImageHooks.php | 3 +- .../image/src/Hook/ImageViewsHooks.php | 4 +- .../Events/CollectRelationshipMetaEvent.php | 4 +- .../Events/CollectResourceObjectMetaEvent.php | 4 +- .../language/src/Hook/LanguageHooks.php | 6 +- .../src/Hook/LayoutBuilderHooks.php | 10 +-- core/modules/locale/locale.bulk.inc | 3 +- .../locale_test/src/Hook/LocaleTestHooks.php | 10 +-- .../migrate/src/Event/MigrateEvents.php | 3 +- .../migrate/source/SourcePluginBase.php | 4 +- .../src/Driver/Database/mysql/Schema.php | 8 +-- core/modules/node/node.api.php | 4 +- core/modules/node/src/Hook/NodeHooks1.php | 62 ++++++++++--------- core/modules/search/search.module | 8 +-- .../Normalizer/TimestampItemNormalizer.php | 6 +- .../src/Hook/SettingsTrayHooks.php | 7 ++- .../src/Controller/LinksetController.php | 3 +- .../system/src/Form/ThemeSettingsForm.php | 6 +- core/modules/system/src/Hook/SystemHooks.php | 4 +- .../common_test/src/Hook/CommonTestHooks.php | 4 +- .../src/Controller/TestController.php | 4 +- .../Entity/EntityCacheTagsTestBase.php | 3 +- .../src/Functional/System/CronRunTest.php | 4 +- .../taxonomy/src/Hook/TaxonomyHooks.php | 12 ++-- .../taxonomy/src/Hook/TaxonomyViewsHooks.php | 4 +- core/modules/update/src/Hook/UpdateHooks.php | 21 ++++--- .../src/Controller/UpdateTestController.php | 8 +-- .../update_test/src/Hook/UpdateTestHooks.php | 22 +++---- .../views/src/Ajax/ReplaceTitleCommand.php | 3 +- .../views/src/Ajax/ShowButtonsCommand.php | 3 +- .../views/src/Ajax/TriggerPreviewCommand.php | 3 +- core/modules/views/src/Hook/ViewsHooks.php | 4 +- .../views/src/Hook/ViewsViewsHooks.php | 12 ++-- core/modules/views/src/ManyToOneHelper.php | 12 ++-- .../ArgumentDefaultPluginBase.php | 7 ++- .../ArgumentValidatorPluginBase.php | 4 +- .../views/display/DisplayPluginInterface.php | 4 +- .../src/Plugin/views/field/MachineName.php | 3 +- .../src/Plugin/views/filter/InOperator.php | 3 +- .../Plugin/views/wizard/WizardPluginBase.php | 16 ++--- core/modules/views_ui/src/ViewEditForm.php | 4 +- core/modules/views_ui/src/ViewFormBase.php | 4 +- .../workflows/src/Annotation/WorkflowType.php | 3 +- .../workflows/src/Attribute/WorkflowType.php | 3 +- .../Config/ConfigEntityValidationTestBase.php | 4 +- .../Core/DrupalKernel/DrupalKernelTest.php | 4 +- .../UniqueValuesConstraintValidatorTest.php | 9 ++- .../Utility/ArgumentsResolverTest.php | 3 +- .../Tests/Component/Utility/HtmlTest.php | 5 +- .../Tests/Component/Utility/UnicodeTest.php | 3 +- 106 files changed, 466 insertions(+), 402 deletions(-) diff --git a/core/core.api.php b/core/core.api.php index 316036556281..be7286bfc78a 100644 --- a/core/core.api.php +++ b/core/core.api.php @@ -1251,7 +1251,8 @@ * https://www.drupal.org/docs/theming-drupal * - Modules: Modules add to or alter the behavior and functionality of Drupal, * by using one or more of the methods listed below. For more information - * about creating modules, see https://www.drupal.org/docs/creating-custom-modules + * about creating modules, see + * https://www.drupal.org/docs/creating-custom-modules * - Installation profiles: Installation profiles can be used to * create distributions, which are complete specific-purpose packages of * Drupal including additional modules, themes, and data. For more diff --git a/core/lib/Drupal.php b/core/lib/Drupal.php index 691982c0d2cc..fbdf4405f5ed 100644 --- a/core/lib/Drupal.php +++ b/core/lib/Drupal.php @@ -15,8 +15,9 @@ * * The container is built by the kernel and passed in to this class which stores * it statically. The container always contains the services from - * \Drupal\Core\CoreServiceProvider, the service providers of enabled modules and any other - * service providers defined in $GLOBALS['conf']['container_service_providers']. + * \Drupal\Core\CoreServiceProvider, the service providers of enabled modules + * and any other service providers defined in + * $GLOBALS['conf']['container_service_providers']. * * This class exists only to support legacy code that cannot be dependency * injected. If your code needs it, consider refactoring it to be object @@ -479,8 +480,9 @@ public static function keyValue($collection) { * Use this to store machine-generated data, local to a specific environment * that does not need deploying and does not need human editing; for example, * the last time cron was run. Data which needs to be edited by humans and - * needs to be the same across development, production, etc. environments - * (for example, the system maintenance message) should use \Drupal::config() instead. + * needs to be the same across development, production, etc. environments (for + * example, the system maintenance message) should use \Drupal::config() + * instead. * * @return \Drupal\Core\State\StateInterface */ @@ -616,10 +618,10 @@ public static function languageManager() { /** * Returns the CSRF token manager service. * - * The generated token is based on the session ID of the current user. Normally, - * anonymous users do not have a session, so the generated token will be - * different on every page request. To generate a token for users without a - * session, manually start a session prior to calling this function. + * The generated token is based on the session ID of the current user. + * Normally, anonymous users do not have a session, so the generated token + * will be different on every page request. To generate a token for users + * without a session, manually start a session prior to calling this function. * * @return \Drupal\Core\Access\CsrfTokenGenerator * The CSRF token manager. diff --git a/core/lib/Drupal/Component/Utility/Html.php b/core/lib/Drupal/Component/Utility/Html.php index d5e8636aef89..bd66a1d29f3a 100644 --- a/core/lib/Drupal/Component/Utility/Html.php +++ b/core/lib/Drupal/Component/Utility/Html.php @@ -414,9 +414,9 @@ public static function decodeEntities(string $text): string { * 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/Unicode.php b/core/lib/Drupal/Component/Utility/Unicode.php index 84f1707e5241..07533665622e 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. @@ -190,8 +191,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 @@ -378,10 +379,10 @@ public static function strcasecmp($str1, $str2) { * 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/Core/Ajax/MessageCommand.php b/core/lib/Drupal/Core/Ajax/MessageCommand.php index dbcf989fa7f7..765291ed1d1f 100644 --- a/core/lib/Drupal/Core/Ajax/MessageCommand.php +++ b/core/lib/Drupal/Core/Ajax/MessageCommand.php @@ -9,7 +9,9 @@ /** * AJAX command for a JavaScript Drupal.message() call. * - * AJAX command that allows you to add messages from an Ajax response. The command will create a new Drupal.Message() object and call its addMessage() method. + * AJAX command that allows you to add messages from an Ajax response. The + * command will create a new Drupal.Message() object and call its addMessage() + * method. * * Usage examples: * Here are examples of how to suppress announcements: diff --git a/core/lib/Drupal/Core/Cache/CacheBackendInterface.php b/core/lib/Drupal/Core/Cache/CacheBackendInterface.php index 20bdc8ab04f2..3232401a00af 100644 --- a/core/lib/Drupal/Core/Cache/CacheBackendInterface.php +++ b/core/lib/Drupal/Core/Cache/CacheBackendInterface.php @@ -123,8 +123,9 @@ public function setMultiple(array $items); * * If the cache item is being deleted because it is no longer "fresh", you may * consider using invalidate() instead. This allows callers to retrieve the - * invalid item by calling get() with $allow_invalid set to TRUE. In some cases - * an invalid item may be acceptable rather than having to rebuild the cache. + * invalid item by calling get() with $allow_invalid set to TRUE. In some + * cases an invalid item may be acceptable rather than having to rebuild the + * cache. * * @param string $cid * The cache ID to delete. @@ -140,8 +141,8 @@ public function delete($cid); * * If the cache items are being deleted because they are no longer "fresh", * you may consider using invalidateMultiple() instead. This allows callers to - * retrieve the invalid items by calling get() with $allow_invalid set to TRUE. - * In some cases an invalid item may be acceptable rather than having to + * retrieve the invalid items by calling get() with $allow_invalid set to + * TRUE. In some cases an invalid item may be acceptable rather than having to * rebuild the cache. * * @param array $cids @@ -165,8 +166,8 @@ public function deleteAll(); /** * Marks a cache item as invalid. * - * Invalid items may be returned in later calls to get(), if the $allow_invalid - * argument is TRUE. + * Invalid items may be returned in later calls to get(), if the + * $allow_invalid argument is TRUE. * * @param string $cid * The cache ID to invalidate. @@ -180,8 +181,8 @@ public function invalidate($cid); /** * Marks cache items as invalid. * - * Invalid items may be returned in later calls to get(), if the $allow_invalid - * argument is TRUE. + * Invalid items may be returned in later calls to get(), if the + * $allow_invalid argument is TRUE. * * @param string[] $cids * An array of cache IDs to invalidate. @@ -195,8 +196,8 @@ public function invalidateMultiple(array $cids); /** * Marks all cache items as invalid. * - * Invalid items may be returned in later calls to get(), if the $allow_invalid - * argument is TRUE. + * Invalid items may be returned in later calls to get(), if the + * $allow_invalid argument is TRUE. * * @see \Drupal\Core\Cache\CacheBackendInterface::deleteAll() * @see \Drupal\Core\Cache\CacheBackendInterface::invalidate() diff --git a/core/lib/Drupal/Core/Database/Database.php b/core/lib/Drupal/Core/Database/Database.php index d4ce475bd9da..18c893d40164 100644 --- a/core/lib/Drupal/Core/Database/Database.php +++ b/core/lib/Drupal/Core/Database/Database.php @@ -476,9 +476,10 @@ public static function closeConnection($target = NULL, $key = NULL) { /** * Instructs the system to temporarily ignore a given key/target. * - * At times we need to temporarily disable replica queries. To do so, call this - * method with the database key and the target to disable. That database key - * will then always fall back to 'default' for that key, even if it's defined. + * At times we need to temporarily disable replica queries. To do so, call + * this method with the database key and the target to disable. That database + * key will then always fall back to 'default' for that key, even if it's + * defined. * * @param string $key * The database connection key. diff --git a/core/lib/Drupal/Core/Database/Query/Condition.php b/core/lib/Drupal/Core/Database/Query/Condition.php index bbe2f2be2f43..89757a754f05 100644 --- a/core/lib/Drupal/Core/Database/Query/Condition.php +++ b/core/lib/Drupal/Core/Database/Query/Condition.php @@ -351,8 +351,9 @@ public function __toString() { /** * PHP magic __clone() method. * - * Only copies fields that implement Drupal\Core\Database\Query\ConditionInterface. Also sets - * $this->changed to TRUE. + * Only copies fields that implement + * Drupal\Core\Database\Query\ConditionInterface. Also sets $this->changed to + * TRUE. */ public function __clone() { $this->changed = TRUE; diff --git a/core/lib/Drupal/Core/Database/Query/PagerSelectExtender.php b/core/lib/Drupal/Core/Database/Query/PagerSelectExtender.php index 7fac5d8d8021..91e79d7c09cf 100644 --- a/core/lib/Drupal/Core/Database/Query/PagerSelectExtender.php +++ b/core/lib/Drupal/Core/Database/Query/PagerSelectExtender.php @@ -84,8 +84,8 @@ public function execute() { /** * Ensure that there is an element associated with this query. * - * After running this method, access $this->element to get the element for this - * query. + * After running this method, access $this->element to get the element for + * this query. */ protected function ensureElement() { if (!isset($this->element)) { diff --git a/core/lib/Drupal/Core/Database/Query/Select.php b/core/lib/Drupal/Core/Database/Query/Select.php index 3632775f45bd..295fd46a0a65 100644 --- a/core/lib/Drupal/Core/Database/Query/Select.php +++ b/core/lib/Drupal/Core/Database/Query/Select.php @@ -56,8 +56,8 @@ class Select extends Query implements SelectInterface { /** * The fields by which to order this query. * - * This is an associative array. The keys are the fields to order, and the value - * is the direction to order, either ASC or DESC. + * This is an associative array. The keys are the fields to order, and the + * value is the direction to order, either ASC or DESC. * * @var array */ diff --git a/core/lib/Drupal/Core/Database/Query/SelectExtender.php b/core/lib/Drupal/Core/Database/Query/SelectExtender.php index 61d91867a892..016143e5faba 100644 --- a/core/lib/Drupal/Core/Database/Query/SelectExtender.php +++ b/core/lib/Drupal/Core/Database/Query/SelectExtender.php @@ -503,11 +503,11 @@ public function __clone() { /** * Magic override for undefined methods. * - * If one extender extends another extender, then methods in the inner extender - * will not be exposed on the outer extender. That's because we cannot know - * in advance what those methods will be, so we cannot provide wrapping - * implementations as we do above. Instead, we use this slower catch-all method - * to handle any additional methods. + * If one extender extends another extender, then methods in the inner + * extender will not be exposed on the outer extender. That's because we + * cannot know in advance what those methods will be, so we cannot provide + * wrapping implementations as we do above. Instead, we use this slower + * catch-all method to handle any additional methods. */ public function __call($method, $args) { $return = call_user_func_array([$this->query, $method], $args); diff --git a/core/lib/Drupal/Core/Database/Query/SelectInterface.php b/core/lib/Drupal/Core/Database/Query/SelectInterface.php index 573b955e68d8..97bd2da4a12d 100644 --- a/core/lib/Drupal/Core/Database/Query/SelectInterface.php +++ b/core/lib/Drupal/Core/Database/Query/SelectInterface.php @@ -34,9 +34,9 @@ public function &getFields(); /** * Returns a reference to the expressions array for this query. * - * Because this method returns by reference, alter hooks may edit the expressions - * array directly to make their changes. If just adding expressions, however, the - * use of addExpression() is preferred. + * Because this method returns by reference, alter hooks may edit the + * expressions array directly to make their changes. If just adding + * expressions, however, the use of addExpression() is preferred. * * Note that this method must be called by reference as well: * @@ -328,9 +328,9 @@ public function leftJoin($table, $alias = NULL, $condition = NULL, $arguments = /** * Join against another table in the database. * - * This method does the "hard" work of queueing up a table to be joined against. - * In some cases, that may include dipping into the Schema API to find the necessary - * fields on which to join. + * This method does the "hard" work of queueing up a table to be joined + * against. In some cases, that may include dipping into the Schema API to + * find the necessary fields on which to join. * * @param string $type * The type of join. Typically one of INNER, LEFT OUTER, and RIGHT OUTER. @@ -362,8 +362,8 @@ public function addJoin($type, $table, $alias = NULL, $condition = NULL, $argume /** * Orders the result set by a given field. * - * If called multiple times, the query will order by each specified field in the - * order this method is called. + * If called multiple times, the query will order by each specified field in + * the order this method is called. * * If the query uses DISTINCT or GROUP BY conditions, fields or expressions * that are used for the order must be selected to be compatible with some @@ -504,8 +504,8 @@ public function execute(); * Helper function to build most common HAVING conditional clauses. * * This method can take a variable number of parameters. If called with two - * parameters, they are taken as $field and $value with $operator having a value - * of IN if $value is an array and = otherwise. + * parameters, they are taken as $field and $value with $operator having a + * value of IN if $value is an array and = otherwise. * * @param string $field * The name of the field to check. If you would like to add a more complex diff --git a/core/lib/Drupal/Core/Database/Schema.php b/core/lib/Drupal/Core/Database/Schema.php index 4180ede8eba2..190f8816fa31 100644 --- a/core/lib/Drupal/Core/Database/Schema.php +++ b/core/lib/Drupal/Core/Database/Schema.php @@ -145,18 +145,18 @@ protected function executeDdlStatement(string $sql, array $arguments = [], array /** * Build a condition to match a table name against a standard information_schema. * - * The information_schema is a SQL standard that provides information about the - * database server and the databases, schemas, tables, columns and users within - * it. This makes information_schema a useful tool to use across the drupal - * database drivers and is used by a few different functions. The function below - * describes the conditions to be meet when querying information_schema.tables - * for drupal tables or information associated with drupal tables. Even though - * this is the standard method, not all databases follow standards and so this - * method should be overwritten by a database driver if the database provider - * uses alternate methods. Because information_schema.tables is used in a few - * different functions, a database driver will only need to override this function - * to make all the others work. For example see - * core/includes/databases/mysql/schema.inc. + * The information_schema is a SQL standard that provides information about + * the database server and the databases, schemas, tables, columns and users + * within it. This makes information_schema a useful tool to use across the + * drupal database drivers and is used by a few different functions. The + * function below describes the conditions to be meet when querying + * information_schema.tables for drupal tables or information associated with + * drupal tables. Even though this is the standard method, not all databases + * follow standards and so this method should be overwritten by a database + * driver if the database provider uses alternate methods. Because + * information_schema.tables is used in a few different functions, a database + * driver will only need to override this function to make all the others + * work. For example see core/includes/databases/mysql/schema.inc. * * @param string $table_name * The name of the table in question. @@ -286,8 +286,9 @@ public function fieldExists($table, $column) { * Returns a mapping of Drupal schema field names to DB-native field types. * * Because different field types do not map 1:1 between databases, Drupal has - * its own normalized field type names. This function returns a driver-specific - * mapping table from Drupal names to the native names for each database. + * its own normalized field type names. This function returns a + * driver-specific mapping table from Drupal names to the native names for + * each database. * * @return array * An array of Schema API field types to driver-specific field types. @@ -587,9 +588,9 @@ protected function introspectIndexSchema($table) { * * The reasons for this are due to the different database engines: * - * On PostgreSQL, changing a field definition involves adding a new field - * and dropping an old one which* causes any indices, primary keys and - * sequences (from serial-type fields) that use the changed field to be dropped. + * On PostgreSQL, changing a field definition involves adding a new field and + * dropping an old one which* causes any indices, primary keys and sequences + * (from serial-type fields) that use the changed field to be dropped. * * On MySQL, all type 'serial' fields must be part of at least one key * or index as soon as they are created. You cannot use @@ -677,8 +678,8 @@ protected function createTableSql($name, $table) { /** * Return 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. + * This is usually an identity function but if a key/index uses a column + * prefix specification, this function extracts just the name. * * @param array $fields * An array of key/index column specifiers. diff --git a/core/lib/Drupal/Core/Database/StatementInterface.php b/core/lib/Drupal/Core/Database/StatementInterface.php index f39426db4358..c7d19201ffa6 100644 --- a/core/lib/Drupal/Core/Database/StatementInterface.php +++ b/core/lib/Drupal/Core/Database/StatementInterface.php @@ -117,8 +117,8 @@ public function fetchField($index = 0); /** * Fetches the next row and returns it as an object. * - * The object will be of the class specified by StatementInterface::setFetchMode() - * or stdClass if not specified. + * The object will be of the class specified by + * StatementInterface::setFetchMode() or stdClass if not specified. * * @param string|null $class_name * Name of the created class. diff --git a/core/lib/Drupal/Core/Database/database.api.php b/core/lib/Drupal/Core/Database/database.api.php index 82c8ab76579c..62d63d367166 100644 --- a/core/lib/Drupal/Core/Database/database.api.php +++ b/core/lib/Drupal/Core/Database/database.api.php @@ -469,8 +469,8 @@ /** * Perform alterations to a structured query. * - * Structured (aka dynamic) queries that have tags associated may be altered by any module - * before the query is executed. + * Structured (aka dynamic) queries that have tags associated may be altered by + * any module before the query is executed. * * @param Drupal\Core\Database\Query\AlterableInterface $query * A Query object describing the composite parts of a SQL query. diff --git a/core/lib/Drupal/Core/Datetime/DrupalDateTime.php b/core/lib/Drupal/Core/Datetime/DrupalDateTime.php index 6a5fe5abde53..a3b18a70c3d9 100644 --- a/core/lib/Drupal/Core/Datetime/DrupalDateTime.php +++ b/core/lib/Drupal/Core/Datetime/DrupalDateTime.php @@ -12,8 +12,8 @@ * This class extends the basic component and adds in Drupal-specific * handling, like translation of the format() method. * - * Static methods in base class can also be used to create DrupalDateTime objects. - * For example: + * Static methods in base class can also be used to create DrupalDateTime + * objects. For example: * * @code * DrupalDateTime::createFromArray(['year' => 2010, 'month' => 9, 'day' => 28]) diff --git a/core/lib/Drupal/Core/Datetime/Element/DateElementBase.php b/core/lib/Drupal/Core/Datetime/Element/DateElementBase.php index 5119ffc743c7..e5303340624d 100644 --- a/core/lib/Drupal/Core/Datetime/Element/DateElementBase.php +++ b/core/lib/Drupal/Core/Datetime/Element/DateElementBase.php @@ -17,9 +17,9 @@ abstract class DateElementBase extends FormElementBase { * Handles a string like -3:+3 or 2001:2010 to describe a dynamic range of * minimum and maximum years to use in a date selector. * - * Centers the range around the current year, if any, but expands it far enough - * so it will pick up the year value in the field in case the value in the field - * is outside the initial range. + * Centers the range around the current year, if any, but expands it far + * enough so it will pick up the year value in the field in case the value in + * the field is outside the initial range. * * @param string $string * A min and max year string like '-3:+1' or '2000:2010' or '2000:+3'. diff --git a/core/lib/Drupal/Core/Datetime/Element/Datelist.php b/core/lib/Drupal/Core/Datetime/Element/Datelist.php index 830bfde75f1c..bd8e5d2860c1 100644 --- a/core/lib/Drupal/Core/Datetime/Element/Datelist.php +++ b/core/lib/Drupal/Core/Datetime/Element/Datelist.php @@ -131,11 +131,11 @@ public static function valueCallback(&$element, $input, FormStateInterface $form * * Required settings: * - #default_value: A DrupalDateTime object, adjusted to the proper local - * timezone. Converting a date stored in the database from UTC to the local - * zone and converting it back to UTC before storing it is not handled here. - * This element accepts a date as the default value, and then converts the - * user input strings back into a new date object on submission. No timezone - * adjustment is performed. + * timezone. Converting a date stored in the database from UTC to the + * local zone and converting it back to UTC before storing it is not + * handled here. This element accepts a date as the default value, and + * then converts the user input strings back into a new date object on + * submission. No timezone adjustment is performed. * Optional properties include: * - #date_part_order: Array of date parts indicating the parts and order * that should be used in the selector, optionally including 'ampm' for diff --git a/core/lib/Drupal/Core/Datetime/Element/Datetime.php b/core/lib/Drupal/Core/Datetime/Element/Datetime.php index da56bb08427f..2fe09a7558fe 100644 --- a/core/lib/Drupal/Core/Datetime/Element/Datetime.php +++ b/core/lib/Drupal/Core/Datetime/Element/Datetime.php @@ -145,11 +145,11 @@ public static function valueCallback(&$element, $input, FormStateInterface $form * * Required settings: * - #default_value: A DrupalDateTime object, adjusted to the proper local - * timezone. Converting a date stored in the database from UTC to the local - * zone and converting it back to UTC before storing it is not handled here. - * This element accepts a date as the default value, and then converts the - * user input strings back into a new date object on submission. No timezone - * adjustment is performed. + * timezone. Converting a date stored in the database from UTC to the + * local zone and converting it back to UTC before storing it is not + * handled here. This element accepts a date as the default value, and + * then converts the user input strings back into a new date object on + * submission. No timezone adjustment is performed. * Optional properties include: * - #date_date_format: A date format string that describes the format that * should be displayed to the end user for the date. When using HTML5 @@ -179,7 +179,8 @@ public static function valueCallback(&$element, $input, FormStateInterface $form * right HTML5 format for the chosen element if an HTML5 element is used, * otherwise defaults to DateFormat::load('html_time')->getPattern(). * - #date_time_callbacks: An array of optional callbacks for the time - * element. Can be used to add a jQuery timepicker or an 'All day' checkbox. + * element. Can be used to add a jQuery timepicker or an 'All day' + * checkbox. * - #date_year_range: A description of the range of years to allow, like * '1900:2050', '-3:+3' or '2000:+3', where the first value describes the * earliest year and the second the latest year in the range. A year diff --git a/core/lib/Drupal/Core/Entity/Annotation/ContentEntityType.php b/core/lib/Drupal/Core/Entity/Annotation/ContentEntityType.php index 70e120ef0da8..aa7d16325beb 100644 --- a/core/lib/Drupal/Core/Entity/Annotation/ContentEntityType.php +++ b/core/lib/Drupal/Core/Entity/Annotation/ContentEntityType.php @@ -7,11 +7,11 @@ /** * Defines a content entity type annotation object. * - * Content Entity type plugins use an object-based annotation method, rather than an - * array-type annotation method (as commonly used on other annotation types). - * The annotation properties of content entity types are found on - * \Drupal\Core\Entity\ContentEntityType and are accessed using - * get/set methods defined in \Drupal\Core\Entity\ContentEntityTypeInterface. + * Content Entity type plugins use an object-based annotation method, rather + * than an array-type annotation method (as commonly used on other annotation + * types). The annotation properties of content entity types are found on + * \Drupal\Core\Entity\ContentEntityType and are accessed using get/set methods + * defined in \Drupal\Core\Entity\ContentEntityTypeInterface. * * @ingroup entity_api * diff --git a/core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php b/core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php index 5f28d54fdafe..e71659dea12f 100644 --- a/core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php @@ -19,9 +19,9 @@ * specified by the current codebase. It also has create/update/delete methods * to bring the former up to date with the latter. * - * However, it is not the responsibility of entity last installed schema repository - * to decide how to report the differences or when to apply each update. This - * interface is for managing that. + * However, it is not the responsibility of entity last installed schema + * repository to decide how to report the differences or when to apply each + * update. This interface is for managing that. * * This interface also provides methods to retrieve instances of the definitions * to be updated ready to be manipulated. In fact when definitions change in diff --git a/core/lib/Drupal/Core/Entity/EntityTypeInterface.php b/core/lib/Drupal/Core/Entity/EntityTypeInterface.php index c8d231138ad4..c7275d31fef8 100644 --- a/core/lib/Drupal/Core/Entity/EntityTypeInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityTypeInterface.php @@ -380,9 +380,9 @@ public function setHandlerClass($handler_type, $value); /** * Gets the name of the default administrative permission. * - * The default \Drupal\Core\Entity\EntityAccessControlHandler class checks this - * permission for all operations in its checkAccess() method. Entities with - * more complex permissions can extend this class to do their own access + * The default \Drupal\Core\Entity\EntityAccessControlHandler class checks + * this permission for all operations in its checkAccess() method. Entities + * with more complex permissions can extend this class to do their own access * checks. * * @return string|bool diff --git a/core/lib/Drupal/Core/Entity/entity.api.php b/core/lib/Drupal/Core/Entity/entity.api.php index 9829d56f6e2b..82fea8aed03d 100644 --- a/core/lib/Drupal/Core/Entity/entity.api.php +++ b/core/lib/Drupal/Core/Entity/entity.api.php @@ -426,8 +426,8 @@ * entity interface you have defined as its parameter, and returns routing * information for the entity page; see node_uri() for an example. You will * also need to add a corresponding route to your module's routing.yml file; - * see the entity.node.canonical route in node.routing.yml for an example, and see - * @ref sec_routes below for some notes. + * see the entity.node.canonical route in node.routing.yml for an example, and + * see @ref sec_routes below for some notes. * - Optionally, instead of defining routes, routes can be auto generated by * providing a route handler. See @ref sec_routes. Otherwise, define routes * and links for the various URLs associated with the entity. diff --git a/core/lib/Drupal/Core/Extension/ModuleHandlerInterface.php b/core/lib/Drupal/Core/Extension/ModuleHandlerInterface.php index a38ff224cafb..aeded22ca926 100644 --- a/core/lib/Drupal/Core/Extension/ModuleHandlerInterface.php +++ b/core/lib/Drupal/Core/Extension/ModuleHandlerInterface.php @@ -317,9 +317,9 @@ public function invokeAllDeprecated($description, $hook, array $args = []); * hook_TYPE_alter() implementations in modules. It ensures a consistent * interface for all altering operations. * - * A maximum of 2 alterable arguments is supported. In case more arguments need - * to be passed and alterable, modules provide additional variables assigned by - * reference in the last $context argument: + * A maximum of 2 alterable arguments is supported. In case more arguments + * need to be passed and alterable, modules provide additional variables + * assigned by reference in the last $context argument: * @code * $context = [ * 'alterable' => &$alterable, diff --git a/core/lib/Drupal/Core/Extension/module.api.php b/core/lib/Drupal/Core/Extension/module.api.php index 8806c706e805..4d75b1ab469f 100644 --- a/core/lib/Drupal/Core/Extension/module.api.php +++ b/core/lib/Drupal/Core/Extension/module.api.php @@ -181,8 +181,8 @@ function hook_module_preinstall($module, bool $is_syncing): void { * This function differs from hook_install() in that it gives all other modules * a chance to perform actions when a module is installed, whereas * hook_install() is only called on the module actually being installed. See - * \Drupal\Core\Extension\ModuleInstaller::install() for a detailed description of - * the order in which install hooks are invoked. + * \Drupal\Core\Extension\ModuleInstaller::install() for a detailed description + * of the order in which install hooks are invoked. * * This hook should be implemented in a .module file, not in an .install file. * diff --git a/core/lib/Drupal/Core/Field/FieldItemInterface.php b/core/lib/Drupal/Core/Field/FieldItemInterface.php index 32e81d7350cf..f00aebbc046f 100644 --- a/core/lib/Drupal/Core/Field/FieldItemInterface.php +++ b/core/lib/Drupal/Core/Field/FieldItemInterface.php @@ -331,8 +331,8 @@ public static function storageSettingsToConfigData(array $settings); /** * Returns a settings array in the field type's canonical representation. * - * This function does the inverse of static::storageSettingsToConfigData(). It's - * called when loading a field's settings from a configuration object. + * This function does the inverse of static::storageSettingsToConfigData(). + * It's called when loading a field's settings from a configuration object. * * @param array $settings * The field's settings, as it is stored within a configuration object. @@ -348,7 +348,8 @@ public static function storageSettingsFromConfigData(array $settings); /** * Returns a settings array that can be stored as a configuration value. * - * Same as static::storageSettingsToConfigData(), but for the field's settings. + * Same as static::storageSettingsToConfigData(), but for the field's + * settings. * * @param array $settings * The field's settings in the field type's canonical representation. diff --git a/core/lib/Drupal/Core/Field/FieldItemListInterface.php b/core/lib/Drupal/Core/Field/FieldItemListInterface.php index 2c2683cfdb78..028f439bdf04 100644 --- a/core/lib/Drupal/Core/Field/FieldItemListInterface.php +++ b/core/lib/Drupal/Core/Field/FieldItemListInterface.php @@ -84,8 +84,8 @@ public function getSetting($setting_name); /** * Contains the default access logic of this field. * - * See \Drupal\Core\Entity\EntityAccessControlHandlerInterface::fieldAccess() for - * the parameter documentation. + * See \Drupal\Core\Entity\EntityAccessControlHandlerInterface::fieldAccess() + * for the parameter documentation. * * @return \Drupal\Core\Access\AccessResultInterface * The access result. diff --git a/core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItemInterface.php b/core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItemInterface.php index 624b71ec9e65..c976dafa6d09 100644 --- a/core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItemInterface.php +++ b/core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItemInterface.php @@ -7,7 +7,8 @@ /** * Interface definition for field items referencing other entities. * - * Field items should extend \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItemBase. + * Field items should extend + * \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItemBase. */ interface EntityReferenceItemInterface { diff --git a/core/lib/Drupal/Core/FileTransfer/Form/FileTransferAuthorizeForm.php b/core/lib/Drupal/Core/FileTransfer/Form/FileTransferAuthorizeForm.php index 5012647757f9..8996fd6039f7 100644 --- a/core/lib/Drupal/Core/FileTransfer/Form/FileTransferAuthorizeForm.php +++ b/core/lib/Drupal/Core/FileTransfer/Form/FileTransferAuthorizeForm.php @@ -89,8 +89,8 @@ public function buildForm(array $form, FormStateInterface $form_state) { * Here we create two submit buttons. For a JS enabled client, they will * only ever see submit_process. However, if a client doesn't have JS * enabled, they will see submit_connection on the first form (when picking - * what filetransfer type to use, and submit_process on the second one (which - * leads to the actual operation). + * what filetransfer type to use, and submit_process on the second one + * (which leads to the actual operation). */ $form['submit_connection'] = [ '#prefix' => "<br style='clear:both'/>", diff --git a/core/lib/Drupal/Core/Mail/MailFormatHelper.php b/core/lib/Drupal/Core/Mail/MailFormatHelper.php index 05e4c190933a..2d6a72db3f07 100644 --- a/core/lib/Drupal/Core/Mail/MailFormatHelper.php +++ b/core/lib/Drupal/Core/Mail/MailFormatHelper.php @@ -84,8 +84,9 @@ public static function wrapMail($text, $indent = '') { /** * Transforms an HTML string into plain text, preserving its structure. * - * The output will be suitable for use as 'format=flowed; delsp=yes' text - * (RFC 3676) and can be passed directly to MailManagerInterface::mail() for sending. + * The output will be suitable for use as 'format=flowed; delsp=yes' text (RFC + * 3676) and can be passed directly to MailManagerInterface::mail() for + * sending. * * We deliberately use LF rather than CRLF, see MailManagerInterface::mail(). * diff --git a/core/lib/Drupal/Core/Menu/MenuLinkManagerInterface.php b/core/lib/Drupal/Core/Menu/MenuLinkManagerInterface.php index d415570de63e..2445889eaa73 100644 --- a/core/lib/Drupal/Core/Menu/MenuLinkManagerInterface.php +++ b/core/lib/Drupal/Core/Menu/MenuLinkManagerInterface.php @@ -30,11 +30,11 @@ public function rebuild(); /** * Deletes all links having a certain menu name. * - * If a link is not deletable but is resettable, the link will be reset to have - * its original menu name, under the assumption that the original menu is not - * the one we are deleting it from. Note that when resetting, if the original - * menu name is the same as the menu name passed to this method, the link will - * not be moved or deleted. + * If a link is not deletable but is resettable, the link will be reset to + * have its original menu name, under the assumption that the original menu is + * not the one we are deleting it from. Note that when resetting, if the + * original menu name is the same as the menu name passed to this method, the + * link will not be moved or deleted. * * @param string $menu_name * The name of the menu whose links will be deleted or reset. diff --git a/core/lib/Drupal/Core/PathProcessor/PathProcessorManager.php b/core/lib/Drupal/Core/PathProcessor/PathProcessorManager.php index de55b6678b39..6f9ba39b69af 100644 --- a/core/lib/Drupal/Core/PathProcessor/PathProcessorManager.php +++ b/core/lib/Drupal/Core/PathProcessor/PathProcessorManager.php @@ -8,8 +8,8 @@ /** * Path processor manager. * - * Holds an array of path processor objects and uses them to sequentially process - * a path, in order of processor priority. + * Holds an array of path processor objects and uses them to sequentially + * process a path, in order of processor priority. */ class PathProcessorManager implements InboundPathProcessorInterface, OutboundPathProcessorInterface { diff --git a/core/lib/Drupal/Core/Render/BareHtmlPageRenderer.php b/core/lib/Drupal/Core/Render/BareHtmlPageRenderer.php index 2261f0ed5724..5c061b13c2e0 100644 --- a/core/lib/Drupal/Core/Render/BareHtmlPageRenderer.php +++ b/core/lib/Drupal/Core/Render/BareHtmlPageRenderer.php @@ -81,7 +81,8 @@ public function renderBarePage(array $content, $title, $page_theme_property, arr * * SystemPageAttachment needs to be on BareHtmlPageRenderer. * When BareHtmlPageRenderer is called, the system module is not available. - * PageAttachmentsHook can inject BareHtmlPageRenderer to use for system_page_attachments. + * PageAttachmentsHook can inject BareHtmlPageRenderer to use for + * system_page_attachments. * * @param array $page * The page to attach to. diff --git a/core/lib/Drupal/Core/Render/Element/Actions.php b/core/lib/Drupal/Core/Render/Element/Actions.php index 3f3d83e46a94..d13652398941 100644 --- a/core/lib/Drupal/Core/Render/Element/Actions.php +++ b/core/lib/Drupal/Core/Render/Element/Actions.php @@ -66,13 +66,13 @@ public static function processActions(&$element, FormStateInterface $form_state, * * This callback iterates over all child elements of the #type 'actions' * container to look for elements with a #dropbutton property, so as to group - * those elements into dropbuttons. As such, it works similar to #group, but is - * specialized for dropbuttons. + * those elements into dropbuttons. As such, it works similar to #group, but + * is specialized for dropbuttons. * * The value of #dropbutton denotes the dropbutton to group the child element - * into. For example, two different values of 'foo' and 'bar' on child elements - * would generate two separate dropbuttons, which each contain the corresponding - * buttons. + * into. For example, two different values of 'foo' and 'bar' on child + * elements would generate two separate dropbuttons, which each contain the + * corresponding buttons. * * @param array $element * The #type 'actions' element to process. diff --git a/core/lib/Drupal/Core/Render/Element/Email.php b/core/lib/Drupal/Core/Render/Element/Email.php index 53ddd563bb68..82e688ce38e2 100644 --- a/core/lib/Drupal/Core/Render/Element/Email.php +++ b/core/lib/Drupal/Core/Render/Element/Email.php @@ -69,7 +69,8 @@ public function getInfo() { /** * Form element validation handler for #type 'email'. * - * Note that #maxlength and #required is validated by _form_validate() already. + * Note that #maxlength and #required is validated by _form_validate() + * already. */ public static function validateEmail(&$element, FormStateInterface $form_state, &$complete_form) { $value = trim($element['#value']); diff --git a/core/lib/Drupal/Core/Render/Element/MachineName.php b/core/lib/Drupal/Core/Render/Element/MachineName.php index 9eb9c10cc0fe..1cb485e6a437 100644 --- a/core/lib/Drupal/Core/Render/Element/MachineName.php +++ b/core/lib/Drupal/Core/Render/Element/MachineName.php @@ -35,7 +35,8 @@ * human-readable name (i.e., as contained in the $form structure) to use as * source for the machine name. Defaults to ['label']. * - label: (optional) Text to display as label for the machine name value - * after the human-readable name form element. Defaults to t('Machine name'). + * after the human-readable name form element. Defaults to t('Machine + * name'). * - replace_pattern: (optional) A regular expression (without delimiters) * matching disallowed characters in the machine name. Defaults to * '[^a-z0-9_]+'. diff --git a/core/lib/Drupal/Core/Render/Element/Url.php b/core/lib/Drupal/Core/Render/Element/Url.php index 7fc2b2aed033..7c5a9af2fbb4 100644 --- a/core/lib/Drupal/Core/Render/Element/Url.php +++ b/core/lib/Drupal/Core/Render/Element/Url.php @@ -59,7 +59,8 @@ public function getInfo() { /** * Form element validation handler for #type 'url'. * - * Note that #maxlength and #required is validated by _form_validate() already. + * Note that #maxlength and #required is validated by _form_validate() + * already. */ public static function validateUrl(&$element, FormStateInterface $form_state, &$complete_form) { $value = trim($element['#value']); diff --git a/core/lib/Drupal/Core/Render/PlaceholderingRenderCache.php b/core/lib/Drupal/Core/Render/PlaceholderingRenderCache.php index e73b61214309..2eb89fe35459 100644 --- a/core/lib/Drupal/Core/Render/PlaceholderingRenderCache.php +++ b/core/lib/Drupal/Core/Render/PlaceholderingRenderCache.php @@ -53,7 +53,8 @@ class PlaceholderingRenderCache extends RenderCache { * 1. when rendering, cache write, but auto-placeholdered * 2. when rendering placeholders, cache read * - * Scenario C. The double rendering for an uncacheable element would happen because: + * Scenario C. The double rendering for an uncacheable element would happen + * because: * 1. when rendering, not cacheable, but auto-placeholdered * 2. when rendering placeholders, rendered again * diff --git a/core/lib/Drupal/Core/Render/theme.api.php b/core/lib/Drupal/Core/Render/theme.api.php index 43cd62d7eb92..4c5d1193fbed 100644 --- a/core/lib/Drupal/Core/Render/theme.api.php +++ b/core/lib/Drupal/Core/Render/theme.api.php @@ -199,8 +199,9 @@ * Themes support post updates in order to install module dependencies that have * been added to the THEME.info.yml after the theme has been installed. * Additionally, if a theme has changed its configuration schema, post updates - * can fix theme settings configuration. See @link hook_post_update_NAME hook_post_update_NAME @endlink - * for more information about post updates. + * can fix theme settings configuration. See + * @link hook_post_update_NAME hook_post_update_NAME @endlink for more + * information about post updates. * * @see hooks * @see callbacks @@ -628,7 +629,8 @@ function hook_preprocess_HOOK(&$variables): void { * must otherwise make sure that the hook implementation is available at * any given time. * - * Suggestions must begin with the value of HOOK, followed by two underscores to be discoverable. + * Suggestions must begin with the value of HOOK, followed by two underscores to + * be discoverable. * * In the following example, we provide suggestions to * node templates based bundle, id, and view mode. @@ -682,7 +684,8 @@ function hook_theme_suggestions_HOOK(array $variables) { * hook_theme_suggestions_HOOK_alter(). So, for each module or theme, the more * general hooks are called first followed by the more specific. * - * New suggestions must begin with the value of HOOK, followed by two underscores to be discoverable. + * New suggestions must begin with the value of HOOK, followed by two + * underscores to be discoverable. * * In the following example, we provide an alternative template suggestion to * node and taxonomy term templates based on the user being logged in. @@ -728,8 +731,9 @@ function hook_theme_suggestions_alter(array &$suggestions, array &$variables, $h * hook called (in this case 'node__article') is available in * $variables['theme_hook_original']. * - * New suggestions must begin with the value of HOOK, followed by two underscores to be discoverable. - * For example, consider the below suggestions from hook_theme_suggestions_node_alter: + * New suggestions must begin with the value of HOOK, followed by two + * underscores to be discoverable. For example, consider the below suggestions + * from hook_theme_suggestions_node_alter: * - node__article is valid * - node__article__custom_template is valid * - node--article is invalid diff --git a/core/lib/Drupal/Core/StreamWrapper/LocalStream.php b/core/lib/Drupal/Core/StreamWrapper/LocalStream.php index f02a37bf3c5b..20cf37cf28f6 100644 --- a/core/lib/Drupal/Core/StreamWrapper/LocalStream.php +++ b/core/lib/Drupal/Core/StreamWrapper/LocalStream.php @@ -10,8 +10,8 @@ * "sites/default/files/example.txt" and then PHP filesystem functions are * invoked. * - * Drupal\Core\StreamWrapper\LocalStream implementations need to implement at least the - * getDirectoryPath() and getExternalUrl() methods. + * Drupal\Core\StreamWrapper\LocalStream implementations need to implement at + * least the getDirectoryPath() and getExternalUrl() methods. */ abstract class LocalStream implements StreamWrapperInterface { /** diff --git a/core/lib/Drupal/Core/Utility/link.api.php b/core/lib/Drupal/Core/Utility/link.api.php index 8a44b1b886c2..93741269c565 100644 --- a/core/lib/Drupal/Core/Utility/link.api.php +++ b/core/lib/Drupal/Core/Utility/link.api.php @@ -35,17 +35,17 @@ * \Drupal\Core\Routing\UrlGenerator::generateFromRoute() to generate the * href attribute for this link, and also used when generating the link. * Defaults to an empty array. It may contain the following elements: - * - 'query': An array of query key/value-pairs (without any URL-encoding) to - * append to the URL. + * - 'query': An array of query key/value-pairs (without any URL-encoding) + * to append to the URL. * - absolute: Whether to force the output to be an absolute link (beginning * with http:). Useful for links that will be displayed outside the site, * such as in an RSS feed. Defaults to FALSE. * - language: An optional language object. May affect the rendering of * the anchor tag, such as by adding a language prefix to the path. * - attributes: An associative array of HTML attributes to apply to the - * anchor tag. If element 'class' is included, it must be an array; 'title' - * must be a string; other elements are more flexible, as they just need - * to work as an argument for the constructor of the class + * anchor tag. If element 'class' is included, it must be an array; + * 'title' must be a string; other elements are more flexible, as they + * just need to work as an argument for the constructor of the class * Drupal\Core\Template\Attribute($options['attributes']). * * @see \Drupal\Core\Utility\UnroutedUrlAssembler::assemble() diff --git a/core/modules/big_pipe/src/Render/BigPipe.php b/core/modules/big_pipe/src/Render/BigPipe.php index c8e4ae63adcf..d149547dbbf6 100644 --- a/core/modules/big_pipe/src/Render/BigPipe.php +++ b/core/modules/big_pipe/src/Render/BigPipe.php @@ -93,7 +93,8 @@ * sent first, the closing </body> tag is not yet sent, and the connection * is kept open. Whenever another BigPipe Placeholder is rendered, Drupal * sends (and so actually appends to the already-sent HTML) something like - * <script type="application/vnd.drupal-ajax">[{"command":"settings","settings":{…}}, {"command":…}. + * <script type="application/vnd.drupal-ajax"> + * [{"command":"settings","settings":{…}}, {"command":…}. * - So, for every BigPipe placeholder, we send such a <script * type="application/vnd.drupal-ajax"> tag. And the contents of that tag is * exactly like an AJAX response. The BigPipe module has JavaScript that @@ -139,16 +140,21 @@ * Combining all of the above, when using both BigPipe placeholders and no-JS * BigPipe placeholders, we therefore send: 1 HtmlResponse + M Embedded HTML * Responses + N Embedded AJAX Responses. Schematically, we send these chunks: - * 1. Byte zero until 1st no-JS placeholder: headers + <html><head /><span>…</span> - * 2. 1st no-JS placeholder replacement: <link rel="stylesheet" …><script …><content> + * 1. Byte zero until 1st no-JS placeholder: + * headers + <html><head /><span>…</span> + * 2. 1st no-JS placeholder replacement: + * <link rel="stylesheet" …><script …><content> * 3. Content until 2nd no-JS placeholder: <span>…</span> - * 4. 2nd no-JS placeholder replacement: <link rel="stylesheet" …><script …><content> + * 4. 2nd no-JS placeholder replacement: + * <link rel="stylesheet" …><script …><content> * 5. Content until 3rd no-JS placeholder: <span>…</span> * 6. [… repeat until all no-JS placeholder replacements are sent …] * 7. Send content after last no-JS placeholder. * 8. Send script_bottom (markup to load bottom i.e. non-critical JS). - * 9. 1st placeholder replacement: <script type="application/vnd.drupal-ajax">[{"command":"settings","settings":{…}}, {"command":…} - * 10. 2nd placeholder replacement: <script type="application/vnd.drupal-ajax">[{"command":"settings","settings":{…}}, {"command":…} + * 9. 1st placeholder replacement: <script type="application/vnd.drupal-ajax"> + * [{"command":"settings","settings":{…}}, {"command":…} + * 10. 2nd placeholder replacement: <script type="application/vnd.drupal-ajax"> + * [{"command":"settings","settings":{…}}, {"command":…} * 11. [… repeat until all placeholder replacements are sent …] * 12. Send </body> and everything after it. * 13. Terminate request/response cycle. diff --git a/core/modules/block/block.api.php b/core/modules/block/block.api.php index 2cfcfd444639..2bf4b2b3f280 100644 --- a/core/modules/block/block.api.php +++ b/core/modules/block/block.api.php @@ -24,12 +24,12 @@ * @section sec_requirements Basic requirements * To define a block in a module you need to: * - Define a Block plugin by creating a new class that implements the - * \Drupal\Core\Block\BlockPluginInterface, in namespace Plugin\Block under your - * module namespace. For more information about creating plugins, see the + * \Drupal\Core\Block\BlockPluginInterface, in namespace Plugin\Block under + * your module namespace. For more information about creating plugins, see the * @link plugin_api Plugin API topic. @endlink - * - Usually you will want to extend the \Drupal\Core\Block\BlockBase class, which - * provides a common configuration form and utility methods for getting and - * setting configuration in the block configuration entity. + * - Usually you will want to extend the \Drupal\Core\Block\BlockBase class, + * which provides a common configuration form and utility methods for getting + * and setting configuration in the block configuration entity. * - Block plugins use the annotations defined by * \Drupal\Core\Block\Annotation\Block. See the * @link annotation Annotations topic @endlink for more information about diff --git a/core/modules/block_content/src/BlockContentViewBuilder.php b/core/modules/block_content/src/BlockContentViewBuilder.php index 68a453b93859..d84679bdf827 100644 --- a/core/modules/block_content/src/BlockContentViewBuilder.php +++ b/core/modules/block_content/src/BlockContentViewBuilder.php @@ -8,10 +8,10 @@ /** * View builder handler for content blocks. * - * Note: Content blocks (block_content entities) are not designed to be displayed - * outside of blocks! This BlockContentViewBuilder class is designed to be used - * by \Drupal\block_content\Plugin\Block\BlockContentBlock::build() and by - * nothing else. + * Note: Content blocks (block_content entities) are not designed to be + * displayed outside of blocks! This BlockContentViewBuilder class is designed + * to be used by \Drupal\block_content\Plugin\Block\BlockContentBlock::build() + * and by nothing else. * * @see \Drupal\block_content\Plugin\Block\BlockContentBlock */ diff --git a/core/modules/block_content/src/Hook/BlockContentHooks.php b/core/modules/block_content/src/Hook/BlockContentHooks.php index b587bd32e737..1542880099c1 100644 --- a/core/modules/block_content/src/Hook/BlockContentHooks.php +++ b/core/modules/block_content/src/Hook/BlockContentHooks.php @@ -92,10 +92,10 @@ public function entityTypeAlter(array &$entity_types) : void { * 'reusable' is explicitly set. * * Block_content entities that are not reusable should by default not be - * selectable as entity reference values. A module can still create an instance - * of \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface - * that will allow selection of non-reusable blocks by explicitly setting - * a condition on the 'reusable' field. + * selectable as entity reference values. A module can still create an + * instance of \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface + * that will allow selection of non-reusable blocks by explicitly setting a + * condition on the 'reusable' field. * * @see \Drupal\block_content\BlockContentAccessControlHandler */ diff --git a/core/modules/block_content/tests/src/Functional/BlockContentSaveTest.php b/core/modules/block_content/tests/src/Functional/BlockContentSaveTest.php index 7cdaddfe749d..03c77066e7c2 100644 --- a/core/modules/block_content/tests/src/Functional/BlockContentSaveTest.php +++ b/core/modules/block_content/tests/src/Functional/BlockContentSaveTest.php @@ -97,8 +97,8 @@ public function testDeterminingChanges(): void { * Tests saving a block on block insert. * * This test ensures that a block has been fully saved when - * hook_block_content_insert() is invoked, so that the block can be saved again - * in a hook implementation without errors. + * hook_block_content_insert() is invoked, so that the block can be saved + * again in a hook implementation without errors. * * @see block_test_block_insert() */ diff --git a/core/modules/ckeditor5/src/HTMLRestrictions.php b/core/modules/ckeditor5/src/HTMLRestrictions.php index 4924cf45f98c..dfb21299805b 100644 --- a/core/modules/ckeditor5/src/HTMLRestrictions.php +++ b/core/modules/ckeditor5/src/HTMLRestrictions.php @@ -617,8 +617,8 @@ private function doDiff(HTMLRestrictions $other): HTMLRestrictions { // - An array value for a given tag/attribute provides an array keyed by // specific attributes/attribute values with boolean values determining // if they are allowed or not. - // - A value of TRUE for a given tag/attribute permits all attributes/attribute - // values for that tag/attribute. + // - A value of TRUE for a given tag/attribute permits all + // attributes/attribute values for that tag/attribute. // @see \Drupal\filter\Entity\FilterFormat::getHtmlRestrictions() function ($value, string $tag) use ($other) { // If this HTML restrictions object contains a tag that the other did diff --git a/core/modules/config_translation/tests/modules/config_translation_test/src/Hook/ConfigTranslationTestHooks.php b/core/modules/config_translation/tests/modules/config_translation_test/src/Hook/ConfigTranslationTestHooks.php index 17d66e9c010e..e64a7f5d6f88 100644 --- a/core/modules/config_translation/tests/modules/config_translation_test/src/Hook/ConfigTranslationTestHooks.php +++ b/core/modules/config_translation/tests/modules/config_translation_test/src/Hook/ConfigTranslationTestHooks.php @@ -80,10 +80,10 @@ public function formConfigTranslationAddFormAlter(&$form, FormStateInterface $fo * Implements hook_form_FORM_ID_alter() for ConfigTranslationEditForm. * * Adds a column to the configuration translation edit form that shows the - * current translation. Note that this column would not be displayed by default, - * as the columns are hardcoded in - * config_translation_manage_form_element.html.twig. The template would need to - * be overridden for the column to be displayed. + * current translation. Note that this column would not be displayed by + * default, as the columns are hardcoded in + * config_translation_manage_form_element.html.twig. The template would need + * to be overridden for the column to be displayed. * * @see \Drupal\config_translation\Form\ConfigTranslationEditForm */ diff --git a/core/modules/content_translation/src/Hook/ContentTranslationHooks.php b/core/modules/content_translation/src/Hook/ContentTranslationHooks.php index bd19dc4f01f9..246d5005a98a 100644 --- a/core/modules/content_translation/src/Hook/ContentTranslationHooks.php +++ b/core/modules/content_translation/src/Hook/ContentTranslationHooks.php @@ -92,45 +92,46 @@ public function languageTypesInfoAlter(array &$language_types): void { /** * Implements hook_entity_type_alter(). * - * The content translation UI relies on the entity info to provide its features. - * See the documentation of hook_entity_type_build() in the Entity API - * documentation for more details on all the entity info keys that may be + * The content translation UI relies on the entity info to provide its + * features. See the documentation of hook_entity_type_build() in the Entity + * API documentation for more details on all the entity info keys that may be * defined. * * To make Content Translation automatically support an entity type some keys * may need to be defined, but none of them is required unless the entity path - * is different from the usual /ENTITY_TYPE/{ENTITY_TYPE} pattern (for instance - * "/taxonomy/term/{taxonomy_term}"). Here are a list of those optional keys: + * is different from the usual /ENTITY_TYPE/{ENTITY_TYPE} pattern (for + * instance "/taxonomy/term/{taxonomy_term}"). Here are a list of those + * optional keys: * - canonical: This key (in the 'links' entity info property) must be defined * if the entity path is different from /ENTITY_TYPE/{ENTITY_TYPE} * - translation: This key (in the 'handlers' entity annotation property) - * specifies the translation handler for the entity type. If an entity type is - * translatable and no translation handler is defined, + * specifies the translation handler for the entity type. If an entity type + * is translatable and no translation handler is defined, * \Drupal\content_translation\ContentTranslationHandler will be assumed. * Every translation handler must implement * \Drupal\content_translation\ContentTranslationHandlerInterface. * - content_translation_ui_skip: By default, entity types that do not have a - * canonical link template cannot be enabled for translation. Setting this key - * to TRUE overrides that. When that key is set, the Content Translation + * canonical link template cannot be enabled for translation. Setting this + * key to TRUE overrides that. When that key is set, the Content Translation * module will not provide any UI for translating the entity type, and the * entity type should implement its own UI. For instance, this is useful for * entity types that are embedded into others for editing (which would not * need a canonical link, but could still support translation). * - content_translation_metadata: To implement its business logic the content - * translation UI relies on various metadata items describing the translation - * state. The default implementation is provided by + * translation UI relies on various metadata items describing the + * translation state. The default implementation is provided by * \Drupal\content_translation\ContentTranslationMetadataWrapper, which is - * relying on one field for each metadata item (field definitions are provided - * by the translation handler). Entity types needing to customize this - * behavior can specify an alternative class through the + * relying on one field for each metadata item (field definitions are + * provided by the translation handler). Entity types needing to customize + * this behavior can specify an alternative class through the * 'content_translation_metadata' key in the entity type definition. Every * content translation metadata wrapper needs to implement * \Drupal\content_translation\ContentTranslationMetadataWrapperInterface. * - * If the entity paths match the default pattern above and there is no need for - * an entity-specific translation handler, Content Translation will provide - * built-in support for the entity. However enabling translation for each - * translatable bundle will be required. + * If the entity paths match the default pattern above and there is no need + * for an entity-specific translation handler, Content Translation will + * provide built-in support for the entity. However enabling translation for + * each translatable bundle will be required. * * @see \Drupal\Core\Entity\Annotation\EntityType */ @@ -178,8 +179,8 @@ public function entityTypeAlter(array &$entity_types) : void { * Installs Content Translation's field storage definitions for the target * entity type, if required. * - * Also clears the bundle information cache so that the bundle's translatability - * will be set properly. + * Also clears the bundle information cache so that the bundle's + * translatability will be set properly. * * @see content_translation_entity_bundle_info_alter() * @see \Drupal\content_translation\ContentTranslationManager::isEnabled() @@ -198,8 +199,8 @@ public function languageContentSettingsInsert(ContentLanguageSettingsInterface $ * Installs Content Translation's field storage definitions for the target * entity type, if required. * - * Also clears the bundle information cache so that the bundle's translatability - * will be changed properly. + * Also clears the bundle information cache so that the bundle's + * translatability will be changed properly. * * @see content_translation_entity_bundle_info_alter() * @see \Drupal\content_translation\ContentTranslationManager::isEnabled() diff --git a/core/modules/contextual/src/Hook/ContextualHooks.php b/core/modules/contextual/src/Hook/ContextualHooks.php index f258496f1f08..afd97cb49f61 100644 --- a/core/modules/contextual/src/Hook/ContextualHooks.php +++ b/core/modules/contextual/src/Hook/ContextualHooks.php @@ -55,8 +55,8 @@ public function toolbar(): array { /** * Implements hook_page_attachments(). * - * Adds the drupal.contextual-links library to the page for any user who has the - * 'access contextual links' permission. + * Adds the drupal.contextual-links library to the page for any user who has + * the 'access contextual links' permission. * * @see contextual_preprocess() */ diff --git a/core/modules/dblog/src/Controller/DbLogController.php b/core/modules/dblog/src/Controller/DbLogController.php index 9eabd19c5bb4..8d40ae12ba1b 100644 --- a/core/modules/dblog/src/Controller/DbLogController.php +++ b/core/modules/dblog/src/Controller/DbLogController.php @@ -305,9 +305,9 @@ public function eventDetails($event_id) { /** * Builds a query for database log administration filters based on session. * - * This method retrieves the session-based filters from the request and applies - * them to the provided query object. If no filters are present, the query is - * left unchanged. + * This method retrieves the session-based filters from the request and + * applies them to the provided query object. If no filters are present, the + * query is left unchanged. * * @param \Symfony\Component\HttpFoundation\Request $request * The request. diff --git a/core/modules/dblog/src/Hook/DblogHooks.php b/core/modules/dblog/src/Hook/DblogHooks.php index ff99bd670d7b..6bb6e1a46b2d 100644 --- a/core/modules/dblog/src/Hook/DblogHooks.php +++ b/core/modules/dblog/src/Hook/DblogHooks.php @@ -58,7 +58,8 @@ public function menuLinksDiscoveredAlter(&$links): void { /** * Implements hook_cron(). * - * Controls the size of the log table, paring it to 'dblog_row_limit' messages. + * Controls the size of the log table, paring it to 'dblog_row_limit' + * messages. */ #[Hook('cron')] public function cron(): void { diff --git a/core/modules/editor/src/Hook/EditorHooks.php b/core/modules/editor/src/Hook/EditorHooks.php index a607cdad7c70..73364de699ff 100644 --- a/core/modules/editor/src/Hook/EditorHooks.php +++ b/core/modules/editor/src/Hook/EditorHooks.php @@ -57,8 +57,8 @@ public function help($route_name, RouteMatchInterface $route_match) { /** * Implements hook_menu_links_discovered_alter(). * - * Rewrites the menu entries for filter module that relate to the configuration - * of text editors. + * Rewrites the menu entries for filter module that relate to the + * configuration of text editors. */ #[Hook('menu_links_discovered_alter')] public function menuLinksDiscoveredAlter(array &$links): void { diff --git a/core/modules/field/src/Hook/FieldHooks.php b/core/modules/field/src/Hook/FieldHooks.php index 1d98632fc084..ac3607c3975f 100644 --- a/core/modules/field/src/Hook/FieldHooks.php +++ b/core/modules/field/src/Hook/FieldHooks.php @@ -26,33 +26,34 @@ class FieldHooks { * @{ * Attaches custom data fields to Drupal entities. * - * The Field API allows custom data fields to be attached to Drupal entities and - * takes care of storing, loading, editing, and rendering field data. Any entity - * type (node, user, etc.) can use the Field API to make itself "fieldable" and - * thus allow fields to be attached to it. Other modules can provide a user - * interface for managing custom fields via a web browser as well as a wide and - * flexible variety of data type, form element, and display format capabilities. + * The Field API allows custom data fields to be attached to Drupal entities + * and takes care of storing, loading, editing, and rendering field data. Any + * entity type (node, user, etc.) can use the Field API to make itself + * "fieldable" and thus allow fields to be attached to it. Other modules can + * provide a user interface for managing custom fields via a web browser as + * well as a wide and flexible variety of data type, form element, and display + * format capabilities. * * The Field API defines two primary data structures, FieldStorage and Field, - * and the concept of a Bundle. A FieldStorage defines a particular type of data - * that can be attached to entities. A Field is attached to a single - * Bundle. A Bundle is a set of fields that are treated as a group by the Field - * Attach API and is related to a single fieldable entity type. + * and the concept of a Bundle. A FieldStorage defines a particular type of + * data that can be attached to entities. A Field is attached to a single + * Bundle. A Bundle is a set of fields that are treated as a group by the + * Field Attach API and is related to a single fieldable entity type. * * For example, suppose a site administrator wants Article nodes to have a - * subtitle and photo. Using the Field API or Field UI module, the administrator - * creates a field named 'subtitle' of type 'text' and a field named 'photo' of - * type 'image'. The administrator (again, via a UI) creates two Field - * Instances, one attaching the field 'subtitle' to the 'node' bundle 'article' - * and one attaching the field 'photo' to the 'node' bundle 'article'. When the - * node storage loads an Article node, it loads the values of the - * 'subtitle' and 'photo' fields because they are both attached to the 'node' - * bundle 'article'. + * subtitle and photo. Using the Field API or Field UI module, the + * administrator creates a field named 'subtitle' of type 'text' and a field + * named 'photo' of type 'image'. The administrator (again, via a UI) creates + * two Field Instances, one attaching the field 'subtitle' to the 'node' + * bundle 'article' and one attaching the field 'photo' to the 'node' bundle + * 'article'. When the node storage loads an Article node, it loads the values + * of the 'subtitle' and 'photo' fields because they are both attached to the + * 'node' bundle 'article'. * * - @link field_types Field Types API @endlink: Defines field types, widget - * types, and display formatters. Field modules use this API to provide field - * types like Text and Node Reference along with the associated form elements - * and display formatters. + * types, and display formatters. Field modules use this API to provide + * field types like Text and Node Reference along with the associated form + * elements and display formatters. * * - @link field_purge Field API bulk data deletion @endlink: Cleans up after * bulk deletion operations such as deletion of field storage or field. @@ -267,8 +268,8 @@ public function configImportStepsAlter(&$sync_steps, ConfigImporter $config_impo /** * Implements hook_form_FORM_ID_alter(). * - * Adds a warning if field data will be permanently removed by the configuration - * synchronization. + * Adds a warning if field data will be permanently removed by the + * configuration synchronization. * * @see \Drupal\field\ConfigImporterFieldPurger */ diff --git a/core/modules/file/src/Plugin/Field/FieldType/FileItem.php b/core/modules/file/src/Plugin/Field/FieldType/FileItem.php index 6859ba82fd59..f09740667e32 100644 --- a/core/modules/file/src/Plugin/Field/FieldType/FileItem.php +++ b/core/modules/file/src/Plugin/Field/FieldType/FileItem.php @@ -233,8 +233,8 @@ public function fieldSettingsForm(array $form, FormStateInterface $form_state) { * Form API callback. * * Removes slashes from the beginning and end of the destination value and - * ensures that the file directory path is not included at the beginning of the - * value. + * ensures that the file directory path is not included at the beginning of + * the value. * * This function is assigned as an #element_validate callback in * fieldSettingsForm(). diff --git a/core/modules/file/tests/file_test/src/FileTestHelper.php b/core/modules/file/tests/file_test/src/FileTestHelper.php index f837deb82043..aea74a4a15f4 100644 --- a/core/modules/file/tests/file_test/src/FileTestHelper.php +++ b/core/modules/file/tests/file_test/src/FileTestHelper.php @@ -43,7 +43,8 @@ public static function reset(): void { /** * Gets the arguments passed to a given hook invocation. * - * Arguments are gathered since Drupal\file_test\FileTestHelper::reset() was last called. + * Arguments are gathered since Drupal\file_test\FileTestHelper::reset() was + * last called. * * @param string $op * One of the hook_file_* operations: 'load', 'validate', 'download', diff --git a/core/modules/image/src/Hook/ImageHooks.php b/core/modules/image/src/Hook/ImageHooks.php index bd260aa0a77c..1eb2f137b543 100644 --- a/core/modules/image/src/Hook/ImageHooks.php +++ b/core/modules/image/src/Hook/ImageHooks.php @@ -237,7 +237,8 @@ public function filePredelete(FileInterface $file) { /** * Implements hook_entity_presave(). * - * Transforms default image of image field from array into single value at save. + * Transforms default image of image field from array into single value at + * save. */ #[Hook('entity_presave')] public function entityPresave(EntityInterface $entity) { diff --git a/core/modules/image/src/Hook/ImageViewsHooks.php b/core/modules/image/src/Hook/ImageViewsHooks.php index cc57f3081fc9..484cbe71712d 100644 --- a/core/modules/image/src/Hook/ImageViewsHooks.php +++ b/core/modules/image/src/Hook/ImageViewsHooks.php @@ -18,8 +18,8 @@ public function __construct( /** * Implements hook_field_views_data(). * - * Views integration for image fields. Adds an image relationship to the default - * field data. + * Views integration for image fields. Adds an image relationship to the + * default field data. * * @see FieldViewsDataProvider::defaultFieldImplementation() */ diff --git a/core/modules/jsonapi/src/Events/CollectRelationshipMetaEvent.php b/core/modules/jsonapi/src/Events/CollectRelationshipMetaEvent.php index 9b69f6bc2e15..b378834ffe73 100644 --- a/core/modules/jsonapi/src/Events/CollectRelationshipMetaEvent.php +++ b/core/modules/jsonapi/src/Events/CollectRelationshipMetaEvent.php @@ -14,8 +14,8 @@ * Event for collecting the relationship metadata of a JSON:API resource object. * * Subscribers of this event that call ::setMetaValue() must set the appropriate - * cache tags and contexts. These should be based on the data that is used to set - * the meta. These will then bubble up to the normalization. + * cache tags and contexts. These should be based on the data that is used to + * set the meta. These will then bubble up to the normalization. * * @Event */ diff --git a/core/modules/jsonapi/src/Events/CollectResourceObjectMetaEvent.php b/core/modules/jsonapi/src/Events/CollectResourceObjectMetaEvent.php index 8db969d5feb8..9600e00aead7 100644 --- a/core/modules/jsonapi/src/Events/CollectResourceObjectMetaEvent.php +++ b/core/modules/jsonapi/src/Events/CollectResourceObjectMetaEvent.php @@ -14,8 +14,8 @@ * Event for collecting resource object metadata of a JSON:API resource types. * * Subscribers of this event that call ::setMetaValue() must set the appropriate - * cache tags and contexts. These should be based on the data that is used to set - * the meta. These will then bubble up to the normalization. + * cache tags and contexts. These should be based on the data that is used to + * set the meta. These will then bubble up to the normalization. * * @Event */ diff --git a/core/modules/language/src/Hook/LanguageHooks.php b/core/modules/language/src/Hook/LanguageHooks.php index af87a145792c..4d4d9ed1e8e6 100644 --- a/core/modules/language/src/Hook/LanguageHooks.php +++ b/core/modules/language/src/Hook/LanguageHooks.php @@ -362,9 +362,9 @@ public function tourTipsAlter(array &$tour_tips, EntityInterface $entity): void * Implements hook_language_types_info_alter(). * * We can't set the fixed properties in \Drupal\Core\Language\LanguageManager, - * where the rest of the properties for the default language types are defined. - * The LanguageNegation classes are only loaded when the language module is - * enabled and we can't be sure of that in the LanguageManager. + * where the rest of the properties for the default language types are + * defined. The LanguageNegation classes are only loaded when the language + * module is enabled and we can't be sure of that in the LanguageManager. */ #[Hook('language_types_info_alter')] public function languageTypesInfoAlter(array &$language_types): void { diff --git a/core/modules/layout_builder/src/Hook/LayoutBuilderHooks.php b/core/modules/layout_builder/src/Hook/LayoutBuilderHooks.php index 2e000df78f45..33ec4ca13607 100644 --- a/core/modules/layout_builder/src/Hook/LayoutBuilderHooks.php +++ b/core/modules/layout_builder/src/Hook/LayoutBuilderHooks.php @@ -135,12 +135,12 @@ public function fieldConfigDelete(FieldConfigInterface $field_config) { /** * Implements hook_entity_view_alter(). * - * ExtraFieldBlock block plugins add placeholders for each extra field which is - * configured to be displayed. Those placeholders are replaced by this hook. - * Modules that implement hook_entity_extra_field_info() use their + * ExtraFieldBlock block plugins add placeholders for each extra field which + * is configured to be displayed. Those placeholders are replaced by this + * hook. Modules that implement hook_entity_extra_field_info() use their * implementations of hook_entity_view_alter() to add the rendered output of - * the extra fields they provide, so we cannot get the rendered output of extra - * fields before this point in the view process. + * the extra fields they provide, so we cannot get the rendered output of + * extra fields before this point in the view process. * layout_builder_module_implements_alter() moves this implementation of * hook_entity_view_alter() to the end of the list. * diff --git a/core/modules/locale/locale.bulk.inc b/core/modules/locale/locale.bulk.inc index e63ee7a45aa4..179906e96f85 100644 --- a/core/modules/locale/locale.bulk.inc +++ b/core/modules/locale/locale.bulk.inc @@ -676,7 +676,8 @@ function locale_config_batch_update_config_translations(array $names, array $lan * Contains a list of files imported. * * @deprecated in drupal:11.1.0 and is removed from drupal:12.0.0. Use - * locale_config_batch_update_config_translations($names, $langcodes, $context) instead. + * locale_config_batch_update_config_translations($names, $langcodes, $context) + * instead. * * @see https://www.drupal.org/node/3475054 */ diff --git a/core/modules/locale/tests/modules/locale_test/src/Hook/LocaleTestHooks.php b/core/modules/locale/tests/modules/locale_test/src/Hook/LocaleTestHooks.php index 9c5931fdca42..bf7c41beb290 100644 --- a/core/modules/locale/tests/modules/locale_test/src/Hook/LocaleTestHooks.php +++ b/core/modules/locale/tests/modules/locale_test/src/Hook/LocaleTestHooks.php @@ -45,11 +45,11 @@ public function systemInfoAlter(&$info, Extension $file, $type): void { /** * Implements hook_locale_translation_projects_alter(). * - * The translation status process by default checks the status of the installed - * projects. This function replaces the data of the installed modules by a - * predefined set of modules with fixed file names and release versions. Project - * names, versions, timestamps etc must be fixed because they must match the - * files created by the test script. + * The translation status process by default checks the status of the + * installed projects. This function replaces the data of the installed + * modules by a predefined set of modules with fixed file names and release + * versions. Project names, versions, timestamps etc must be fixed because + * they must match the files created by the test script. * * The "locale.test_projects_alter" state variable must be set by the * test script in order for this hook to take effect. diff --git a/core/modules/migrate/src/Event/MigrateEvents.php b/core/modules/migrate/src/Event/MigrateEvents.php index deeb667f52aa..ad86acc9ea62 100644 --- a/core/modules/migrate/src/Event/MigrateEvents.php +++ b/core/modules/migrate/src/Event/MigrateEvents.php @@ -38,7 +38,8 @@ final class MigrateEvents { * * This event allows modules to perform an action whenever a row is deleted * from a migration's map table (implying it has been rolled back). The event - * listener method receives a \Drupal\migrate\Event\MigrateMapDeleteEvent instance. + * listener method receives a \Drupal\migrate\Event\MigrateMapDeleteEvent + * instance. * * @Event * diff --git a/core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php b/core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php index 3f281995d8da..c6eabb3ff4f5 100644 --- a/core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php +++ b/core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php @@ -549,8 +549,8 @@ protected function getHighWaterStorage() { /** * The current value of the high water mark. * - * The high water mark defines a timestamp stating the time the import was last - * run. If the mark is set, only content with a higher timestamp will be + * The high water mark defines a timestamp stating the time the import was + * last run. If the mark is set, only content with a higher timestamp will be * imported. * * @return int|null diff --git a/core/modules/mysql/src/Driver/Database/mysql/Schema.php b/core/modules/mysql/src/Driver/Database/mysql/Schema.php index 351f4180821e..85e71af18d12 100644 --- a/core/modules/mysql/src/Driver/Database/mysql/Schema.php +++ b/core/modules/mysql/src/Driver/Database/mysql/Schema.php @@ -69,10 +69,10 @@ protected function getPrefixInfo($table = 'default', $add_prefix = TRUE) { /** * Build a condition to match a table name against a standard information_schema. * - * MySQL uses databases like schemas rather than catalogs so when we build - * a condition to query the information_schema.tables, we set the default - * database as the schema unless specified otherwise, and exclude table_catalog - * from the condition criteria. + * MySQL uses databases like schemas rather than catalogs so when we build a + * condition to query the information_schema.tables, we set the default + * database as the schema unless specified otherwise, and exclude + * table_catalog from the condition criteria. */ protected function buildTableNameCondition($table_name, $operator = '=', $add_prefix = TRUE) { $table_info = $this->getPrefixInfo($table_name, $add_prefix); diff --git a/core/modules/node/node.api.php b/core/modules/node/node.api.php index bf0dba3135fb..9d1e3d5231fd 100644 --- a/core/modules/node/node.api.php +++ b/core/modules/node/node.api.php @@ -108,8 +108,8 @@ function hook_node_grants(AccountInterface $account, $operation): array { * - 'gid': A 'grant ID' from hook_node_grants(). * - 'grant_view': If set to 1 a user that has been identified as a member * of this gid within this realm can view this node. This should usually be - * set to $node->isPublished(). Failure to do so may expose unpublished content - * to some users. + * set to $node->isPublished(). Failure to do so may expose unpublished + * content to some users. * - 'grant_update': If set to 1 a user that has been identified as a member * of this gid within this realm can edit this node. * - 'grant_delete': If set to 1 a user that has been identified as a member diff --git a/core/modules/node/src/Hook/NodeHooks1.php b/core/modules/node/src/Hook/NodeHooks1.php index d194b4b30543..5a3f54ad519a 100644 --- a/core/modules/node/src/Hook/NodeHooks1.php +++ b/core/modules/node/src/Hook/NodeHooks1.php @@ -316,41 +316,42 @@ public function formSystemThemesAdminFormAlter(&$form, FormStateInterface $form_ * "bypass node access" permission. Such users have unrestricted access to all * nodes. user 1 will always pass this check. * - * Next, all implementations of hook_ENTITY_TYPE_access() for node will - * be called. Each implementation may explicitly allow, explicitly forbid, or - * ignore the access request. If at least one module says to forbid the request, - * it will be rejected. If no modules deny the request and at least one says to - * allow it, the request will be permitted. + * Next, all implementations of hook_ENTITY_TYPE_access() for node will be + * called. Each implementation may explicitly allow, explicitly forbid, or + * ignore the access request. If at least one module says to forbid the + * request, it will be rejected. If no modules deny the request and at least + * one says to allow it, the request will be permitted. * - * If all modules ignore the access request, then the node_access table is used - * to determine access. All node access modules are queried using - * hook_node_grants() to assemble a list of "grant IDs" for the user. This list - * is compared against the table. If any row contains the node ID in question - * (or 0, which stands for "all nodes"), one of the grant IDs returned, and a - * value of TRUE for the operation in question, then access is granted. Note - * that this table is a list of grants; any matching row is sufficient to grant - * access to the node. + * If all modules ignore the access request, then the node_access table is + * used to determine access. All node access modules are queried using + * hook_node_grants() to assemble a list of "grant IDs" for the user. This + * list is compared against the table. If any row contains the node ID in + * question (or 0, which stands for "all nodes"), one of the grant IDs + * returned, and a value of TRUE for the operation in question, then access is + * granted. Note that this table is a list of grants; any matching row is + * sufficient to grant access to the node. * * In node listings (lists of nodes generated from a select query, such as the - * default home page at path 'node', an RSS feed, a recent content block, etc.), - * the process above is followed except that hook_ENTITY_TYPE_access() is not - * called on each node for performance reasons and for proper functioning of - * the pager system. When adding a node listing to your module, be sure to use - * an entity query, which will add a tag of "node_access". This will allow - * modules dealing with node access to ensure only nodes to which the user has - * access are retrieved, through the use of hook_query_TAG_alter(). See the - * @link entity_api Entity API topic @endlink for more information on entity - * queries. Tagging a query with "node_access" does not check the - * published/unpublished status of nodes, so the base query is responsible - * for ensuring that unpublished nodes are not displayed to inappropriate users. + * default home page at path 'node', an RSS feed, a recent content block, + * etc.), the process above is followed except that hook_ENTITY_TYPE_access() + * is not called on each node for performance reasons and for proper + * functioning of the pager system. When adding a node listing to your module, + * be sure to use an entity query, which will add a tag of "node_access". This + * will allow modules dealing with node access to ensure only nodes to which + * the user has access are retrieved, through the use of + * hook_query_TAG_alter(). See the @link entity_api Entity API topic @endlink + * for more information on entity queries. Tagging a query with "node_access" + * does not check the published/unpublished status of nodes, so the base query + * is responsible for ensuring that unpublished nodes are not displayed to + * inappropriate users. * * Note: Even a single module returning an AccessResultInterface object from * hook_ENTITY_TYPE_access() whose isForbidden() method equals TRUE will block * access to the node. Therefore, implementers should take care to not deny * access unless they really intend to. Unless a module wishes to actively * forbid access it should return an AccessResultInterface object whose - * isAllowed() nor isForbidden() methods return TRUE, to allow other modules or - * the node_access table to control access. + * isAllowed() nor isForbidden() methods return TRUE, to allow other modules + * or the node_access table to control access. * * Note also that access to create nodes is handled by * hook_ENTITY_TYPE_create_access(). @@ -389,10 +390,11 @@ public function nodeAccess(NodeInterface $node, $operation, AccountInterface $ac /** * Implements hook_query_TAG_alter(). * - * This is the hook_query_alter() for queries tagged with 'node_access'. It adds - * node access checks for the user account given by the 'account' meta-data (or - * current user if not provided), for an operation given by the 'op' meta-data - * (or 'view' if not provided; other possible values are 'update' and 'delete'). + * This is the hook_query_alter() for queries tagged with 'node_access'. It + * adds node access checks for the user account given by the 'account' + * meta-data (or current user if not provided), for an operation given by the + * 'op' meta-data (or 'view' if not provided; other possible values are + * 'update' and 'delete'). * * Queries tagged with 'node_access' that are not against the {node} table * must add the base table as metadata. For example: diff --git a/core/modules/search/search.module b/core/modules/search/search.module index 18bb92b77aa6..ce1d51a5d08b 100644 --- a/core/modules/search/search.module +++ b/core/modules/search/search.module @@ -49,10 +49,10 @@ function search_preprocess_block(&$variables): void { * in \Drupal\search\Plugin\SearchPluginBase. For more information about * plugins, see the @link plugin_api Plugin API topic. @endlink * - * If your module needs to provide a more complicated search form, then you - * need to implement it yourself. In that case, you may wish to define it as a - * local task (tab) under the /search page (e.g. /search/my_module) so that users - * can easily find it. + * If your module needs to provide a more complicated search form, then you need + * to implement it yourself. In that case, you may wish to define it as a local + * task (tab) under the /search page (e.g. /search/my_module) so that users can + * easily find it. * * @see plugin_api * @see annotation diff --git a/core/modules/serialization/src/Normalizer/TimestampItemNormalizer.php b/core/modules/serialization/src/Normalizer/TimestampItemNormalizer.php index 2cfdd63ee025..cb7102ac56e1 100644 --- a/core/modules/serialization/src/Normalizer/TimestampItemNormalizer.php +++ b/core/modules/serialization/src/Normalizer/TimestampItemNormalizer.php @@ -8,11 +8,13 @@ /** * Converts values for TimestampItem to and from common formats. * - * Overrides FieldItemNormalizer to use \Drupal\serialization\Normalizer\TimestampNormalizer + * Overrides FieldItemNormalizer to use + * \Drupal\serialization\Normalizer\TimestampNormalizer * * Overrides FieldItemNormalizer to * - during normalization, add the 'format' key to assist consumers - * - during denormalization, use \Drupal\serialization\Normalizer\TimestampNormalizer + * - during denormalization, use + * \Drupal\serialization\Normalizer\TimestampNormalizer */ class TimestampItemNormalizer extends FieldItemNormalizer { diff --git a/core/modules/settings_tray/src/Hook/SettingsTrayHooks.php b/core/modules/settings_tray/src/Hook/SettingsTrayHooks.php index d1b3ed984fdc..2f48d05d1fc0 100644 --- a/core/modules/settings_tray/src/Hook/SettingsTrayHooks.php +++ b/core/modules/settings_tray/src/Hook/SettingsTrayHooks.php @@ -97,8 +97,8 @@ public function entityTypeBuild(array &$entity_types): void { /** * Implements hook_toolbar_alter(). * - * Alters the 'contextual' toolbar tab if it exists (meaning the user is allowed - * to use contextual links) and if they can administer blocks. + * Alters the 'contextual' toolbar tab if it exists (meaning the user is + * allowed to use contextual links) and if they can administer blocks. * * @todo Remove the "administer blocks" requirement in * https://www.drupal.org/node/2822965. @@ -128,7 +128,8 @@ public function toolbarAlter(&$items): void { /** * Implements hook_block_alter(). * - * Ensures every block plugin definition has an 'settings_tray' form specified. + * Ensures every block plugin definition has an 'settings_tray' form + * specified. * * @see \Drupal\settings_tray\Access\BlockPluginHasSettingsTrayFormAccessCheck */ diff --git a/core/modules/system/src/Controller/LinksetController.php b/core/modules/system/src/Controller/LinksetController.php index 793040adb063..035dbec71676 100644 --- a/core/modules/system/src/Controller/LinksetController.php +++ b/core/modules/system/src/Controller/LinksetController.php @@ -130,7 +130,8 @@ public function process(Request $request, MenuInterface $menu) { * preserved in the final component of the hierarchy value. * * According to the Linkset specification, each value in the hierarchy array - * must be a string. See https://tools.ietf.org/html/draft-ietf-httpapi-linkset-08#section-4.2.4.3 + * must be a string. See + * https://tools.ietf.org/html/draft-ietf-httpapi-linkset-08#section-4.2.4.3 * * @param \Drupal\Core\Menu\MenuLinkTreeElement[] $tree * A tree of menu elements. diff --git a/core/modules/system/src/Form/ThemeSettingsForm.php b/core/modules/system/src/Form/ThemeSettingsForm.php index b3192f0648c4..58c9ba6fa644 100644 --- a/core/modules/system/src/Form/ThemeSettingsForm.php +++ b/core/modules/system/src/Form/ThemeSettingsForm.php @@ -513,9 +513,9 @@ public function submitForm(array &$form, FormStateInterface $form_state) { /** * Helper function for the system_theme_settings form. * - * Attempts to validate normal system paths, paths relative to the public files - * directory, or stream wrapper URIs. If the given path is any of the above, - * returns a valid path or URI that the theme system can display. + * Attempts to validate normal system paths, paths relative to the public + * files directory, or stream wrapper URIs. If the given path is any of the + * above, returns a valid path or URI that the theme system can display. * * @param string $path * A path relative to the Drupal root or to the public files directory, or diff --git a/core/modules/system/src/Hook/SystemHooks.php b/core/modules/system/src/Hook/SystemHooks.php index f63eabb56291..55738a3acbdf 100644 --- a/core/modules/system/src/Hook/SystemHooks.php +++ b/core/modules/system/src/Hook/SystemHooks.php @@ -303,8 +303,8 @@ public function systemInfoAlter(&$info, Extension $file, $type): void { /** * Implements hook_cron(). * - * Remove older rows from flood, batch cache and expirable keyvalue tables. Also - * ensure files directories have .htaccess files. + * Remove older rows from flood, batch cache and expirable keyvalue tables. + * Also ensure files directories have .htaccess files. */ #[Hook('cron')] public function cron(): void { diff --git a/core/modules/system/tests/modules/common_test/src/Hook/CommonTestHooks.php b/core/modules/system/tests/modules/common_test/src/Hook/CommonTestHooks.php index 3cc65ac976ff..cf509addbcfa 100644 --- a/core/modules/system/tests/modules/common_test/src/Hook/CommonTestHooks.php +++ b/core/modules/system/tests/modules/common_test/src/Hook/CommonTestHooks.php @@ -108,8 +108,8 @@ public function libraryInfoAlter(&$libraries, $module): void { /** * Implements hook_cron(). * - * System module should handle if a module does not catch an exception and keep - * cron going. + * System module should handle if a module does not catch an exception and + * keep cron going. * * @see common_test_cron_helper() */ diff --git a/core/modules/system/tests/modules/off_canvas_test/src/Controller/TestController.php b/core/modules/system/tests/modules/off_canvas_test/src/Controller/TestController.php index 8b269d99bbed..b9cf015e5828 100644 --- a/core/modules/system/tests/modules/off_canvas_test/src/Controller/TestController.php +++ b/core/modules/system/tests/modules/off_canvas_test/src/Controller/TestController.php @@ -132,8 +132,8 @@ public function linksDisplay() { /** * Displays dialogs links to be displayed inside the off-canvas dialog. * - * This links are used to test opening a modal and another off_canvas link from - * inside the off-canvas dialog. + * This links are used to test opening a modal and another off_canvas link + * from inside the off-canvas dialog. * * @todo Update tests to check these links work in the off-canvas dialog. * https://www.drupal.org/node/2790073 diff --git a/core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php b/core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php index d6f358288d41..e33685ce8035 100644 --- a/core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php +++ b/core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php @@ -305,7 +305,8 @@ protected function createReferenceTestEntities($referenced_entity) { * - entity cache tag: "<entity type>:<entity ID>" * - entity type list cache tag: "<entity type>_list" * - referencing entity type view cache tag: "<referencing entity type>_view" - * - referencing entity type cache tag: "<referencing entity type>:<referencing entity ID>" + * - referencing entity type cache tag: " + * <referencing entity type>:<referencing entity ID>" */ public function testReferencedEntity(): void { $entity_type = $this->entity->getEntityTypeId(); diff --git a/core/modules/system/tests/src/Functional/System/CronRunTest.php b/core/modules/system/tests/src/Functional/System/CronRunTest.php index a5885a660dfe..47ed4f788cbb 100644 --- a/core/modules/system/tests/src/Functional/System/CronRunTest.php +++ b/core/modules/system/tests/src/Functional/System/CronRunTest.php @@ -54,8 +54,8 @@ public function testCronRun(): void { /** * Ensure that the automated cron run module is working. * - * In these tests we do not use \Drupal::time()->getRequestTime() to track start time, because we - * need the exact time when cron is triggered. + * In these tests we do not use \Drupal::time()->getRequestTime() to track + * start time, because we need the exact time when cron is triggered. */ public function testAutomatedCron(): void { // To prevent race conditions between the admin_user login triggering cron diff --git a/core/modules/taxonomy/src/Hook/TaxonomyHooks.php b/core/modules/taxonomy/src/Hook/TaxonomyHooks.php index 81110777a03b..fcbc82172927 100644 --- a/core/modules/taxonomy/src/Hook/TaxonomyHooks.php +++ b/core/modules/taxonomy/src/Hook/TaxonomyHooks.php @@ -124,13 +124,13 @@ public function entityOperation(EntityInterface $term): array { * between terms and fieldable entities. However its most common use case * requires listing all content associated with a term or group of terms * sorted by creation date. To avoid slow queries due to joining across - * multiple node and field tables with various conditions and order by criteria, - * we maintain a denormalized table with all relationships between terms, - * published nodes and common sort criteria such as status, sticky and created. - * When using other field storage engines or alternative methods of + * multiple node and field tables with various conditions and order by + * criteria, we maintain a denormalized table with all relationships between + * terms, published nodes and common sort criteria such as status, sticky and + * created. When using other field storage engines or alternative methods of * denormalizing this data you should set the - * taxonomy.settings:maintain_index_table to '0' to avoid unnecessary writes in - * SQL. + * taxonomy.settings:maintain_index_table to '0' to avoid unnecessary writes + * in SQL. */ /** diff --git a/core/modules/taxonomy/src/Hook/TaxonomyViewsHooks.php b/core/modules/taxonomy/src/Hook/TaxonomyViewsHooks.php index bf3d12eb8935..092a99231c7f 100644 --- a/core/modules/taxonomy/src/Hook/TaxonomyViewsHooks.php +++ b/core/modules/taxonomy/src/Hook/TaxonomyViewsHooks.php @@ -56,8 +56,8 @@ public function viewsDataAlter(&$data): void { /** * Implements hook_field_views_data_alter(). * - * Views integration for entity reference fields which reference taxonomy terms. - * Adds a term relationship to the default field data. + * Views integration for entity reference fields which reference taxonomy + * terms. Adds a term relationship to the default field data. * * @see FieldViewsDataProvider::defaultFieldImplementation() */ diff --git a/core/modules/update/src/Hook/UpdateHooks.php b/core/modules/update/src/Hook/UpdateHooks.php index 4c76f5b8dd88..a63659357812 100644 --- a/core/modules/update/src/Hook/UpdateHooks.php +++ b/core/modules/update/src/Hook/UpdateHooks.php @@ -197,7 +197,8 @@ public function cron(): void { /** * Implements hook_themes_installed(). * - * If themes are installed, we invalidate the information of available updates. + * If themes are installed, we invalidate the information of available + * updates. */ #[Hook('themes_installed')] public function themesInstalled($themes): void { @@ -208,7 +209,8 @@ public function themesInstalled($themes): void { /** * Implements hook_themes_uninstalled(). * - * If themes are uninstalled, we invalidate the information of available updates. + * If themes are uninstalled, we invalidate the information of available + * updates. */ #[Hook('themes_uninstalled')] public function themesUninstalled($themes): void { @@ -219,7 +221,8 @@ public function themesUninstalled($themes): void { /** * Implements hook_modules_installed(). * - * If modules are installed, we invalidate the information of available updates. + * If modules are installed, we invalidate the information of available + * updates. */ #[Hook('modules_installed')] public function modulesInstalled($modules): void { @@ -230,7 +233,8 @@ public function modulesInstalled($modules): void { /** * Implements hook_modules_uninstalled(). * - * If modules are uninstalled, we invalidate the information of available updates. + * If modules are uninstalled, we invalidate the information of available + * updates. */ #[Hook('modules_uninstalled')] public function modulesUninstalled($modules): void { @@ -273,11 +277,12 @@ public function mail($key, &$message, $params): void { * Implements hook_verify_update_archive(). * * First, we ensure that the archive isn't a copy of Drupal core, which the - * update manager does not yet support. See https://www.drupal.org/node/606592. + * update manager does not yet support. See + * https://www.drupal.org/node/606592. * - * Then, we make sure that at least one module included in the archive file has - * an .info.yml file which claims that the code is compatible with the current - * version of Drupal core. + * Then, we make sure that at least one module included in the archive file + * has an .info.yml file which claims that the code is compatible with the + * current version of Drupal core. * * @see \Drupal\Core\Extension\ExtensionDiscovery */ diff --git a/core/modules/update/tests/modules/update_test/src/Controller/UpdateTestController.php b/core/modules/update/tests/modules/update_test/src/Controller/UpdateTestController.php index 450ca676797f..5460f0297c52 100644 --- a/core/modules/update/tests/modules/update_test/src/Controller/UpdateTestController.php +++ b/core/modules/update/tests/modules/update_test/src/Controller/UpdateTestController.php @@ -32,10 +32,10 @@ public function updateError() { * * The specific XML file to print depends on two things: the project we're * trying to fetch data for, and the desired "availability scenario" for that - * project which we're trying to test. Before attempting to fetch this data (by - * checking for updates on the available updates report), callers need to define - * the 'update_test_xml_map' variable as an array, keyed by project name, - * indicating which availability scenario to use for that project. + * project which we're trying to test. Before attempting to fetch this data + * (by checking for updates on the available updates report), callers need to + * define the 'update_test_xml_map' variable as an array, keyed by project + * name, indicating which availability scenario to use for that project. * * @param string $project_name * The project short name the update manager is trying to fetch data for diff --git a/core/modules/update/tests/modules/update_test/src/Hook/UpdateTestHooks.php b/core/modules/update/tests/modules/update_test/src/Hook/UpdateTestHooks.php index e96240cf5a17..d47f934f341f 100644 --- a/core/modules/update/tests/modules/update_test/src/Hook/UpdateTestHooks.php +++ b/core/modules/update/tests/modules/update_test/src/Hook/UpdateTestHooks.php @@ -18,10 +18,10 @@ class UpdateTestHooks { * Checks the 'update_test.settings:system_info' configuration and sees if we * need to alter the system info for the given $file based on the setting. The * setting is expected to be a nested associative array. If the key '#all' is - * defined, its subarray will include .info.yml keys and values for all modules - * and themes on the system. Otherwise, the settings array is keyed by the - * module or theme short name ($file->name) and the subarrays contain settings - * just for that module or theme. + * defined, its subarray will include .info.yml keys and values for all + * modules and themes on the system. Otherwise, the settings array is keyed by + * the module or theme short name ($file->name) and the subarrays contain + * settings just for that module or theme. */ #[Hook('system_info_alter')] public function systemInfoAlter(&$info, Extension $file): void { @@ -38,13 +38,13 @@ public function systemInfoAlter(&$info, Extension $file): void { /** * Implements hook_update_status_alter(). * - * Checks the 'update_test.settings:update_status' configuration and sees if we - * need to alter the update status for the given project based on the setting. - * The setting is expected to be a nested associative array. If the key '#all' - * is defined, its subarray will include .info.yml keys and values for all modules - * and themes on the system. Otherwise, the settings array is keyed by the - * module or theme short name and the subarrays contain settings just for that - * module or theme. + * Checks the 'update_test.settings:update_status' configuration and sees if + * we need to alter the update status for the given project based on the + * setting. The setting is expected to be a nested associative array. If the + * key '#all' is defined, its subarray will include .info.yml keys and values + * for all modules and themes on the system. Otherwise, the settings array is + * keyed by the module or theme short name and the subarrays contain settings + * just for that module or theme. */ #[Hook('update_status_alter')] public function updateStatusAlter(&$projects): void { diff --git a/core/modules/views/src/Ajax/ReplaceTitleCommand.php b/core/modules/views/src/Ajax/ReplaceTitleCommand.php index 6da95a7c36ac..77d4866550ac 100644 --- a/core/modules/views/src/Ajax/ReplaceTitleCommand.php +++ b/core/modules/views/src/Ajax/ReplaceTitleCommand.php @@ -7,7 +7,8 @@ /** * Provides an AJAX command for replacing the page title. * - * This command is implemented in Drupal.AjaxCommands.prototype.viewsReplaceTitle. + * This command is implemented in + * Drupal.AjaxCommands.prototype.viewsReplaceTitle. */ class ReplaceTitleCommand implements CommandInterface { diff --git a/core/modules/views/src/Ajax/ShowButtonsCommand.php b/core/modules/views/src/Ajax/ShowButtonsCommand.php index aecd6bd63a97..7b7623d240ff 100644 --- a/core/modules/views/src/Ajax/ShowButtonsCommand.php +++ b/core/modules/views/src/Ajax/ShowButtonsCommand.php @@ -7,7 +7,8 @@ /** * Provides an AJAX command for showing the save and cancel buttons. * - * This command is implemented in Drupal.AjaxCommands.prototype.viewsShowButtons. + * This command is implemented in + * Drupal.AjaxCommands.prototype.viewsShowButtons. */ class ShowButtonsCommand implements CommandInterface { diff --git a/core/modules/views/src/Ajax/TriggerPreviewCommand.php b/core/modules/views/src/Ajax/TriggerPreviewCommand.php index 64e76cb83ee9..00b4265878fe 100644 --- a/core/modules/views/src/Ajax/TriggerPreviewCommand.php +++ b/core/modules/views/src/Ajax/TriggerPreviewCommand.php @@ -7,7 +7,8 @@ /** * Provides an AJAX command for triggering the views live preview. * - * This command is implemented in Drupal.AjaxCommands.prototype.viewsTriggerPreview. + * This command is implemented in + * Drupal.AjaxCommands.prototype.viewsTriggerPreview. */ class TriggerPreviewCommand implements CommandInterface { diff --git a/core/modules/views/src/Hook/ViewsHooks.php b/core/modules/views/src/Hook/ViewsHooks.php index 396c75d95af7..ed96077b252a 100644 --- a/core/modules/views/src/Hook/ViewsHooks.php +++ b/core/modules/views/src/Hook/ViewsHooks.php @@ -83,8 +83,8 @@ public function viewsPreRender($view): void { /** * Implements hook_theme(). * - * Register views theming functions and those that are defined via views plugin - * definitions. + * Register views theming functions and those that are defined via views + * plugin definitions. */ #[Hook('theme')] public function theme($existing, $type, $theme, $path) : array { diff --git a/core/modules/views/src/Hook/ViewsViewsHooks.php b/core/modules/views/src/Hook/ViewsViewsHooks.php index 474ed5f85f78..63229a8ca39e 100644 --- a/core/modules/views/src/Hook/ViewsViewsHooks.php +++ b/core/modules/views/src/Hook/ViewsViewsHooks.php @@ -190,9 +190,9 @@ public function viewsData(): array { * Implements hook_views_data_alter(). * * Field modules can implement hook_field_views_data_views_data_alter() to - * alter the views data on a per field basis. This is weirdly named so as - * not to conflict with the \Drupal::moduleHandler()->alter('field_views_data') - * in views_views_data(). + * alter the views data on a per field basis. This is weirdly named so as not + * to conflict with the \Drupal::moduleHandler()->alter('field_views_data') in + * views_views_data(). */ #[Hook('views_data_alter')] public function viewsDataAlter(&$data): void { @@ -212,9 +212,9 @@ public function viewsDataAlter(&$data): void { * Implements hook_field_views_data(). * * The function implements the hook on behalf of 'core' because it adds a - * relationship and a reverse relationship to entity_reference field type, which - * is provided by core. This function also provides an argument plugin for - * entity_reference fields that handles title token replacement. + * relationship and a reverse relationship to entity_reference field type, + * which is provided by core. This function also provides an argument plugin + * for entity_reference fields that handles title token replacement. */ #[Hook('field_views_data')] public function fieldViewsData(FieldStorageConfigInterface $field_storage): array { diff --git a/core/modules/views/src/ManyToOneHelper.php b/core/modules/views/src/ManyToOneHelper.php index b1583b2a9f00..d8fcb3e488cf 100644 --- a/core/modules/views/src/ManyToOneHelper.php +++ b/core/modules/views/src/ManyToOneHelper.php @@ -56,8 +56,8 @@ public function buildOptionsForm(&$form, FormStateInterface $form_state) { /** * Get the field via formula or build it using alias and field name. * - * Sometimes the handler might want us to use some kind of formula, so give - * it that option. If it wants us to do this, it must set $helper->formula = TRUE + * Sometimes the handler might want us to use some kind of formula, so give it + * that option. If it wants us to do this, it must set $helper->formula = TRUE * and implement handler->getFormula(). */ public function getField() { @@ -72,10 +72,10 @@ public function getField() { /** * Add a table to the query. * - * This is an advanced concept; not only does it add a new instance of the table, - * but it follows the relationship path all the way down to the relationship - * link point and adds *that* as a new relationship and then adds the table to - * the relationship, if necessary. + * This is an advanced concept; not only does it add a new instance of the + * table, but it follows the relationship path all the way down to the + * relationship link point and adds *that* as a new relationship and then adds + * the table to the relationship, if necessary. */ public function addTable($join = NULL, $alias = NULL) { // This is used for lookups in the many_to_one table. diff --git a/core/modules/views/src/Plugin/views/argument_default/ArgumentDefaultPluginBase.php b/core/modules/views/src/Plugin/views/argument_default/ArgumentDefaultPluginBase.php index 50e55c59bfc8..e970372b5fb7 100644 --- a/core/modules/views/src/Plugin/views/argument_default/ArgumentDefaultPluginBase.php +++ b/core/modules/views/src/Plugin/views/argument_default/ArgumentDefaultPluginBase.php @@ -46,7 +46,8 @@ abstract class ArgumentDefaultPluginBase extends PluginBase { /** * Return the default argument. * - * This needs to be overridden by every default argument handler to properly do what is needed. + * This needs to be overridden by every default argument handler to properly + * do what is needed. */ public function getArgument() {} @@ -95,8 +96,8 @@ public function access() { * If we don't have access to the form but are showing it anyway, ensure that * the form is safe and cannot be changed from user input. * - * This is only called by child objects if specified in the buildOptionsForm(), - * so it will not always be used. + * This is only called by child objects if specified in the + * buildOptionsForm(), so it will not always be used. */ protected function checkAccess(&$form, $option_name) { if (!$this->access()) { diff --git a/core/modules/views/src/Plugin/views/argument_validator/ArgumentValidatorPluginBase.php b/core/modules/views/src/Plugin/views/argument_validator/ArgumentValidatorPluginBase.php index fcb3618d5665..5a3427c854af 100644 --- a/core/modules/views/src/Plugin/views/argument_validator/ArgumentValidatorPluginBase.php +++ b/core/modules/views/src/Plugin/views/argument_validator/ArgumentValidatorPluginBase.php @@ -88,8 +88,8 @@ public function access() { /** * Blocks user input when the form is shown but we don´t have access. * - * This is only called by child objects if specified in the buildOptionsForm(), - * so it will not always be used. + * This is only called by child objects if specified in the + * buildOptionsForm(), so it will not always be used. */ protected function checkAccess(&$form, $option_name) { if (!$this->access()) { diff --git a/core/modules/views/src/Plugin/views/display/DisplayPluginInterface.php b/core/modules/views/src/Plugin/views/display/DisplayPluginInterface.php index 11b0df989119..ffb43f692111 100644 --- a/core/modules/views/src/Plugin/views/display/DisplayPluginInterface.php +++ b/core/modules/views/src/Plugin/views/display/DisplayPluginInterface.php @@ -556,8 +556,8 @@ public function isIdentifierUnique($id, $identifier); /** * Is the output of the view empty. * - * If a view has no result and neither the empty, nor the footer nor the header - * does show anything return FALSE. + * If a view has no result and neither the empty, nor the footer nor the + * header does show anything return FALSE. * * @return bool * Returns TRUE if the output is empty, else FALSE. diff --git a/core/modules/views/src/Plugin/views/field/MachineName.php b/core/modules/views/src/Plugin/views/field/MachineName.php index bd9b89bad968..d8f683de5373 100644 --- a/core/modules/views/src/Plugin/views/field/MachineName.php +++ b/core/modules/views/src/Plugin/views/field/MachineName.php @@ -12,7 +12,8 @@ * @ingroup views_field_handlers * * Definition items: - * - options callback: The function to call in order to generate the value options. If omitted, the options 'Yes' and 'No' will be used. + * - options callback: The function to call in order to generate the value + * options. If omitted, the options 'Yes' and 'No' will be used. * - options arguments: An array of arguments to pass to the options callback. */ #[ViewsField("machine_name")] diff --git a/core/modules/views/src/Plugin/views/filter/InOperator.php b/core/modules/views/src/Plugin/views/filter/InOperator.php index 7c712975f86f..efe9c50ae337 100644 --- a/core/modules/views/src/Plugin/views/filter/InOperator.php +++ b/core/modules/views/src/Plugin/views/filter/InOperator.php @@ -14,7 +14,8 @@ * Filter to handle matching of multiple options selectable via checkboxes. * * Definition items: - * - options callback: The function to call in order to generate the value options. If omitted, the options 'Yes' and 'No' will be used. + * - options callback: The function to call in order to generate the value + * options. If omitted, the options 'Yes' and 'No' will be used. * - options arguments: An array of arguments to pass to the options callback. * * @ingroup views_filter_handlers diff --git a/core/modules/views/src/Plugin/views/wizard/WizardPluginBase.php b/core/modules/views/src/Plugin/views/wizard/WizardPluginBase.php index f8ac8068f3c1..37c50f80bd47 100644 --- a/core/modules/views/src/Plugin/views/wizard/WizardPluginBase.php +++ b/core/modules/views/src/Plugin/views/wizard/WizardPluginBase.php @@ -482,14 +482,14 @@ public function buildForm(array $form, FormStateInterface $form_state) { /** * Gets the current value of a #select element, from within a form constructor function. * - * This function is intended for use in highly dynamic forms (in particular the - * add view wizard) which are rebuilt in different ways depending on which - * triggering element (AJAX or otherwise) was most recently fired. For example, - * sometimes it is necessary to decide how to build one dynamic form element - * based on the value of a different dynamic form element that may not have - * even been present on the form the last time it was submitted. This function - * takes care of resolving those conflicts and gives you the proper current - * value of the requested #select element. + * This function is intended for use in highly dynamic forms (in particular + * the add view wizard) which are rebuilt in different ways depending on which + * triggering element (AJAX or otherwise) was most recently fired. For + * example, sometimes it is necessary to decide how to build one dynamic form + * element based on the value of a different dynamic form element that may not + * have even been present on the form the last time it was submitted. This + * function takes care of resolving those conflicts and gives you the proper + * current value of the requested #select element. * * By necessity, this function sometimes uses non-validated user input from * FormState::$input in making its determination. Although it performs some diff --git a/core/modules/views_ui/src/ViewEditForm.php b/core/modules/views_ui/src/ViewEditForm.php index 98963ce02ad8..0ce218d6b5c1 100644 --- a/core/modules/views_ui/src/ViewEditForm.php +++ b/core/modules/views_ui/src/ViewEditForm.php @@ -853,8 +853,8 @@ public function renderDisplayTop(ViewUI $view) { * the SharedTempStore rather than $form_state->setRebuild(). Without this * submit handler, buttons that add or remove displays would redirect to the * destination parameter (e.g., when the Edit View form is linked to from a - * contextual link). This handler can be added to buttons whose form submission - * should not yet redirect to the destination. + * contextual link). This handler can be added to buttons whose form + * submission should not yet redirect to the destination. */ public function submitDelayDestination($form, FormStateInterface $form_state) { $request = $this->requestStack->getCurrentRequest(); diff --git a/core/modules/views_ui/src/ViewFormBase.php b/core/modules/views_ui/src/ViewFormBase.php index dd4369beddc9..ae94c023d086 100644 --- a/core/modules/views_ui/src/ViewFormBase.php +++ b/core/modules/views_ui/src/ViewFormBase.php @@ -79,8 +79,8 @@ protected function prepareEntity() { * * This function can be called from hook_menu_local_tasks_alter() to implement * these tabs as secondary local tasks, or it can be called from elsewhere if - * having them as secondary local tasks isn't desired. The caller is responsible - * for setting the active tab's #active property to TRUE. + * having them as secondary local tasks isn't desired. The caller is + * responsible for setting the active tab's #active property to TRUE. * * @param \Drupal\views_ui\ViewUI $view * The ViewUI entity. diff --git a/core/modules/workflows/src/Annotation/WorkflowType.php b/core/modules/workflows/src/Annotation/WorkflowType.php index 808b3042ce77..b07a264a37b3 100644 --- a/core/modules/workflows/src/Annotation/WorkflowType.php +++ b/core/modules/workflows/src/Annotation/WorkflowType.php @@ -9,7 +9,8 @@ * * Plugin Namespace: Plugin\WorkflowType * - * For a working example, see \Drupal\content_moderation\Plugin\Workflow\ContentModerate + * For a working example, see + * \Drupal\content_moderation\Plugin\Workflow\ContentModerate * * @see \Drupal\workflows\WorkflowTypeInterface * @see \Drupal\workflows\WorkflowTypeManager diff --git a/core/modules/workflows/src/Attribute/WorkflowType.php b/core/modules/workflows/src/Attribute/WorkflowType.php index b60b80005f6f..e2065225d816 100644 --- a/core/modules/workflows/src/Attribute/WorkflowType.php +++ b/core/modules/workflows/src/Attribute/WorkflowType.php @@ -10,7 +10,8 @@ * * Plugin Namespace: Plugin\WorkflowType * - * For a working example, see \Drupal\content_moderation\Plugin\Workflow\ContentModerate + * For a working example, see + * \Drupal\content_moderation\Plugin\Workflow\ContentModerate * * @see \Drupal\workflows\WorkflowTypeInterface * @see \Drupal\workflows\WorkflowTypeManager diff --git a/core/tests/Drupal/KernelTests/Core/Config/ConfigEntityValidationTestBase.php b/core/tests/Drupal/KernelTests/Core/Config/ConfigEntityValidationTestBase.php index c113df70dde6..846405cf508c 100644 --- a/core/tests/Drupal/KernelTests/Core/Config/ConfigEntityValidationTestBase.php +++ b/core/tests/Drupal/KernelTests/Core/Config/ConfigEntityValidationTestBase.php @@ -631,7 +631,9 @@ protected function isFullyValidatable(): bool { /** * Determines the config entity mapping properties with required keys. * - * This refers only to the top-level properties of the config entity which are expected to be mappings, and of those mappings, only the ones which have required keys. + * This refers only to the top-level properties of the config entity which are + * expected to be mappings, and of those mappings, only the ones which have + * required keys. * * @return string[] * An array of key-value pairs, with: diff --git a/core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php b/core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php index b51cbf26d041..be8250e6d003 100644 --- a/core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php +++ b/core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php @@ -45,8 +45,8 @@ protected function bootKernel(): void { * Build a kernel for testings. * * Because the bootstrap is in DrupalKernel::boot and that involved loading - * settings from the filesystem we need to go to extra lengths to build a kernel - * for testing. + * settings from the filesystem we need to go to extra lengths to build a + * kernel for testing. * * @param \Symfony\Component\HttpFoundation\Request $request * A request object to use in booting the kernel. diff --git a/core/tests/Drupal/KernelTests/Core/Validation/UniqueValuesConstraintValidatorTest.php b/core/tests/Drupal/KernelTests/Core/Validation/UniqueValuesConstraintValidatorTest.php index c43f09849352..97e1c7876ac4 100644 --- a/core/tests/Drupal/KernelTests/Core/Validation/UniqueValuesConstraintValidatorTest.php +++ b/core/tests/Drupal/KernelTests/Core/Validation/UniqueValuesConstraintValidatorTest.php @@ -109,7 +109,8 @@ public function testValidation(): void { /** * Tests the UniqueField constraint validator for entity reference fields. * - * Case 2. Try to create another entity with existing reference for unique field. + * Case 2. Try to create another entity with existing reference for unique + * field. * * @throws \Drupal\Core\Entity\EntityStorageException * @@ -233,7 +234,8 @@ public function testValidationOwn(): void { /** * Tests the UniqueField constraint for multiple violations. * - * Case 4. Try to add multiple existing values for unique field in the same entity. + * Case 4. Try to add multiple existing values for unique field in the same + * entity. * * @throws \Drupal\Core\Entity\EntityStorageException * @@ -294,7 +296,8 @@ public function testValidationMultiple(): void { /** * Tests the UniqueField constraint with regards to case-insensitivity. * - * Case 5. Try to create another entity with existing value for unique field with different capitalization. + * Case 5. Try to create another entity with existing value for unique field + * with different capitalization. * * @throws \Drupal\Core\Entity\EntityStorageException * diff --git a/core/tests/Drupal/Tests/Component/Utility/ArgumentsResolverTest.php b/core/tests/Drupal/Tests/Component/Utility/ArgumentsResolverTest.php index d9d8563de208..cbd4ecbc2632 100644 --- a/core/tests/Drupal/Tests/Component/Utility/ArgumentsResolverTest.php +++ b/core/tests/Drupal/Tests/Component/Utility/ArgumentsResolverTest.php @@ -126,7 +126,8 @@ public function testGetArgumentOrder(): void { /** * Tests getArgument() with a wildcard parameter with no type hint. * - * Without the type hint, the wildcard object will not be passed to the callable. + * Without the type hint, the wildcard object will not be passed to the + * callable. */ public function testGetWildcardArgumentNoTypeHint(): void { $a = $this->getMockBuilder('\Drupal\Tests\Component\Utility\Test1Interface')->getMock(); diff --git a/core/tests/Drupal/Tests/Component/Utility/HtmlTest.php b/core/tests/Drupal/Tests/Component/Utility/HtmlTest.php index a3f30dac6598..5a543db9d15e 100644 --- a/core/tests/Drupal/Tests/Component/Utility/HtmlTest.php +++ b/core/tests/Drupal/Tests/Component/Utility/HtmlTest.php @@ -327,8 +327,9 @@ public function testDecodeEntitiesAndEscape(): void { /** * Tests Html::serialize(). * - * Resolves an issue by where an empty DOMDocument object sent to serialization would - * cause errors in getElementsByTagName() in the serialization function. + * Resolves an issue by where an empty DOMDocument object sent to + * serialization would cause errors in getElementsByTagName() in the + * serialization function. * * @covers ::serialize */ diff --git a/core/tests/Drupal/Tests/Component/Utility/UnicodeTest.php b/core/tests/Drupal/Tests/Component/Utility/UnicodeTest.php index 99ee8ff7e52f..2a979b6cba34 100644 --- a/core/tests/Drupal/Tests/Component/Utility/UnicodeTest.php +++ b/core/tests/Drupal/Tests/Component/Utility/UnicodeTest.php @@ -260,7 +260,8 @@ public function testValidateUtf8($text, $expected, $message): void { /** * Provides data for self::testValidateUtf8(). * - * Invalid UTF-8 examples sourced from http://stackoverflow.com/a/11709412/109119. + * Invalid UTF-8 examples sourced from + * http://stackoverflow.com/a/11709412/109119. * * @return array * An array of arrays, each containing the parameters for -- GitLab