Issue #2909371 by mfernea, quietone, zaporylie, smustgrave: Fix 'Drupal.Commenting.VariableComment.VarOrder' coding standard

merge-requests/5896/merge
nod_ 2024-08-14 17:06:18 +02:00
parent fd8e5aa29a
commit 32abf4b360
No known key found for this signature in database
GPG Key ID: 76624892606FA197
80 changed files with 215 additions and 221 deletions

View File

@ -51,10 +51,10 @@ class Html {
* tag. That tag only makes sense in an HTML-served-as-HTML context, in
* which case relative URLs are guaranteed to work.
*
* @var string[]
*
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes
* @see https://stackoverflow.com/questions/2725156/complete-list-of-html-tag-attributes-which-have-a-url-value
*
* @var string[]
*/
protected static $uriAttributes = ['href', 'poster', 'src', 'cite', 'data', 'action', 'formaction', 'srcset', 'about'];

View File

@ -41,9 +41,9 @@ class OpenDialogCommand implements CommandInterface, CommandWithAttachedAssetsIn
*
* Any jQuery UI option can be used.
*
* @see http://api.jqueryui.com/dialog.
*
* @var array
*
* @see http://api.jqueryui.com/dialog.
*/
protected $dialogOptions;

View File

@ -29,9 +29,9 @@ class Action extends Plugin {
/**
* The human-readable name of the action plugin.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;
@ -40,18 +40,18 @@ class Action extends Plugin {
*
* This property is optional and it does not need to be declared.
*
* @todo Provide a more generic way to allow an action to be confirmed first.
*
* @var string
*
* @todo Provide a more generic way to allow an action to be confirmed first.
*/
public $confirm_form_route_name = '';
/**
* The entity type the action can apply to.
*
* @todo Replace with \Drupal\Core\Plugin\Context\Context.
*
* @var string
*
* @todo Replace with \Drupal\Core\Plugin\Context\Context.
*/
public $type = '';

View File

@ -30,18 +30,18 @@ class Archiver extends Plugin {
/**
* The human-readable name of the archiver plugin.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $title;
/**
* The description of the archiver plugin.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $description;

View File

@ -42,9 +42,9 @@ class DatabaseBackend implements CacheBackendInterface {
/**
* The maximum number of rows that this cache bin table is allowed to store.
*
* @see ::MAXIMUM_NONE
*
* @var int
*
* @see ::MAXIMUM_NONE
*/
protected $maxRows;

View File

@ -35,9 +35,9 @@ class Condition extends Plugin {
/**
* The human-readable name of the condition.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;

View File

@ -47,9 +47,9 @@ final class ImportStorageTransformer {
/**
* The persistent lock which the config importer uses across requests.
*
* @see \Drupal\Core\Config\ConfigImporter::alreadyImporting()
*
* @var \Drupal\Core\Lock\LockBackendInterface
*
* @see \Drupal\Core\Config\ConfigImporter::alreadyImporting()
*/
protected $persistentLock;

View File

@ -13,9 +13,9 @@ class UnmetDependenciesException extends ConfigException {
/**
* A list of configuration objects that have unmet dependencies.
*
* @var array
* The list is keyed by the config object name, and the value is an array of
* the missing dependencies:
*
* @code
*
* self::configObjects = [
@ -26,8 +26,6 @@ class UnmetDependenciesException extends ConfigException {
* ];
*
* @endcode
*
* @var array
*/
protected $configObjects = [];

View File

@ -103,6 +103,8 @@ class Merge extends Query implements ConditionInterface {
/**
* Array of fields to update to an expression in case of a duplicate record.
*
* @var array
*
* This variable is a nested array in the following format:
* @code
* <some field> => [
@ -110,8 +112,6 @@ class Merge extends Query implements ConditionInterface {
* 'arguments' => <array of arguments for condition, or NULL for none>,
* ];
* @endcode
*
* @var array
*/
protected $expressionFields = [];

View File

@ -37,6 +37,8 @@ class Update extends Query implements ConditionInterface {
/**
* Array of fields to update to an expression in case of a duplicate record.
*
* @var array
*
* This variable is a nested array in the following format:
* @code
* <some field> => [
@ -44,8 +46,6 @@ class Update extends Query implements ConditionInterface {
* 'arguments' => <array of arguments for condition, or NULL for none>,
* ];
* @endcode
*
* @var array
*/
protected $expressionFields = [];

View File

@ -30,9 +30,9 @@ abstract class Schema implements PlaceholderInterface {
* by defining the defaultSchema variable only MySQL has to re-write the
* method.
*
* @see DatabaseSchema::getPrefixInfo()
*
* @var string
*
* @see DatabaseSchema::getPrefixInfo()
*/
protected $defaultSchema = 'public';

View File

@ -29,6 +29,7 @@ class DrupalDateTime extends DateTimePlus {
/**
* Formatted strings translation cache.
*
* @var array
* Translation cache represents an instance storage for formatted date
* strings. It contains a multidimensional array where:
* - first level keys - are drupal language codes;
@ -53,8 +54,6 @@ class DrupalDateTime extends DateTimePlus {
* ],
* ]
* @endcode
*
* @var array
*/
protected $formatTranslationCache = [];

View File

@ -227,9 +227,9 @@ class DrupalKernel implements DrupalKernelInterface, TerminableInterface {
/**
* List of instantiated service provider classes.
*
* @see \Drupal\Core\DrupalKernel::$serviceProviderClasses
*
* @var array
*
* @see \Drupal\Core\DrupalKernel::$serviceProviderClasses
*/
protected $serviceProviders;

View File

@ -35,15 +35,16 @@ class EntityReferenceSelection extends Plugin {
/**
* The human-readable name of the selection plugin.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;
/**
* The selection plugin group.
*
* @var string
* This property is used to allow selection plugins to target a specific
* entity type while also inheriting the code of an existing selection plugin.
* For example, if we want to override the NodeSelection from the 'default'
@ -54,8 +55,6 @@ class EntityReferenceSelection extends Plugin {
* group = "default",
* weight = 5
* @endcode
*
* @var string
*/
public $group;

View File

@ -31,11 +31,11 @@ abstract class ContentEntityBase extends EntityBase implements \IteratorAggregat
* are keyed by language code, whereas LanguageInterface::LANGCODE_DEFAULT
* is used for values in default language.
*
* @var array
*
* @todo Add methods for getting original fields and for determining
* changes.
* @todo Provide a better way for defining default values.
*
* @var array
*/
protected $values = [];
@ -49,9 +49,9 @@ abstract class ContentEntityBase extends EntityBase implements \IteratorAggregat
/**
* Local cache for field definitions.
*
* @see ContentEntityBase::getFieldDefinitions()
*
* @var array
*
* @see ContentEntityBase::getFieldDefinitions()
*/
protected $fieldDefinitions;

View File

@ -20,12 +20,12 @@ abstract class EntityStorageBase extends EntityHandlerBase implements EntityStor
/**
* Information about the entity type.
*
* @var \Drupal\Core\Entity\EntityTypeInterface
*
* The following code returns the same object:
* @code
* \Drupal::entityTypeManager()->getDefinition($this->entityTypeId)
* @endcode
*
* @var \Drupal\Core\Entity\EntityTypeInterface
*/
protected $entityType;

View File

@ -28,9 +28,9 @@ class Tables implements TablesInterface {
* properties. Its keys are unique references to the tables, values are
* aliases.
*
* @see \Drupal\Core\Entity\Query\Sql\Tables::ensureEntityTable().
*
* @var array
*
* @see \Drupal\Core\Entity\Query\Sql\Tables::ensureEntityTable().
*/
protected $entityTables = [];

View File

@ -32,18 +32,18 @@ class FieldFormatter extends Plugin {
/**
* The human-readable name of the formatter type.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;
/**
* A short description of the formatter type.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $description;

View File

@ -33,27 +33,27 @@ class FieldType extends DataType {
/**
* The human-readable name of the field type.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;
/**
* A short human readable description for the field type.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $description;
/**
* The category under which the field type should be listed in the UI.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $category = '';

View File

@ -31,18 +31,18 @@ class FieldWidget extends Plugin {
/**
* The human-readable name of the widget type.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;
/**
* A short description of the widget type.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $description;

View File

@ -118,6 +118,7 @@ abstract class FieldConfigBase extends ConfigEntityBase implements FieldConfigIn
/**
* Default field value.
*
* @var array
* The default value is used when an entity is created, either:
* - through an entity creation form; the form elements for the field are
* prepopulated with the default value.
@ -141,8 +142,6 @@ abstract class FieldConfigBase extends ConfigEntityBase implements FieldConfigIn
* ['value' => 2],
* ]
* @endcode
*
* @var array
*/
protected $default_value = [];

View File

@ -59,9 +59,9 @@ class EntityReferenceEntityFormatter extends EntityReferenceFormatterBase {
* Each counter takes into account all the relevant information about the
* field and the referenced entity that is being rendered.
*
* @see \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceEntityFormatter::viewElements()
*
* @var array
*
* @see \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceEntityFormatter::viewElements()
*/
protected static $recursiveRenderDepth = [];

View File

@ -22,9 +22,9 @@ abstract class PluginSettingsBase extends PluginBase implements PluginSettingsIn
/**
* The plugin settings injected by third party modules.
*
* @see hooks
*
* @var array
*
* @see hooks
*/
protected $thirdPartySettings = [];

View File

@ -103,9 +103,9 @@ class FormState implements FormStateInterface {
*
* This property is uncacheable.
*
* @see self::setRebuild()
*
* @var bool
*
* @see self::setRebuild()
*/
protected $rebuild = FALSE;
@ -118,9 +118,9 @@ class FormState implements FormStateInterface {
*
* This property is uncacheable.
*
* @see self::setInvalidToken()
*
* @var bool
*
* @see self::setInvalidToken()
*/
protected $invalidToken = FALSE;
@ -149,11 +149,11 @@ class FormState implements FormStateInterface {
/**
* Used to redirect the form on submission.
*
* @see self::getRedirect()
*
* This property is uncacheable.
*
* @var \Drupal\Core\Url|\Symfony\Component\HttpFoundation\RedirectResponse|null
*
* @see self::getRedirect()
*/
protected $redirect;

View File

@ -37,9 +37,9 @@ class ImageToolkit extends Plugin {
*
* The string should be wrapped in @Translation().
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $title;

View File

@ -65,9 +65,9 @@ class ImageToolkitOperation extends Plugin {
*
* The string should be wrapped in @Translation().
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;
@ -76,9 +76,9 @@ class ImageToolkitOperation extends Plugin {
*
* The string should be wrapped in @Translation().
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $description;

View File

@ -26,9 +26,9 @@ class Layout extends Plugin {
/**
* Any additional properties and values.
*
* @see \Drupal\Core\Layout\LayoutDefinition::$additional
*
* @var array
*
* @see \Drupal\Core\Layout\LayoutDefinition::$additional
*/
public readonly array $additional;

View File

@ -32,9 +32,9 @@ class YamlDiscovery implements DiscoveryInterface {
/**
* Contains an array of translatable properties passed along to t().
*
* @see \Drupal\Core\Plugin\Discovery\YamlDiscovery::addTranslatableProperty()
*
* @var array
*
* @see \Drupal\Core\Plugin\Discovery\YamlDiscovery::addTranslatableProperty()
*/
protected $translatableProperties = [];

View File

@ -75,9 +75,9 @@ class HtmlRenderer implements MainContentRendererInterface {
/**
* The renderer configuration array.
*
* @see sites/default/default.services.yml
*
* @var array
*
* @see sites/default/default.services.yml
*/
protected $rendererConfig;

View File

@ -38,10 +38,10 @@ class SessionManager extends NativeSessionStorage implements SessionManagerInter
/**
* The write safe session handler.
*
* @var \Drupal\Core\Session\WriteSafeSessionHandlerInterface
*
* @todo This reference should be removed once all database queries
* are removed from the session manager class.
*
* @var \Drupal\Core\Session\WriteSafeSessionHandlerInterface
*/
protected $writeSafeHandler;

View File

@ -63,9 +63,9 @@ trait FunctionalTestSetupTrait {
/**
* Set to TRUE to make user 1 a super user.
*
* @see \Drupal\Core\Session\SuperUserAccessPolicy
*
* @var bool
*
* @see \Drupal\Core\Session\SuperUserAccessPolicy
*/
protected bool $usesSuperUserAccessPolicy;

View File

@ -42,9 +42,9 @@ trait TestSetupTrait {
/**
* The public file directory for the test environment.
*
* @see \Drupal\Tests\BrowserTestBase::prepareEnvironment()
*
* @var string
*
* @see \Drupal\Tests\BrowserTestBase::prepareEnvironment()
*/
protected $publicFilesDirectory;
@ -58,18 +58,18 @@ trait TestSetupTrait {
/**
* The private file directory for the test environment.
*
* @see \Drupal\Tests\BrowserTestBase::prepareEnvironment()
*
* @var string
*
* @see \Drupal\Tests\BrowserTestBase::prepareEnvironment()
*/
protected $privateFilesDirectory;
/**
* Set to TRUE to strict check all configuration saved.
*
* @see \Drupal\Core\Config\Testing\ConfigSchemaChecker
*
* @var bool
*
* @see \Drupal\Core\Config\Testing\ConfigSchemaChecker
*/
protected $strictConfigSchema = TRUE;
@ -100,10 +100,10 @@ trait TestSetupTrait {
* This value has to match the temporary directory created in
* install_base_system() for test installs.
*
* @var string
*
* @see \Drupal\Tests\BrowserTestBase::prepareEnvironment()
* @see install_base_system()
*
* @var string
*/
protected $tempFilesDirectory;

View File

@ -43,18 +43,18 @@ class DataType extends Plugin {
/**
* The human-readable name of the data type.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;
/**
* The description of the data type.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $description;

View File

@ -31,9 +31,9 @@ class Constraint extends Plugin {
/**
* The human-readable name of the constraint plugin.
*
* @ingroup plugin_translatable
*
* @var string|\Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;

View File

@ -33,9 +33,9 @@ class EntityBundleExistsConstraint extends SymfonyConstraint {
*
* This can contain variable values (e.g., `%parent`) that will be replaced.
*
* @see \Drupal\Core\Config\Schema\TypeResolver::replaceVariable()
*
* @var string
*
* @see \Drupal\Core\Config\Schema\TypeResolver::replaceVariable()
*/
public string $entityTypeId;

View File

@ -34,10 +34,10 @@ class BigPipeResponse extends HtmlResponse implements ResponseKeepSessionOpenInt
* Still contains placeholders. Its cacheability metadata and attachments are
* for everything except the placeholders (since those are not yet rendered).
*
* @var \Drupal\Core\Render\HtmlResponse
*
* @see \Drupal\Core\Render\StreamedResponseInterface
* @see ::getStreamedResponse()
*
* @var \Drupal\Core\Render\HtmlResponse
*/
protected $originalHtmlResponse;

View File

@ -41,9 +41,9 @@ class CKEditor5AllowedTagsTest extends CKEditor5TestBase {
/**
* The default allowed elements for filter_html's "allowed_html" setting.
*
* @see \Drupal\filter\Plugin\Filter\FilterHtml
*
* @var string
*
* @see \Drupal\filter\Plugin\Filter\FilterHtml
*/
protected $defaultElementsWhenUpdatingNotCkeditor5 = "<a href hreflang> <em> <strong> <cite> <blockquote cite> <code> <ul type> <ol start type='1 A I'> <li> <dl> <dt> <dd> <h2 id='jump-*'> <h3 id> <h4 id> <h5 id> <h6 id>";

View File

@ -31,9 +31,9 @@ class SmartDefaultSettingsTest extends KernelTestBase {
*
* The updated Text Format & Text Editors are explicitly checked.
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*
* @var bool
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*/
protected $strictConfigSchema = FALSE;

View File

@ -30,9 +30,9 @@ class ConfigNamesMapperTest extends UnitTestCase {
/**
* The configuration names mapper to test.
*
* @see \Drupal\config_translation\ConfigNamesMapper
*
* @var \Drupal\Tests\config_translation\Unit\TestConfigNamesMapper
*
* @see \Drupal\config_translation\ConfigNamesMapper
*/
protected $configNamesMapper;

View File

@ -62,9 +62,9 @@ class Editor extends Plugin {
/**
* The human-readable name of the editor plugin.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;

View File

@ -40,9 +40,9 @@ abstract class FieldKernelTestBase extends KernelTestBase {
* - $this->fieldTestData->field[suffix]
* - $this->fieldTestData->field_definition[suffix]
*
* @see \Drupal\field\Tests\FieldUnitTestBase::createFieldWithStorage()
*
* @var \ArrayObject
*
* @see \Drupal\field\Tests\FieldUnitTestBase::createFieldWithStorage()
*/
protected $fieldTestData;

View File

@ -46,10 +46,10 @@ class MaximumFileSizeExceededUploadTest extends WebDriverTestBase {
/**
* The original value of the 'display_errors' PHP configuration option.
*
* @var string
*
* @todo Remove this when issue #2905597 is fixed.
* @see https://www.drupal.org/node/2905597
*
* @var string
*/
protected $originalDisplayErrorsValue;

View File

@ -39,9 +39,9 @@ class Filter extends Plugin {
*
* This is used as an administrative summary of what the filter does.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $title;
@ -50,9 +50,9 @@ class Filter extends Plugin {
*
* This property is optional and it does not need to be declared.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $description = '';

View File

@ -64,9 +64,9 @@ class FilterFormat extends ConfigEntityBase implements FilterFormatInterface, En
/**
* Unique machine name of the format.
*
* @todo Rename to $id.
*
* @var string
*
* @todo Rename to $id.
*/
protected $format;
@ -77,9 +77,9 @@ class FilterFormat extends ConfigEntityBase implements FilterFormatInterface, En
* label but different filter configuration would impose a security risk.
* Therefore, each text format label must be unique.
*
* @todo Rename to $label.
*
* @var string
*
* @todo Rename to $label.
*/
protected $name;

View File

@ -66,9 +66,9 @@ class FilterProcessResult extends BubbleableMetadata {
/**
* The processed text.
*
* @see \Drupal\filter\Plugin\FilterInterface::process()
*
* @var string
*
* @see \Drupal\filter\Plugin\FilterInterface::process()
*/
protected $processedText;

View File

@ -35,9 +35,9 @@ class ImageEffect extends Plugin {
/**
* The human-readable name of the image effect.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;
@ -48,9 +48,9 @@ class ImageEffect extends Plugin {
*
* This will be shown when adding or configuring this image effect.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $description = '';

View File

@ -52,18 +52,18 @@ class LanguageNegotiation extends Plugin {
/**
* The human-readable name of the language negotiation plugin.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $name;
/**
* The description of the language negotiation plugin.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $description;

View File

@ -98,10 +98,10 @@ class ConfigurableLanguage extends ConfigEntityBase implements ConfigurableLangu
* This property is not saved to the language entity, but is needed for
* detecting when to rebuild the services.
*
* @var bool
*
* @see \Drupal\language\Entity\ConfigurableLanguage::preSave()
* @see \Drupal\language\Entity\ConfigurableLanguage::postSave()
*
* @var bool
*/
protected $preSaveMultilingual;

View File

@ -50,9 +50,9 @@ class LanguageNegotiationContentEntity extends LanguageNegotiationMethodBase imp
/**
* Static cache for the language negotiation order check.
*
* @see \Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationContentEntity::hasLowerLanguageNegotiationWeight()
*
* @var bool
*
* @see \Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationContentEntity::hasLowerLanguageNegotiationWeight()
*/
protected $hasLowerLanguageNegotiationWeightResult;

View File

@ -78,9 +78,9 @@ class LocaleConfigManager {
/**
* Whether or not configuration translations are being updated from locale.
*
* @see self::isUpdatingFromLocale()
*
* @var bool
*
* @see self::isUpdatingFromLocale()
*/
protected $isUpdatingFromLocale = FALSE;

View File

@ -25,6 +25,8 @@ class PluralFormula implements PluralFormulaInterface {
/**
* The plural formula and count keyed by langcode.
*
* @var array
*
* For example the structure looks like this:
* @code
* [
@ -36,7 +38,6 @@ class PluralFormula implements PluralFormulaInterface {
* ],
* ]
* @endcode
* @var array
*/
protected $formulae;

View File

@ -47,9 +47,9 @@ class MigrateSource extends Plugin implements MultipleProviderAnnotationInterfac
* Migrate Drupal's source plugins expect source_module to be the name of a
* module that must be installed and enabled in the source database.
*
* @see \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase::checkRequirements
*
* @var string
*
* @see \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase::checkRequirements
*/
public $source_module;

View File

@ -85,9 +85,9 @@ class MigrateExecutable implements MigrateExecutableInterface {
/**
* Migration message service.
*
* @todo https://www.drupal.org/node/2822663 Make this protected.
*
* @var \Drupal\migrate\MigrateMessageInterface
*
* @todo https://www.drupal.org/node/2822663 Make this protected.
*/
public $message;

View File

@ -46,9 +46,9 @@ class MigrateUpgradeImportBatch {
/**
* The maximum length in seconds to allow processing in a request.
*
* @see self::run()
*
* @var int
*
* @see self::run()
*/
protected static $maxExecTime;

View File

@ -78,11 +78,11 @@ class Connection extends DatabaseConnection implements SupportsTemporaryTablesIn
* savepoints opened to to mimic MySql's InnoDB functionality, which provides
* an inherent savepoint before any query in a transaction.
*
* @var array<string,Transaction>
*
* @see ::addSavepoint()
* @see ::releaseSavepoint()
* @see ::rollbackSavepoint()
*
* @var array<string,Transaction>
*/
protected array $savepoints = [];

View File

@ -28,8 +28,9 @@ class Schema extends DatabaseSchema {
* This is collected by Schema::queryTableInformation(), by introspecting the
* database.
*
* @see \Drupal\pgsql\Driver\Database\pgsql\Schema::queryTableInformation()
* @var array
*
* @see \Drupal\pgsql\Driver\Database\pgsql\Schema::queryTableInformation()
*/
protected $tableInformation = [];

View File

@ -32,9 +32,9 @@ class RestResource extends Plugin {
/**
* The human-readable name of the REST resource plugin.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;
@ -43,9 +43,9 @@ class RestResource extends Plugin {
*
* This property is optional and it does not need to be declared.
*
* @see \Symfony\Component\Serializer\SerializerInterface's "type" parameter.
*
* @var string
*
* @see \Symfony\Component\Serializer\SerializerInterface's "type" parameter.
*/
public $serialization_class;
@ -55,9 +55,9 @@ class RestResource extends Plugin {
* Key-value pairs, with link relation type plugin IDs as keys, and URL
* templates as values.
*
* @see core/core.link_relation_types.yml
*
* @var string[]
*
* @see core/core.link_relation_types.yml
*/
public $uri_paths = [];

View File

@ -27,27 +27,27 @@ trait CookieResourceTestTrait {
/**
* The session cookie.
*
* @see ::initAuthentication
*
* @var string
*
* @see ::initAuthentication
*/
protected $sessionCookie;
/**
* The CSRF token.
*
* @see ::initAuthentication
*
* @var string
*
* @see ::initAuthentication
*/
protected $csrfToken;
/**
* The logout token.
*
* @see ::initAuthentication
*
* @var string
*
* @see ::initAuthentication
*/
protected $logoutToken;

View File

@ -103,9 +103,9 @@ abstract class EntityResourceTestBase extends ResourceTestBase {
*
* Some entities do not specify a 'label' entity key. For example: User.
*
* @see ::getInvalidNormalizedEntityToCreate
*
* @var string|null
*
* @see ::getInvalidNormalizedEntityToCreate
*/
protected static $labelFieldName = NULL;
@ -114,9 +114,9 @@ abstract class EntityResourceTestBase extends ResourceTestBase {
*
* The default value of 2 should work for most content entities.
*
* @see ::testPost()
*
* @var string|int
*
* @see ::testPost()
*/
protected static $firstCreatedEntityId = 2;
@ -125,9 +125,9 @@ abstract class EntityResourceTestBase extends ResourceTestBase {
*
* The default value of 3 should work for most content entities.
*
* @see ::testPost()
*
* @var string|int
*
* @see ::testPost()
*/
protected static $secondCreatedEntityId = 3;

View File

@ -32,11 +32,11 @@ abstract class ResourceTestBase extends BrowserTestBase {
* A format is the combination of a certain normalizer and a certain
* serializer.
*
* @see https://www.drupal.org/developing/api/8/serialization
*
* (The default is 'json' because that doesn't depend on any module.)
*
* @var string
*
* @see https://www.drupal.org/developing/api/8/serialization
*/
protected static $format = 'json';

View File

@ -28,12 +28,12 @@ class SearchPlugin extends Plugin {
/**
* The title for the search page tab.
*
* @var \Drupal\Core\Annotation\Translation
*
* @todo This will potentially be translated twice or cached with the wrong
* translation until the search tabs are converted to local task plugins.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*/
public $title;

View File

@ -23,18 +23,18 @@ class FakeRecord {
/**
* The property used in tests.
*
* @see \Drupal\KernelTests\Core\Database\FetchTest
*
* @var string
*
* @see \Drupal\KernelTests\Core\Database\FetchTest
*/
public string $name;
/**
* The property used in tests.
*
* @see \Drupal\KernelTests\Core\Database\DatabaseTestBase
*
* @var string
*
* @see \Drupal\KernelTests\Core\Database\DatabaseTestBase
*/
public string $job;

View File

@ -95,8 +95,6 @@ class ViewsDisplay extends ViewsPluginAnnotationBase {
* displays of a view. If this is not set or regions have been specified,
* views will display an option to 'hide contextual links'. Use an empty
* array to disable.
*
* @var array
*/
public $contextual_links_locations;

View File

@ -24,9 +24,9 @@ class ManyToOneHelper {
/**
* Should the field use formula or alias.
*
* @see \Drupal\views\Plugin\views\argument\StringArgument::query()
*
* @var bool
*
* @see \Drupal\views\Plugin\views\argument\StringArgument::query()
*/
public bool $formula = FALSE;

View File

@ -79,9 +79,9 @@ abstract class PluginBase extends ComponentPluginBase implements ContainerFactor
*
* For display plugins this is empty.
*
* @todo find a better description
*
* @var \Drupal\views\Plugin\views\display\DisplayPluginBase
*
* @todo find a better description
*/
public $displayHandler;

View File

@ -117,11 +117,11 @@ abstract class DisplayPluginBase extends PluginBase implements DisplayPluginInte
/**
* The display information coming directly from the view entity.
*
* @var array
*
* @see \Drupal\views\Entity\View::getDisplay()
*
* @todo \Drupal\views\Entity\View::duplicateDisplayAsType directly access it.
*
* @var array
*/
public $display;

View File

@ -203,9 +203,9 @@ class JoinPluginBase extends PluginBase implements JoinPluginInterface {
* - value: Must be set. If an array, operator will be defaulted to IN.
* - numeric: If true, the value will not be surrounded in quotes.
*
* @see SelectQueryInterface::addJoin()
*
* @var array
*
* @see SelectQueryInterface::addJoin()
*/
public $extra;

View File

@ -40,18 +40,18 @@ class ViewExecutable {
/**
* Whether or not the view has been built.
*
* @todo Group with other static properties.
*
* @var bool
*
* @todo Group with other static properties.
*/
public $built = FALSE;
/**
* Whether the view has been executed/query has been run.
*
* @todo Group with other static properties.
*
* @var bool
*
* @todo Group with other static properties.
*/
public $executed = FALSE;
@ -372,9 +372,9 @@ class ViewExecutable {
/**
* Does this view already have loaded its handlers.
*
* @todo Group with other static properties.
*
* @var bool
*
* @todo Group with other static properties.
*/
public $inited;

View File

@ -53,6 +53,8 @@ class WorkflowType extends Plugin {
* - 'state' (\Drupal\workflows\StateInterface::PLUGIN_FORM_KEY)
* - 'transition' (\Drupal\workflows\TransitionInterface::PLUGIN_FORM_KEY)
*
* @var array
*
* @see \Drupal\Core\Plugin\PluginWithFormsInterface
* @see \Drupal\Core\Plugin\PluginFormInterface
* @see \Drupal\workflows\Plugin\WorkflowTypeConfigureFormBase
@ -61,8 +63,6 @@ class WorkflowType extends Plugin {
* @see \Drupal\workflows\WorkflowTypeInterface::PLUGIN_FORM_KEY
* @see \Drupal\workflows\StateInterface::PLUGIN_FORM_KEY
* @see \Drupal\workflows\TransitionInterface::PLUGIN_FORM_KEY
*
* @var array
*/
public $forms = [];

View File

@ -82,9 +82,9 @@ class Workflow extends ConfigEntityBase implements WorkflowInterface, EntityWith
/**
* The workflow type plugin ID.
*
* @see \Drupal\workflows\WorkflowTypeManager
*
* @var string
*
* @see \Drupal\workflows\WorkflowTypeManager
*/
protected $type;

View File

@ -89,7 +89,6 @@
<!-- Sniff for: DuplicateVar, EmptyVar, IncorrectVarType, InlineVariableName, WrongStyle -->
<exclude name="Drupal.Commenting.VariableComment.Missing"/>
<exclude name="Drupal.Commenting.VariableComment.MissingVar"/>
<exclude name="Drupal.Commenting.VariableComment.VarOrder"/>
</rule>
<rule ref="Drupal.ControlStructures.ControlSignature"/>
<rule ref="Drupal.ControlStructures.ElseIf"/>

View File

@ -55,9 +55,9 @@ abstract class InstallerTestBase extends BrowserTestBase {
/**
* Additional parameters to use for installer screens.
*
* @see FunctionalTestSetupTrait::installParameters()
*
* @var array
*
* @see FunctionalTestSetupTrait::installParameters()
*/
protected $parameters = [];

View File

@ -23,6 +23,7 @@ abstract class ConfigFormTestBase extends KernelTestBase {
/**
* Values to use for testing.
*
* @var array
* Contains details for form key, configuration object name, and config key.
* Example:
* @code
@ -34,8 +35,6 @@ abstract class ConfigFormTestBase extends KernelTestBase {
* ],
* ];
* @endcode
*
* @var array
*/
protected $values;

View File

@ -22,9 +22,9 @@ class ConfigCRUDTest extends KernelTestBase {
/**
* Exempt from strict schema checking.
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*
* @var bool
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*/
protected $strictConfigSchema = FALSE;

View File

@ -16,9 +16,9 @@ class ConfigEntityUnitTest extends KernelTestBase {
/**
* Exempt from strict schema checking.
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*
* @var bool
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*/
protected $strictConfigSchema = FALSE;

View File

@ -48,9 +48,9 @@ abstract class ConfigEntityValidationTestBase extends KernelTestBase {
* strong UI presence. For example: REST resource configuration entities and
* entity view displays.
*
* @see \Drupal\Core\Entity\EntityInterface::label()
*
* @var bool
*
* @see \Drupal\Core\Entity\EntityInterface::label()
*/
protected bool $hasLabel = TRUE;

View File

@ -18,9 +18,9 @@ class ConfigFileContentTest extends KernelTestBase {
/**
* Exempt from strict schema checking.
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*
* @var bool
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*/
protected $strictConfigSchema = FALSE;

View File

@ -20,9 +20,9 @@ class FieldMissingTypeTest extends EntityKernelTestBase {
/**
* Set to FALSE because we are hacking a field storage to use a fake type.
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*
* @var bool
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*/
protected $strictConfigSchema = FALSE;

View File

@ -160,10 +160,10 @@ abstract class KernelTestBase extends TestCase implements ServiceProviderInterfa
* it extends, and so on up the class hierarchy. It is not necessary to
* include modules in your list that a parent class has already declared.
*
* @var array
*
* @see \Drupal\Tests\KernelTestBase::enableModules()
* @see \Drupal\Tests\KernelTestBase::bootKernel()
*
* @var array
*/
protected static $modules = [];
@ -175,8 +175,9 @@ abstract class KernelTestBase extends TestCase implements ServiceProviderInterfa
protected $vfsRoot;
/**
* @todo Move into Config test base class.
* @var \Drupal\Core\Config\ConfigImporter
*
* @todo Move into Config test base class.
*/
protected $configImporter;
@ -197,9 +198,9 @@ abstract class KernelTestBase extends TestCase implements ServiceProviderInterfa
/**
* Set to TRUE to strict check all configuration saved.
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*
* @var bool
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*/
protected $strictConfigSchema = TRUE;
@ -222,9 +223,9 @@ abstract class KernelTestBase extends TestCase implements ServiceProviderInterfa
/**
* Set to TRUE to make user 1 a super user.
*
* @see \Drupal\Core\Session\SuperUserAccessPolicy
*
* @var bool
*
* @see \Drupal\Core\Session\SuperUserAccessPolicy
*/
protected bool $usesSuperUserAccessPolicy;

View File

@ -19,9 +19,9 @@ class RandomTest extends TestCase {
/**
* The first random string passed to the test callback.
*
* @see \Drupal\Tests\Component\Utility\RandomTest::_RandomStringValidate()
*
* @var string
*
* @see \Drupal\Tests\Component\Utility\RandomTest::_RandomStringValidate()
*/
protected $firstStringGenerated = '';