Merge pull request #2760 from tarlepp/feat/const-types

tarlepp · web-flow · commit 19e1cacef20e · 2024-05-05T12:32:20.000+03:00
Chore(types) - Added missing types to const definitions
diff --git a/src/Command/ApiKey/ChangeTokenCommand.php b/src/Command/ApiKey/ChangeTokenCommand.php
@@ -29,7 +29,7 @@ class ChangeTokenCommand extends Command
 {
     use SymfonyStyleTrait;
 
-    final public const NAME = 'api-key:change-token';
+    final public const string NAME = 'api-key:change-token';
 
     public function __construct(
         private readonly ApiKeyResource $apiKeyResource,
diff --git a/src/Command/ApiKey/CreateApiKeyCommand.php b/src/Command/ApiKey/CreateApiKeyCommand.php
@@ -38,7 +38,7 @@ class CreateApiKeyCommand extends Command
     use ApiKeyUserManagementHelperTrait;
     use SymfonyStyleTrait;
 
-    final public const NAME = 'api-key:create';
+    final public const string NAME = 'api-key:create';
 
     /**
      * @var array<int, array<string, string>>
diff --git a/src/Command/ApiKey/EditApiKeyCommand.php b/src/Command/ApiKey/EditApiKeyCommand.php
@@ -32,7 +32,7 @@ class EditApiKeyCommand extends Command
 {
     use SymfonyStyleTrait;
 
-    final public const NAME = 'api-key:edit';
+    final public const string NAME = 'api-key:edit';
 
     public function __construct(
         private readonly ApiKeyResource $apiKeyResource,
diff --git a/src/Command/ApiKey/ListApiKeysCommand.php b/src/Command/ApiKey/ListApiKeysCommand.php
@@ -33,7 +33,7 @@
 )]
 class ListApiKeysCommand extends Command
 {
-    final public const NAME = 'api-key:list';
+    final public const string NAME = 'api-key:list';
 
     public function __construct(
         private readonly ApiKeyResource $apiKeyResource,
diff --git a/src/Command/ApiKey/RemoveApiKeyCommand.php b/src/Command/ApiKey/RemoveApiKeyCommand.php
@@ -29,7 +29,7 @@ class RemoveApiKeyCommand extends Command
 {
     use SymfonyStyleTrait;
 
-    final public const NAME = 'api-key:remove';
+    final public const string NAME = 'api-key:remove';
 
     public function __construct(
         private readonly ApiKeyResource $apiKeyResource,
diff --git a/src/Command/User/CreateRolesCommand.php b/src/Command/User/CreateRolesCommand.php
@@ -34,7 +34,7 @@ class CreateRolesCommand extends Command
 {
     use SymfonyStyleTrait;
 
-    final public const NAME = 'user:create-roles';
+    final public const string NAME = 'user:create-roles';
 
     public function __construct(
         private readonly EntityManagerInterface $entityManager,
diff --git a/src/Command/User/CreateUserCommand.php b/src/Command/User/CreateUserCommand.php
@@ -38,10 +38,10 @@ class CreateUserCommand extends Command
     use ApiKeyUserManagementHelperTrait;
     use SymfonyStyleTrait;
 
-    final public const NAME = 'user:create';
+    final public const string NAME = 'user:create';
 
-    private const PARAMETER_NAME = 'name';
-    private const PARAMETER_DESCRIPTION = 'description';
+    private const string PARAMETER_NAME = 'name';
+    private const string PARAMETER_DESCRIPTION = 'description';
 
     /**
      * @var array<int, array<string, string>>
diff --git a/src/Command/User/CreateUserGroupCommand.php b/src/Command/User/CreateUserGroupCommand.php
@@ -37,7 +37,7 @@ class CreateUserGroupCommand extends Command
     use GetApplicationTrait;
     use SymfonyStyleTrait;
 
-    final public const NAME = 'user:create-group';
+    final public const string NAME = 'user:create-group';
 
     /**
      * @var array<int, array<string, string>>
diff --git a/src/Command/User/EditUserCommand.php b/src/Command/User/EditUserCommand.php
@@ -32,7 +32,7 @@ class EditUserCommand extends Command
 {
     use SymfonyStyleTrait;
 
-    final public const NAME = 'user:edit';
+    final public const string NAME = 'user:edit';
 
     public function __construct(
         private readonly UserResource $userResource,
diff --git a/src/Command/User/EditUserGroupCommand.php b/src/Command/User/EditUserGroupCommand.php
@@ -32,7 +32,7 @@ class EditUserGroupCommand extends Command
 {
     use SymfonyStyleTrait;
 
-    final public const NAME = 'user:edit-group';
+    final public const string NAME = 'user:edit-group';
 
     public function __construct(
         private readonly UserGroupResource $userGroupResource,
diff --git a/src/Command/User/ListUserGroupsCommand.php b/src/Command/User/ListUserGroupsCommand.php
@@ -34,7 +34,7 @@ class ListUserGroupsCommand extends Command
 {
     use SymfonyStyleTrait;
 
-    final public const NAME = 'user:list-groups';
+    final public const string NAME = 'user:list-groups';
 
     public function __construct(
         private readonly UserGroupResource $userGroupResource,
diff --git a/src/Command/User/ListUsersCommand.php b/src/Command/User/ListUsersCommand.php
@@ -35,7 +35,7 @@ class ListUsersCommand extends Command
 {
     use SymfonyStyleTrait;
 
-    final public const NAME = 'user:list';
+    final public const string NAME = 'user:list';
 
     public function __construct(
         private readonly UserResource $userResource,
diff --git a/src/Command/User/RemoveUserCommand.php b/src/Command/User/RemoveUserCommand.php
@@ -29,7 +29,7 @@ class RemoveUserCommand extends Command
 {
     use SymfonyStyleTrait;
 
-    final public const NAME = 'user:remove';
+    final public const string NAME = 'user:remove';
 
     public function __construct(
         private readonly UserResource $userResource,
diff --git a/src/Command/User/RemoveUserGroupCommand.php b/src/Command/User/RemoveUserGroupCommand.php
@@ -29,7 +29,7 @@ class RemoveUserGroupCommand extends Command
 {
     use SymfonyStyleTrait;
 
-    final public const NAME = 'user:remove-group';
+    final public const string NAME = 'user:remove-group';
 
     public function __construct(
         private readonly UserGroupResource $userGroupResource,
diff --git a/src/Command/Utils/CreateDateDimensionEntitiesCommand.php b/src/Command/Utils/CreateDateDimensionEntitiesCommand.php
@@ -35,8 +35,8 @@
 )]
 class CreateDateDimensionEntitiesCommand extends Command
 {
-    private const YEAR_MIN = 1970;
-    private const YEAR_MAX = 2047; // This should be the year when I'm officially retired
+    private const int YEAR_MIN = 1970;
+    private const int YEAR_MAX = 2047; // This should be the year when I'm officially retired
 
     public function __construct(
         private readonly DateDimensionRepository $dateDimensionRepository,
diff --git a/src/Compiler/StopwatchCompilerPass.php b/src/Compiler/StopwatchCompilerPass.php
@@ -21,7 +21,7 @@
  */
 class StopwatchCompilerPass implements CompilerPassInterface
 {
-    private const SERVICE_TAGS = [
+    private const array SERVICE_TAGS = [
         'security.voter',
         'kernel.event_subscriber',
         'validator.constraint_validator',
diff --git a/src/Doctrine/DBAL/Types/Types.php b/src/Doctrine/DBAL/Types/Types.php
@@ -14,7 +14,7 @@
  */
 class Types
 {
-    final public const ENUM_LANGUAGE = 'EnumLanguage';
-    final public const ENUM_LOCALE = 'EnumLocale';
-    final public const ENUM_LOG_LOGIN = 'EnumLogLogin';
+    final public const string ENUM_LANGUAGE = 'EnumLanguage';
+    final public const string ENUM_LOCALE = 'EnumLocale';
+    final public const string ENUM_LOG_LOGIN = 'EnumLogLogin';
 }
diff --git a/src/Entity/User.php b/src/Entity/User.php
@@ -59,8 +59,8 @@ class User implements EntityInterface, UserInterface, UserGroupAwareInterface
     use UserRelations;
     use Uuid;
 
-    final public const SET_USER_PROFILE = 'set.UserProfile';
-    final public const SET_USER_BASIC = 'set.UserBasic';
+    final public const string SET_USER_PROFILE = 'set.UserProfile';
+    final public const string SET_USER_BASIC = 'set.UserBasic';
 
     #[ORM\Id]
     #[ORM\Column(
diff --git a/src/Entity/UserGroup.php b/src/Entity/UserGroup.php
@@ -37,8 +37,8 @@ class UserGroup implements EntityInterface, Stringable
     use Timestampable;
     use Uuid;
 
-    final public const SET_USER_PROFILE_GROUPS = 'set.UserProfileGroups';
-    final public const SET_USER_GROUP_BASIC = 'set.UserGroupBasic';
+    final public const string SET_USER_PROFILE_GROUPS = 'set.UserProfileGroups';
+    final public const string SET_USER_GROUP_BASIC = 'set.UserGroupBasic';
 
     #[ORM\Id]
     #[ORM\Column(
diff --git a/src/Form/Type/FormTypeLabelInterface.php b/src/Form/Type/FormTypeLabelInterface.php
@@ -17,16 +17,16 @@
 interface FormTypeLabelInterface
 {
     // @codeCoverageIgnoreStart
-    public const LABEL = 'label';
-    public const REQUIRED = 'required';
-    public const EMPTY_DATA = 'empty_data';
-    public const TYPE = 'type';
-    public const FIRST_NAME = 'first_name';
-    public const FIRST_OPTIONS = 'first_options';
-    public const SECOND_NAME = 'second_name';
-    public const SECOND_OPTIONS = 'second_options';
-    public const CHOICES = 'choices';
-    public const CHOICE_LABEL = 'choice_label';
-    public const CLASS_NAME = 'class';
+    public const string LABEL = 'label';
+    public const string REQUIRED = 'required';
+    public const string EMPTY_DATA = 'empty_data';
+    public const string TYPE = 'type';
+    public const string FIRST_NAME = 'first_name';
+    public const string FIRST_OPTIONS = 'first_options';
+    public const string SECOND_NAME = 'second_name';
+    public const string SECOND_OPTIONS = 'second_options';
+    public const string CHOICES = 'choices';
+    public const string CHOICE_LABEL = 'choice_label';
+    public const string CLASS_NAME = 'class';
     // @codeCoverageIgnoreEnd
 }
diff --git a/src/Repository/BaseRepository.php b/src/Repository/BaseRepository.php
@@ -35,8 +35,8 @@ abstract class BaseRepository implements BaseRepositoryInterface
     use RepositoryMethodsTrait;
     use RepositoryWrappersTrait;
 
-    private const INNER_JOIN = 'innerJoin';
-    private const LEFT_JOIN = 'leftJoin';
+    private const string INNER_JOIN = 'innerJoin';
+    private const string LEFT_JOIN = 'leftJoin';
 
     /**
      * @psalm-var class-string
diff --git a/src/Rest/Controller.php b/src/Rest/Controller.php
@@ -27,23 +27,23 @@ abstract class Controller implements ControllerInterface
     use RestActionBase;
     use RestMethodHelper;
 
-    public const ACTION_COUNT = 'countAction';
-    public const ACTION_CREATE = 'createAction';
-    public const ACTION_DELETE = 'deleteAction';
-    public const ACTION_FIND = 'findAction';
-    public const ACTION_FIND_ONE = 'findOneAction';
-    public const ACTION_IDS = 'idsAction';
-    public const ACTION_PATCH = 'patchAction';
-    public const ACTION_UPDATE = 'updateAction';
+    public const string ACTION_COUNT = 'countAction';
+    public const string ACTION_CREATE = 'createAction';
+    public const string ACTION_DELETE = 'deleteAction';
+    public const string ACTION_FIND = 'findAction';
+    public const string ACTION_FIND_ONE = 'findOneAction';
+    public const string ACTION_IDS = 'idsAction';
+    public const string ACTION_PATCH = 'patchAction';
+    public const string ACTION_UPDATE = 'updateAction';
 
-    public const METHOD_COUNT = 'countMethod';
-    public const METHOD_CREATE = 'createMethod';
-    public const METHOD_DELETE = 'deleteMethod';
-    public const METHOD_FIND = 'findMethod';
-    public const METHOD_FIND_ONE = 'findOneMethod';
-    public const METHOD_IDS = 'idsMethod';
-    public const METHOD_PATCH = 'patchMethod';
-    public const METHOD_UPDATE = 'updateMethod';
+    public const string METHOD_COUNT = 'countMethod';
+    public const string METHOD_CREATE = 'createMethod';
+    public const string METHOD_DELETE = 'deleteMethod';
+    public const string METHOD_FIND = 'findMethod';
+    public const string METHOD_FIND_ONE = 'findOneMethod';
+    public const string METHOD_IDS = 'idsMethod';
+    public const string METHOD_PATCH = 'patchMethod';
+    public const string METHOD_UPDATE = 'updateMethod';
 
     protected ?ResponseHandlerInterface $responseHandler = null;
 
diff --git a/src/Rest/Interfaces/ResponseHandlerInterface.php b/src/Rest/Interfaces/ResponseHandlerInterface.php
@@ -26,8 +26,8 @@ interface ResponseHandlerInterface
      * Constants for response output formats.
      */
     // @codeCoverageIgnoreStart
-    public const FORMAT_JSON = 'json';
-    public const FORMAT_XML = 'xml';
+    public const string FORMAT_JSON = 'json';
+    public const string FORMAT_XML = 'xml';
     // @codeCoverageIgnoreEnd
 
     public function __construct(SerializerInterface $serializer);
diff --git a/src/Rest/Interfaces/SearchTermInterface.php b/src/Rest/Interfaces/SearchTermInterface.php
@@ -18,13 +18,13 @@ interface SearchTermInterface
 {
     // @codeCoverageIgnoreStart
     // Used OPERAND constants
-    public const OPERAND_OR = 'or';
-    public const OPERAND_AND = 'and';
+    public const string OPERAND_OR = 'or';
+    public const string OPERAND_AND = 'and';
 
     // Used MODE constants
-    public const MODE_STARTS_WITH = 1;
-    public const MODE_ENDS_WITH = 2;
-    public const MODE_FULL = 3;
+    public const int MODE_STARTS_WITH = 1;
+    public const int MODE_ENDS_WITH = 2;
+    public const int MODE_FULL = 3;
     // @codeCoverageIgnoreEnd
 
     /**
diff --git a/src/Security/Voter/IsUserHimselfVoter.php b/src/Security/Voter/IsUserHimselfVoter.php
@@ -24,7 +24,7 @@
  */
 class IsUserHimselfVoter extends Voter
 {
-    private const ATTRIBUTE = 'IS_USER_HIMSELF';
+    private const string ATTRIBUTE = 'IS_USER_HIMSELF';
 
     /**
      * {@inheritdoc}
diff --git a/src/Service/Localization.php b/src/Service/Localization.php
@@ -27,7 +27,7 @@
  */
 class Localization
 {
-    final public const DEFAULT_TIMEZONE = 'Europe/Helsinki';
+    final public const string DEFAULT_TIMEZONE = 'Europe/Helsinki';
 
     public function __construct(
         private readonly CacheInterface $appCacheApcu,
diff --git a/src/Validator/Constraints/EntityReferenceExists.php b/src/Validator/Constraints/EntityReferenceExists.php
@@ -26,16 +26,16 @@
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
 class EntityReferenceExists extends Constraint
 {
-    final public const ENTITY_REFERENCE_EXISTS_ERROR = '64888b5e-bded-449b-82ed-0cc1f73df14d';
-    final public const MESSAGE_SINGLE = 'Invalid id value "{{ id }}" given for entity "{{ entity }}".';
-    final public const MESSAGE_MULTIPLE = 'Invalid id values "{{ id }}" given for entity "{{ entity }}".';
+    final public const string ENTITY_REFERENCE_EXISTS_ERROR = '64888b5e-bded-449b-82ed-0cc1f73df14d';
+    final public const string MESSAGE_SINGLE = 'Invalid id value "{{ id }}" given for entity "{{ entity }}".';
+    final public const string MESSAGE_MULTIPLE = 'Invalid id values "{{ id }}" given for entity "{{ entity }}".';
 
     /**
      * {@inheritdoc}
      *
      * @psalm-var array<string, string>
      */
-    protected const ERROR_NAMES = [
+    protected const array ERROR_NAMES = [
         self::ENTITY_REFERENCE_EXISTS_ERROR => 'ENTITY_REFERENCE_EXISTS_ERROR',
     ];
 
diff --git a/src/Validator/Constraints/Language.php b/src/Validator/Constraints/Language.php
@@ -26,15 +26,15 @@
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
 class Language extends Constraint
 {
-    final public const INVALID_LANGUAGE = '08bd61cf-ba27-45a3-9916-78c39253833a';
-    final public const MESSAGE = 'This language "{{ language }}" is not valid.';
+    final public const string INVALID_LANGUAGE = '08bd61cf-ba27-45a3-9916-78c39253833a';
+    final public const string MESSAGE = 'This language "{{ language }}" is not valid.';
 
     /**
      * {@inheritdoc}
      *
      * @psalm-var array<string, string>
      */
-    protected const ERROR_NAMES = [
+    protected const array ERROR_NAMES = [
         self::INVALID_LANGUAGE => 'INVALID_LANGUAGE',
     ];
 }
diff --git a/src/Validator/Constraints/Locale.php b/src/Validator/Constraints/Locale.php
@@ -26,15 +26,15 @@
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
 class Locale extends Constraint
 {
-    final public const INVALID_LOCALE = '44e3862f-2d38-46d4-b1ae-632990814af6';
-    final public const MESSAGE = 'This locale "{{ locale }}" is not valid.';
+    final public const string INVALID_LOCALE = '44e3862f-2d38-46d4-b1ae-632990814af6';
+    final public const string MESSAGE = 'This locale "{{ locale }}" is not valid.';
 
     /**
      * {@inheritdoc}
      *
      * @psalm-var array<string, string>
      */
-    protected const ERROR_NAMES = [
+    protected const array ERROR_NAMES = [
         self::INVALID_LOCALE => 'INVALID_LOCALE',
     ];
 }
diff --git a/src/Validator/Constraints/Timezone.php b/src/Validator/Constraints/Timezone.php
@@ -26,15 +26,15 @@
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
 class Timezone extends Constraint
 {
-    final public const INVALID_TIMEZONE = '1f8dd2a3-5b61-43ca-a6b2-af553f86ac17';
-    final public const MESSAGE = 'This timezone "{{ timezone }}" is not valid.';
+    final public const string INVALID_TIMEZONE = '1f8dd2a3-5b61-43ca-a6b2-af553f86ac17';
+    final public const string MESSAGE = 'This timezone "{{ timezone }}" is not valid.';
 
     /**
      * {@inheritdoc}
      *
      * @psalm-var array<string, string>
      */
-    protected const ERROR_NAMES = [
+    protected const array ERROR_NAMES = [
         self::INVALID_TIMEZONE => 'INVALID_TIMEZONE',
     ];
 }
diff --git a/src/Validator/Constraints/UniqueEmail.php b/src/Validator/Constraints/UniqueEmail.php
diff --git a/src/Validator/Constraints/UniqueUsername.php b/src/Validator/Constraints/UniqueUsername.php
diff --git a/src/ValueResolver/RestDtoValueResolver.php b/src/ValueResolver/RestDtoValueResolver.php
diff --git a/tests/E2E/TestCase/RestTraitTestCase.php b/tests/E2E/TestCase/RestTraitTestCase.php
diff --git a/tests/Utils/PhpUnitUtil.php b/tests/Utils/PhpUnitUtil.php

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class ChangeTokenCommand extends Command`
`29`	`29`	`{`
`30`	`30`	`use SymfonyStyleTrait;`
`31`	`31`
`32`		`- final public const NAME = 'api-key:change-token';`
	`32`	`+ final public const string NAME = 'api-key:change-token';`
`33`	`33`
`34`	`34`	`public function __construct(`
`35`	`35`	`private readonly ApiKeyResource $apiKeyResource,`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ class EditApiKeyCommand extends Command`
`32`	`32`	`{`
`33`	`33`	`use SymfonyStyleTrait;`
`34`	`34`
`35`		`- final public const NAME = 'api-key:edit';`
	`35`	`+ final public const string NAME = 'api-key:edit';`
`36`	`36`
`37`	`37`	`public function __construct(`
`38`	`38`	`private readonly ApiKeyResource $apiKeyResource,`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`)]`
`34`	`34`	`class ListApiKeysCommand extends Command`
`35`	`35`	`{`
`36`		`- final public const NAME = 'api-key:list';`
	`36`	`+ final public const string NAME = 'api-key:list';`
`37`	`37`
`38`	`38`	`public function __construct(`
`39`	`39`	`private readonly ApiKeyResource $apiKeyResource,`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class RemoveApiKeyCommand extends Command`
`29`	`29`	`{`
`30`	`30`	`use SymfonyStyleTrait;`
`31`	`31`
`32`		`- final public const NAME = 'api-key:remove';`
	`32`	`+ final public const string NAME = 'api-key:remove';`
`33`	`33`
`34`	`34`	`public function __construct(`
`35`	`35`	`private readonly ApiKeyResource $apiKeyResource,`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ class CreateRolesCommand extends Command`
`34`	`34`	`{`
`35`	`35`	`use SymfonyStyleTrait;`
`36`	`36`
`37`		`- final public const NAME = 'user:create-roles';`
	`37`	`+ final public const string NAME = 'user:create-roles';`
`38`	`38`
`39`	`39`	`public function __construct(`
`40`	`40`	`private readonly EntityManagerInterface $entityManager,`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ class EditUserCommand extends Command`
`32`	`32`	`{`
`33`	`33`	`use SymfonyStyleTrait;`
`34`	`34`
`35`		`- final public const NAME = 'user:edit';`
	`35`	`+ final public const string NAME = 'user:edit';`
`36`	`36`
`37`	`37`	`public function __construct(`
`38`	`38`	`private readonly UserResource $userResource,`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ class EditUserGroupCommand extends Command`
`32`	`32`	`{`
`33`	`33`	`use SymfonyStyleTrait;`
`34`	`34`
`35`		`- final public const NAME = 'user:edit-group';`
	`35`	`+ final public const string NAME = 'user:edit-group';`
`36`	`36`
`37`	`37`	`public function __construct(`
`38`	`38`	`private readonly UserGroupResource $userGroupResource,`