diff --git a/core/lib/Drupal/Component/Utility/Unicode.php b/core/lib/Drupal/Component/Utility/Unicode.php index 7fae041f98..50e6921041 100644 --- a/core/lib/Drupal/Component/Utility/Unicode.php +++ b/core/lib/Drupal/Component/Utility/Unicode.php @@ -77,8 +77,7 @@ class Unicode { const STATUS_SINGLEBYTE = 0; /** - * Indicates that full unicode support with the PHP mbstring extension is - * being used. + * Indicates that full unicode support with PHP mbstring extension is used. */ const STATUS_MULTIBYTE = 1; diff --git a/core/lib/Drupal/Core/Ajax/OpenDialogCommand.php b/core/lib/Drupal/Core/Ajax/OpenDialogCommand.php index 623d3961bc..9164fce15c 100644 --- a/core/lib/Drupal/Core/Ajax/OpenDialogCommand.php +++ b/core/lib/Drupal/Core/Ajax/OpenDialogCommand.php @@ -37,16 +37,18 @@ class OpenDialogCommand implements CommandInterface, CommandWithAttachedAssetsIn protected $content; /** - * Stores dialog-specific options passed directly to jQuery UI dialogs. Any - * jQuery UI option can be used. See http://api.jqueryui.com/dialog. + * Stores dialog-specific options passed directly to jQuery UI dialogs. + * + * Any jQuery UI option can be used. + * + * @see http://api.jqueryui.com/dialog. * * @var array */ protected $dialogOptions; /** - * Custom settings that will be passed to the Drupal behaviors on the content - * of the dialog. + * Custom settings passed to Drupal behaviors on the content of the dialog. * * @var array */ diff --git a/core/lib/Drupal/Core/Annotation/QueueWorker.php b/core/lib/Drupal/Core/Annotation/QueueWorker.php index 354642a72c..b13071132d 100644 --- a/core/lib/Drupal/Core/Annotation/QueueWorker.php +++ b/core/lib/Drupal/Core/Annotation/QueueWorker.php @@ -52,15 +52,14 @@ class QueueWorker extends Plugin { public $title; /** - * An associative array containing an optional key. - * - * This property is optional and it does not need to be declared. - * - * Available keys: - * - time (optional): How much time Drupal cron should spend on calling this - * worker in seconds. Defaults to 15. + * An optional associative array of settings for cron. * * @var array + * The array has one key, time, which is set to the time Drupal cron should + * spend on calling this worker in seconds. The default is set in + * \Drupal\Core\Queue\QueueWorkerManager::processDefinition(). + * + * @see \Drupal\Core\Queue\QueueWorkerManager::processDefinition() */ public $cron; diff --git a/core/lib/Drupal/Core/Database/Database.php b/core/lib/Drupal/Core/Database/Database.php index 6493c87c5c..7941c25945 100644 --- a/core/lib/Drupal/Core/Database/Database.php +++ b/core/lib/Drupal/Core/Database/Database.php @@ -58,8 +58,7 @@ abstract class Database { const RETURN_INSERT_ID = 3; /** - * A nested array of all active connections. It is keyed by database name - * and target. + * A nested array of active connections, keyed by database name and target. * * @var array */ diff --git a/core/lib/Drupal/Core/Database/Query/Select.php b/core/lib/Drupal/Core/Database/Query/Select.php index 129151a735..93ffa081a6 100644 --- a/core/lib/Drupal/Core/Database/Query/Select.php +++ b/core/lib/Drupal/Core/Database/Query/Select.php @@ -93,8 +93,9 @@ class Select extends Query implements SelectInterface { protected $range; /** - * An array whose elements specify a query to UNION, and the UNION type. The - * 'type' key may be '', 'ALL', or 'DISTINCT' to represent a 'UNION', + * An array whose elements specify a query to UNION, and the UNION type. + * + * The 'type' key may be '', 'ALL', or 'DISTINCT' to represent a 'UNION', * 'UNION ALL', or 'UNION DISTINCT' statement, respectively. * * All entries in this array will be applied from front to back, with the diff --git a/core/lib/Drupal/Core/Entity/Annotation/EntityReferenceSelection.php b/core/lib/Drupal/Core/Entity/Annotation/EntityReferenceSelection.php index 110beb1ba1..33f64d60ec 100644 --- a/core/lib/Drupal/Core/Entity/Annotation/EntityReferenceSelection.php +++ b/core/lib/Drupal/Core/Entity/Annotation/EntityReferenceSelection.php @@ -60,8 +60,9 @@ class EntityReferenceSelection extends Plugin { public $group; /** - * An array of entity types that can be referenced by this plugin. Defaults to - * all entity types. + * An array of entity types that can be referenced by this plugin. + * + * Defaults to all entity types. * * This property is optional and it does not need to be declared. * diff --git a/core/lib/Drupal/Core/Entity/EntityDisplayBase.php b/core/lib/Drupal/Core/Entity/EntityDisplayBase.php index ee07817187..1724addaed 100644 --- a/core/lib/Drupal/Core/Entity/EntityDisplayBase.php +++ b/core/lib/Drupal/Core/Entity/EntityDisplayBase.php @@ -13,8 +13,7 @@ abstract class EntityDisplayBase extends ConfigEntityBase implements EntityDisplayInterface { /** - * The 'mode' for runtime EntityDisplay objects used to render entities with - * arbitrary display options rather than a configured view mode or form mode. + * The mode used to render entities with arbitrary display options. * * @todo Prevent creation of a mode with this ID * https://www.drupal.org/node/2410727 @@ -57,8 +56,10 @@ abstract class EntityDisplayBase extends ConfigEntityBase implements EntityDispl protected $mode = self::CUSTOM_MODE; /** - * Whether this display is enabled or not. If the entity (form) display - * is disabled, we'll fall back to the 'default' display. + * Whether this display is enabled or not. + * + * If the entity (form) display is disabled, we'll fall back to the 'default' + * display. * * @var bool */ @@ -79,8 +80,10 @@ abstract class EntityDisplayBase extends ConfigEntityBase implements EntityDispl protected $hidden = []; /** - * The original view or form mode that was requested (case of view/form modes - * being configured to fall back to the 'default' display). + * The original view or form mode that was requested. + * + * Case of view/form modes being configured to fall back to the 'default' + * display. * * @var string */ diff --git a/core/lib/Drupal/Core/Entity/EntityFieldManager.php b/core/lib/Drupal/Core/Entity/EntityFieldManager.php index 8ccdb86a0a..913ff73a8d 100644 --- a/core/lib/Drupal/Core/Entity/EntityFieldManager.php +++ b/core/lib/Drupal/Core/Entity/EntityFieldManager.php @@ -63,8 +63,10 @@ class EntityFieldManager implements EntityFieldManagerInterface { protected $activeFieldStorageDefinitions; /** - * An array keyed by entity type. Each value is an array whose keys are - * field names and whose value is an array with two entries: + * An array of lightweight maps of fields, keyed by entity type. + * + * Each value is an array whose keys are field names and whose value is an + * array with two entries: * - type: The field type. * - bundles: The bundles in which the field appears. * @@ -73,10 +75,11 @@ class EntityFieldManager implements EntityFieldManagerInterface { protected $fieldMap = []; /** - * An array keyed by field type. Each value is an array whose key are entity - * types including arrays in the same form that $fieldMap. + * An array of lightweight maps of fields, keyed by field type. * - * It helps access the mapping between types and fields by the field type. + * Each value is an array whose key are entity types including arrays in the + * same form as $fieldMap. It helps access the mapping between types and + * fields by the field type. * * @var array */ diff --git a/core/lib/Drupal/Core/Entity/Query/Sql/Query.php b/core/lib/Drupal/Core/Entity/Query/Sql/Query.php index b022b422e0..b666a441db 100644 --- a/core/lib/Drupal/Core/Entity/Query/Sql/Query.php +++ b/core/lib/Drupal/Core/Entity/Query/Sql/Query.php @@ -41,8 +41,9 @@ class Query extends QueryBase implements QueryInterface { protected $sqlFields = []; /** - * An array of strings added as to the group by, keyed by the string to avoid - * duplicates. + * An array of strings for the SQL 'group by' operation. + * + * Array is keyed by the string to avoid duplicates. * * @var array */ diff --git a/core/lib/Drupal/Core/Entity/Sql/DefaultTableMapping.php b/core/lib/Drupal/Core/Entity/Sql/DefaultTableMapping.php index 7cc5cb2f97..f8f759f055 100644 --- a/core/lib/Drupal/Core/Entity/Sql/DefaultTableMapping.php +++ b/core/lib/Drupal/Core/Entity/Sql/DefaultTableMapping.php @@ -54,8 +54,9 @@ class DefaultTableMapping implements TableMappingInterface { protected $dataTable; /** - * The table that stores revision field data if the entity supports revisions - * and has multilingual support. + * The table that stores revision field data. + * + * Only used if the entity supports revisions and has multilingual support. * * @var string */ diff --git a/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php b/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php index 4b7f793efd..abd5e4b30d 100644 --- a/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php +++ b/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php @@ -10,8 +10,7 @@ trait SynchronizableEntityTrait { /** - * Whether this entity is being created, updated or deleted through a - * synchronization process. + * Is entity being created updated or deleted through synchronization process. * * @var bool */ diff --git a/core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php b/core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php index 9ecac7a348..5f499e9175 100644 --- a/core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php +++ b/core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php @@ -64,9 +64,10 @@ class FieldFormatter extends Plugin { public $field_types = []; /** - * An integer to determine the weight of this formatter relative to other - * formatter in the Field UI when selecting a formatter for a given field - * instance. + * An integer to determine the weight of this formatter. + * + * Weight is relative to other formatter in the Field UI when selecting a + * formatter for a given field instance. * * This property is optional and it does not need to be declared. * diff --git a/core/lib/Drupal/Core/Field/Annotation/FieldWidget.php b/core/lib/Drupal/Core/Field/Annotation/FieldWidget.php index f17612284a..ff7dffd7f2 100644 --- a/core/lib/Drupal/Core/Field/Annotation/FieldWidget.php +++ b/core/lib/Drupal/Core/Field/Annotation/FieldWidget.php @@ -70,8 +70,10 @@ class FieldWidget extends Plugin { public $multiple_values = FALSE; /** - * An integer to determine the weight of this widget relative to other widgets - * in the Field UI when selecting a widget for a given field. + * An integer to determine weight of this widget relative to other widgets. + * + * Other widgets are in the Field UI when selecting a widget for a given + * field. * * This property is optional and it does not need to be declared. * diff --git a/core/lib/Drupal/Core/Field/FieldConfigBase.php b/core/lib/Drupal/Core/Field/FieldConfigBase.php index 3f4fc4ea5d..bcac237920 100644 --- a/core/lib/Drupal/Core/Field/FieldConfigBase.php +++ b/core/lib/Drupal/Core/Field/FieldConfigBase.php @@ -184,8 +184,10 @@ abstract class FieldConfigBase extends ConfigEntityBase implements FieldConfigIn protected $constraints = []; /** - * Array of property constraint options keyed by property ID. The values are - * associative array of constraint options keyed by constraint plugin ID. + * Array of property constraint options keyed by property ID. + * + * The values are associative array of constraint options keyed by constraint + * plugin ID. * * @var array[] */ diff --git a/core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsWidgetBase.php b/core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsWidgetBase.php index ffbfeb2f71..1fec41016d 100644 --- a/core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsWidgetBase.php +++ b/core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsWidgetBase.php @@ -23,8 +23,9 @@ abstract class OptionsWidgetBase extends WidgetBase { /** - * Abstract over the actual field columns, to allow different field types to - * reuse those widgets. + * Abstract over the actual field columns. + * + * Allows different field types to reuse those widgets. * * @var string */ diff --git a/core/lib/Drupal/Core/Form/FormState.php b/core/lib/Drupal/Core/Form/FormState.php index c4e76a4de4..a4fa4658c4 100644 --- a/core/lib/Drupal/Core/Form/FormState.php +++ b/core/lib/Drupal/Core/Form/FormState.php @@ -36,9 +36,10 @@ class FormState implements FormStateInterface { protected $complete_form; /** - * An associative array of information stored by Form API that is necessary to - * build and rebuild the form from cache when the original context may no - * longer be available: + * An associative array of information stored by Form API. + * + * This associative array is necessary to build and rebuild the form from + * cache when the original context may no longer be available: * - callback: The actual callback to be used to retrieve the form array. * Can be any callable. If none is provided $form_id is used as the name * of a function to call instead. @@ -70,8 +71,9 @@ class FormState implements FormStateInterface { ]; /** - * Similar to self::$build_info, but pertaining to - * \Drupal\Core\Form\FormBuilderInterface::rebuildForm(). + * Similar to self::$build_info. + * + * But pertaining to \Drupal\Core\Form\FormBuilderInterface::rebuildForm(). * * This property is uncacheable. * @@ -80,6 +82,8 @@ class FormState implements FormStateInterface { protected $rebuild_info = []; /** + * Determines whether the form is rebuilt. + * * Normally, after the entire form processing is completed and submit handlers * have run, a form is considered to be done and * \Drupal\Core\Form\FormSubmitterInterface::redirectForm() will redirect the @@ -103,6 +107,8 @@ class FormState implements FormStateInterface { protected $rebuild = FALSE; /** + * Determines if only safe element value callbacks are called. + * * If set to TRUE the form will skip calling form element value callbacks, * except for a select list of callbacks provided by Drupal core that are * known to be safe. @@ -116,6 +122,8 @@ class FormState implements FormStateInterface { protected $invalidToken = FALSE; /** + * The response object. + * * Used when a form needs to return some kind of a * \Symfony\Component\HttpFoundation\Response object, e.g., a * \Symfony\Component\HttpFoundation\BinaryFileResponse when triggering a @@ -140,8 +148,9 @@ class FormState implements FormStateInterface { protected $redirect; /** - * If set to TRUE the form will NOT perform a redirect, even if - * self::$redirect is set. + * If set to TRUE the form will NOT perform a redirect. + * + * Redirect will not be performed, even if self::$redirect is set. * * This property is uncacheable. * @@ -264,6 +273,8 @@ class FormState implements FormStateInterface { protected $always_process; /** + * Indicates if a validation will be forced. + * * Ordinarily, a form is only validated once, but there are times when a form * is resubmitted internally and should be validated again. Setting this to * TRUE will force that to happen. This is most likely to occur during Ajax @@ -276,6 +287,8 @@ class FormState implements FormStateInterface { protected $must_validate; /** + * Indicates if the form was submitted programmatically. + * * If TRUE, the form was submitted programmatically, usually invoked via * \Drupal\Core\Form\FormBuilderInterface::submitForm(). Defaults to FALSE. * @@ -284,6 +297,8 @@ class FormState implements FormStateInterface { protected $programmed = FALSE; /** + * Indicates if programmatic form submissions bypasses #access check. + * * If TRUE, programmatic form submissions are processed without taking #access * into account. Set this to FALSE when submitting a form programmatically * with values that may have been input by the user executing the current @@ -295,6 +310,8 @@ class FormState implements FormStateInterface { protected $programmed_bypass_access_check = TRUE; /** + * Indicates correct form submission. + * * TRUE signifies correct form submission. This is always TRUE for programmed * forms coming from \Drupal\Core\Form\FormBuilderInterface::submitForm() (see * 'programmed' key), or if the form_id coming from the @@ -323,10 +340,11 @@ class FormState implements FormStateInterface { protected $executed = FALSE; /** - * The form element that triggered submission, which may or may not be a - * button (in the case of Ajax forms). This key is often used to distinguish - * between various buttons in a submit handler, and is also used in Ajax - * handlers. + * The form element that triggered submission. + * + * This may or may not be a button (in the case of Ajax forms). This key is + * often used to distinguish between various buttons in a submit handler, and + * is also used in Ajax handlers. * * This property is uncacheable. * @@ -335,6 +353,8 @@ class FormState implements FormStateInterface { protected $triggering_element; /** + * Indicates a file element is present. + * * If TRUE, there is a file element and Form API will set the appropriate * 'enctype' HTML attribute on the form. * @@ -352,6 +372,8 @@ class FormState implements FormStateInterface { protected $groups = []; /** + * The storage. + * * This is not a special key, and no specific support is provided for it in * the Form API. By tradition it was the location where application-specific * data was stored for communication between the submit, validation, and form diff --git a/core/lib/Drupal/Core/Password/PhpassHashedPassword.php b/core/lib/Drupal/Core/Password/PhpassHashedPassword.php index b044035525..cb10978511 100644 --- a/core/lib/Drupal/Core/Password/PhpassHashedPassword.php +++ b/core/lib/Drupal/Core/Password/PhpassHashedPassword.php @@ -32,6 +32,8 @@ class PhpassHashedPassword implements PasswordInterface { public static $ITOA64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'; /** + * Password stretching iteration count. + * * Specifies the number of times the hashing function will be applied when * generating new password hashes. The number of times is calculated by * raising 2 to the power of the given value. diff --git a/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php b/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php index 6b7d86e066..62c78c3448 100644 --- a/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php +++ b/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php @@ -50,8 +50,9 @@ class DefaultPluginManager extends PluginManagerBase implements PluginManagerInt protected $alterHook; /** - * The subdirectory within a namespace to look for plugins, or FALSE if the - * plugins are in the top level of the namespace. + * The subdirectory within a namespace to look for plugins. + * + * Set to FALSE if the plugins are in the top level of the namespace. * * @var string|bool */ @@ -65,9 +66,10 @@ class DefaultPluginManager extends PluginManagerBase implements PluginManagerInt protected $moduleHandler; /** - * A set of defaults to be referenced by $this->processDefinition() if - * additional processing of plugins is necessary or helpful for development - * purposes. + * A set of defaults to be referenced by $this->processDefinition(). + * + * Allows for additional processing of plugins when necessary or helpful for + * development purposes. * * @var array */ @@ -88,16 +90,20 @@ class DefaultPluginManager extends PluginManagerBase implements PluginManagerInt protected $pluginInterface; /** - * An object that implements \Traversable which contains the root paths - * keyed by the corresponding namespace to look for plugin implementations. + * An object of root paths that are traversable. + * + * The root paths are keyed by the corresponding namespace to look for plugin + * implementations. * * @var \Traversable */ protected $namespaces; /** - * Additional namespaces the annotation discovery mechanism should scan for - * annotation definitions. + * Additional annotation namespaces. + * + * The annotation discovery mechanism should scan these for annotation + * definitions. * * @var string[] */ diff --git a/core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php b/core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php index 986ab77c95..8e78c9521d 100644 --- a/core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php +++ b/core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php @@ -11,6 +11,8 @@ class AnnotatedClassDiscovery extends ComponentAnnotatedClassDiscovery { /** + * The directory suffix. + * * A suffix to append to each PSR-4 directory associated with a base * namespace, to form the directories where plugins are found. * @@ -19,6 +21,8 @@ class AnnotatedClassDiscovery extends ComponentAnnotatedClassDiscovery { protected $directorySuffix = ''; /** + * The namespace suffix. + * * A suffix to append to each base namespace, to obtain the namespaces where * plugins are found. * diff --git a/core/lib/Drupal/Core/StreamWrapper/StreamWrapperInterface.php b/core/lib/Drupal/Core/StreamWrapper/StreamWrapperInterface.php index 38a7758d0a..a7e0c15720 100644 --- a/core/lib/Drupal/Core/StreamWrapper/StreamWrapperInterface.php +++ b/core/lib/Drupal/Core/StreamWrapper/StreamWrapperInterface.php @@ -82,11 +82,12 @@ interface StreamWrapperInterface extends PhpStreamWrapperInterface { const READ_VISIBLE = 0x0014; /** - * This is the default 'type' flag. This does not include - * StreamWrapperInterface::LOCAL, because PHP grants a greater trust level to - * local files (for example, they can be used in an "include" statement, - * regardless of the "allow_url_include" setting), so stream wrappers need to - * explicitly opt-in to this. + * The default 'type' flag. + * + * This does not include StreamWrapperInterface::LOCAL, because PHP grants a + * greater trust level to local files (for example, they can be used in an + * "include" statement, regardless of the "allow_url_include" setting), so + * stream wrappers need to explicitly opt-in to this. */ const NORMAL = 0x001C; diff --git a/core/lib/Drupal/Core/Template/TwigSandboxPolicy.php b/core/lib/Drupal/Core/Template/TwigSandboxPolicy.php index ff92b25c37..c10ad69323 100644 --- a/core/lib/Drupal/Core/Template/TwigSandboxPolicy.php +++ b/core/lib/Drupal/Core/Template/TwigSandboxPolicy.php @@ -25,8 +25,9 @@ class TwigSandboxPolicy implements SecurityPolicyInterface { protected $allowed_methods; /** - * An array of allowed method prefixes -- any method starting with one of - * these prefixes will be allowed. + * Allowed method prefixes. + * + * Any method starting with one of these prefixes will be allowed. * * @var array */ diff --git a/core/lib/Drupal/Core/Test/TestDatabase.php b/core/lib/Drupal/Core/Test/TestDatabase.php index 4041f0cc80..e16876a906 100644 --- a/core/lib/Drupal/Core/Test/TestDatabase.php +++ b/core/lib/Drupal/Core/Test/TestDatabase.php @@ -12,6 +12,8 @@ class TestDatabase { /** + * The test lock ID. + * * A random number used to ensure that test fixtures are unique to each test * method. * diff --git a/core/lib/Drupal/Core/Validation/Annotation/Constraint.php b/core/lib/Drupal/Core/Validation/Annotation/Constraint.php index 64af92e8f8..61082902a2 100644 --- a/core/lib/Drupal/Core/Validation/Annotation/Constraint.php +++ b/core/lib/Drupal/Core/Validation/Annotation/Constraint.php @@ -38,10 +38,11 @@ class Constraint extends Plugin { public $label; /** - * An array of DataType plugin IDs for which this constraint applies. Valid - * values are any types registered by the typed data API, or an array of - * multiple type names. For supporting all types, FALSE may be specified. The - * key defaults to an empty array, which indicates no types are supported. + * DataType plugin IDs for which this constraint applies. + * + * Valid values are any types registered by the typed data API, or an array + * of multiple type names. For supporting all types, FALSE may be specified. + * The key defaults to an empty array, which indicates no types are supported. * * @var string|string[]|false * diff --git a/core/modules/block/src/Plugin/migrate/process/BlockVisibility.php b/core/modules/block/src/Plugin/migrate/process/BlockVisibility.php index 4d7b19cd55..cb365b9550 100644 --- a/core/modules/block/src/Plugin/migrate/process/BlockVisibility.php +++ b/core/modules/block/src/Plugin/migrate/process/BlockVisibility.php @@ -34,8 +34,9 @@ class BlockVisibility extends ProcessPluginBase implements ContainerFactoryPlugi protected $migrateLookup; /** - * Whether or not to skip blocks that use PHP for visibility. Only applies - * if the PHP module is not enabled. + * Whether or not to skip blocks that use PHP for visibility. + * + * Only applies if the PHP module is not enabled. * * @var bool */ diff --git a/core/modules/content_translation/src/ContentTranslationHandler.php b/core/modules/content_translation/src/ContentTranslationHandler.php index 6a103e4757..7e782db495 100644 --- a/core/modules/content_translation/src/ContentTranslationHandler.php +++ b/core/modules/content_translation/src/ContentTranslationHandler.php @@ -78,8 +78,9 @@ class ContentTranslationHandler implements ContentTranslationHandlerInterface, E protected $currentUser; /** - * The array of installed field storage definitions for the entity type, keyed - * by field name. + * Installed field storage definitions for the entity type. + * + * Keyed by field name. * * @var \Drupal\Core\Field\FieldStorageDefinitionInterface[] */ diff --git a/core/modules/editor/src/Entity/Editor.php b/core/modules/editor/src/Entity/Editor.php index fc5f632d03..c48f219023 100644 --- a/core/modules/editor/src/Entity/Editor.php +++ b/core/modules/editor/src/Entity/Editor.php @@ -36,8 +36,7 @@ class Editor extends ConfigEntityBase implements EditorInterface { /** - * The machine name of the text format with which this configured text editor - * is associated. + * Machine name of the text format for this configured text editor. * * @var string * diff --git a/core/modules/editor/tests/src/Functional/EditorSecurityTest.php b/core/modules/editor/tests/src/Functional/EditorSecurityTest.php index 4574ccb5ae..5fe4913974 100644 --- a/core/modules/editor/tests/src/Functional/EditorSecurityTest.php +++ b/core/modules/editor/tests/src/Functional/EditorSecurityTest.php @@ -62,8 +62,7 @@ class EditorSecurityTest extends BrowserTestBase { protected $normalUser; /** - * User with access to Restricted HTML text format, dangerous tags allowed - * with text editor. + * User with access to Restricted HTML and tags considered dangerous. * * @var \Drupal\user\UserInterface */ diff --git a/core/modules/field/tests/src/Functional/Views/FieldTestBase.php b/core/modules/field/tests/src/Functional/Views/FieldTestBase.php index 831e6cccc8..71444ae9de 100644 --- a/core/modules/field/tests/src/Functional/Views/FieldTestBase.php +++ b/core/modules/field/tests/src/Functional/Views/FieldTestBase.php @@ -34,8 +34,7 @@ abstract class FieldTestBase extends ViewTestBase { public $fieldStorages; /** - * Stores the fields of the field storage. They have the same keys as the - * field storages. + * Stores the fields of the field storage. * * @var array */ diff --git a/core/modules/field/tests/src/FunctionalJavascript/EntityReference/EntityReferenceAdminTest.php b/core/modules/field/tests/src/FunctionalJavascript/EntityReference/EntityReferenceAdminTest.php index 6b057cbc89..36ca6b22f6 100644 --- a/core/modules/field/tests/src/FunctionalJavascript/EntityReference/EntityReferenceAdminTest.php +++ b/core/modules/field/tests/src/FunctionalJavascript/EntityReference/EntityReferenceAdminTest.php @@ -49,8 +49,7 @@ class EntityReferenceAdminTest extends WebDriverTestBase { protected $type; /** - * The name of a second content type to be used as a target of entity - * references. + * Name of a second content type to be used as a target of entity references. * * @var string */ diff --git a/core/modules/locale/locale.module b/core/modules/locale/locale.module index 1a30d0bfc1..dc724cadaa 100644 --- a/core/modules/locale/locale.module +++ b/core/modules/locale/locale.module @@ -117,14 +117,16 @@ const LOCALE_TRANSLATION_OVERWRITE_ALL = 'all'; /** - * UI option for override of existing translations. Only override non-customized - * translations. + * UI option for override of existing translations. + * + * Only override non-customized translations. */ const LOCALE_TRANSLATION_OVERWRITE_NON_CUSTOMIZED = 'non_customized'; /** - * UI option for override of existing translations. Don't override existing - * translations. + * UI option for override of existing translations. + * + * Don't override existing translations. */ const LOCALE_TRANSLATION_OVERWRITE_NONE = 'none'; diff --git a/core/modules/locale/tests/src/Functional/LocaleImportFunctionalTest.php b/core/modules/locale/tests/src/Functional/LocaleImportFunctionalTest.php index fcb107e4b3..a841080655 100644 --- a/core/modules/locale/tests/src/Functional/LocaleImportFunctionalTest.php +++ b/core/modules/locale/tests/src/Functional/LocaleImportFunctionalTest.php @@ -35,8 +35,7 @@ class LocaleImportFunctionalTest extends BrowserTestBase { protected $adminUser; /** - * A user able to create languages, import translations and access site - * reports. + * A user able to create languages, import translations, access site reports. * * @var \Drupal\user\Entity\User */ diff --git a/core/modules/rest/tests/src/Functional/EntityResource/EntityResourceTestBase.php b/core/modules/rest/tests/src/Functional/EntityResource/EntityResourceTestBase.php index a97cfa3a6c..31ab7f8c5b 100644 --- a/core/modules/rest/tests/src/Functional/EntityResource/EntityResourceTestBase.php +++ b/core/modules/rest/tests/src/Functional/EntityResource/EntityResourceTestBase.php @@ -85,6 +85,8 @@ abstract class EntityResourceTestBase extends ResourceTestBase { protected static $patchProtectedFieldNames; /** + * The unique field names. + * * The fields that need a different (random) value for each new entity created * by a POST request. * @@ -93,6 +95,8 @@ abstract class EntityResourceTestBase extends ResourceTestBase { protected static $uniqueFieldNames = []; /** + * The field name for the label. + * * Optionally specify which field is the 'label' field. Some entities do not * specify a 'label' entity key. For example: User. * diff --git a/core/modules/taxonomy/src/TermStorage.php b/core/modules/taxonomy/src/TermStorage.php index 696be8ff70..5d1332a447 100644 --- a/core/modules/taxonomy/src/TermStorage.php +++ b/core/modules/taxonomy/src/TermStorage.php @@ -40,8 +40,7 @@ class TermStorage extends SqlContentEntityStorage implements TermStorageInterfac protected $trees = []; /** - * Array of all loaded term ancestry keyed by ancestor term ID, keyed by term - * ID. + * Term ancestry keyed by ancestor term ID, keyed by term ID. * * @var \Drupal\taxonomy\TermInterface[][] */ diff --git a/core/modules/views/src/Plugin/views/HandlerBase.php b/core/modules/views/src/Plugin/views/HandlerBase.php index d13570d256..042658dc65 100644 --- a/core/modules/views/src/Plugin/views/HandlerBase.php +++ b/core/modules/views/src/Plugin/views/HandlerBase.php @@ -45,6 +45,8 @@ abstract class HandlerBase extends PluginBase implements ViewsHandlerInterface { public $tableAlias; /** + * The real field. + * * The actual field in the database table, maybe different * on other kind of query plugins/special handlers. * diff --git a/core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php b/core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php index a3838e5fd7..a0da30c604 100644 --- a/core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php +++ b/core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php @@ -71,9 +71,11 @@ abstract class ArgumentPluginBase extends HandlerBase implements CacheableDepend public string $name_table_alias; /** - * The field to use for the name to use in the summary, which is - * the displayed output. For example, for the node: nid argument, - * the argument itself is the nid, but node.title is displayed. + * The field to use for the name to display in the summary. + * + * For example, for the node: nid argument, the argument itself is the nid, + * but node.title is displayed. + * * @var string */ public $name_field; @@ -531,6 +533,8 @@ public function submitOptionsForm(&$form, FormStateInterface $form_state) { } /** + * Default actions. + * * Provide a list of default behaviors for this argument if the argument * is not present. * diff --git a/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php b/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php index 1da612333e..c19ccb2252 100644 --- a/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php +++ b/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php @@ -46,6 +46,8 @@ abstract class FilterPluginBase extends HandlerBase implements CacheableDependencyInterface { /** + * The value. + * * Contains the actual value of the field,either configured in the views ui * or entered in the exposed filters. */ diff --git a/core/modules/views/src/Plugin/views/query/Sql.php b/core/modules/views/src/Plugin/views/query/Sql.php index 28571aecfe..f3b7e1539f 100644 --- a/core/modules/views/src/Plugin/views/query/Sql.php +++ b/core/modules/views/src/Plugin/views/query/Sql.php @@ -41,21 +41,26 @@ class Sql extends QueryPluginBase { public $tables = []; /** - * Holds an array of relationships, which are aliases of the primary - * table that represent different ways to join the same table in. + * Holds an array of relationships. + * + * These are aliases of the primary table that represent different ways to + * join the same table in. */ public $relationships = []; /** - * An array of sections of the WHERE query. Each section is in itself - * an array of pieces and a flag as to whether or not it should be AND - * or OR. + * An array of sections of the WHERE query. + * + * Each section is in itself an array of pieces and a flag as to whether or + * not it should be AND or OR. */ + public $where = []; /** - * An array of sections of the HAVING query. Each section is in itself - * an array of pieces and a flag as to whether or not it should be AND - * or OR. + * An array of sections of the HAVING query. + * + * Each section is in itself an array of pieces and a flag as to whether or + * not it should be AND or OR. */ public $having = []; diff --git a/core/modules/views_ui/src/ViewUI.php b/core/modules/views_ui/src/ViewUI.php index f7646231a2..9a0bd7a993 100644 --- a/core/modules/views_ui/src/ViewUI.php +++ b/core/modules/views_ui/src/ViewUI.php @@ -121,8 +121,9 @@ class ViewUI implements ViewEntityInterface { ]; /** - * Whether the config is being created, updated or deleted through the - * import process. + * Whether the config is being synced through the import process. + * + * This is the case with create, update or delete. * * @var bool */