From dc433f5a82c51a176fb8dab8d20f41dab62a2603 Mon Sep 17 00:00:00 2001 From: Yuri Kuznetsov Date: Wed, 10 Aug 2022 17:05:49 +0300 Subject: [PATCH] fix phpdoc --- .../Espo/Classes/Acl/Email/AccessChecker.php | 2 +- .../Espo/Classes/Acl/Team/OwnershipChecker.php | 2 +- application/Espo/Classes/AppInfo/Container.php | 2 +- .../FieldProcessing/Email/StringDataLoader.php | 2 +- .../Espo/Classes/FieldValidators/ArrayType.php | 14 +++++++------- .../Espo/Classes/FieldValidators/EmailType.php | 4 ++-- .../Espo/Classes/FieldValidators/EnumType.php | 4 ++-- .../Classes/FieldValidators/LinkMultipleType.php | 12 ++++++------ .../Classes/FieldValidators/LinkParentType.php | 6 +++--- .../Espo/Classes/FieldValidators/PhoneType.php | 6 +++--- .../Espo/Classes/FieldValidators/UrlType.php | 2 +- application/Espo/Core/ORM/EntityManagerProxy.php | 2 +- 12 files changed, 29 insertions(+), 29 deletions(-) diff --git a/application/Espo/Classes/Acl/Email/AccessChecker.php b/application/Espo/Classes/Acl/Email/AccessChecker.php index 3323f84389..87a6955eb2 100644 --- a/application/Espo/Classes/Acl/Email/AccessChecker.php +++ b/application/Espo/Classes/Acl/Email/AccessChecker.php @@ -104,7 +104,7 @@ class AccessChecker implements AccessEntityCREDSChecker return true; } - /** @var string[] */ + /** @var string[] $assignedUserIdList */ $assignedUserIdList = $entity->getLinkMultipleIdList('assignedUsers'); if ( diff --git a/application/Espo/Classes/Acl/Team/OwnershipChecker.php b/application/Espo/Classes/Acl/Team/OwnershipChecker.php index 2b7ba43248..2c4fc5daaa 100644 --- a/application/Espo/Classes/Acl/Team/OwnershipChecker.php +++ b/application/Espo/Classes/Acl/Team/OwnershipChecker.php @@ -44,7 +44,7 @@ class OwnershipChecker implements OwnershipOwnChecker { public function checkOwn(User $user, Entity $entity): bool { - /** @var string[] */ + /** @var string[] $userTeamIdList */ $userTeamIdList = $user->getLinkMultipleIdList('teams'); return in_array($entity->getId(), $userTeamIdList); diff --git a/application/Espo/Classes/AppInfo/Container.php b/application/Espo/Classes/AppInfo/Container.php index 0db381016b..9329528111 100644 --- a/application/Espo/Classes/AppInfo/Container.php +++ b/application/Espo/Classes/AppInfo/Container.php @@ -63,7 +63,7 @@ class Container 'user', ]; - /** @var string[] */ + /** @var string[] $fileList */ $fileList = scandir('application/Espo/Core/Loaders'); if (file_exists('custom/Espo/Custom/Core/Loaders')) { diff --git a/application/Espo/Classes/FieldProcessing/Email/StringDataLoader.php b/application/Espo/Classes/FieldProcessing/Email/StringDataLoader.php index b736ac5bfa..6f42460de8 100644 --- a/application/Espo/Classes/FieldProcessing/Email/StringDataLoader.php +++ b/application/Espo/Classes/FieldProcessing/Email/StringDataLoader.php @@ -104,7 +104,7 @@ class StringDataLoader implements Loader return; } - /** @var ?string */ + /** @var ?string $fromEmailAddressId */ $fromEmailAddressId = $entity->get('fromEmailAddressId'); if (!$fromEmailAddressId) { diff --git a/application/Espo/Classes/FieldValidators/ArrayType.php b/application/Espo/Classes/FieldValidators/ArrayType.php index aea22102fd..9a25747a73 100644 --- a/application/Espo/Classes/FieldValidators/ArrayType.php +++ b/application/Espo/Classes/FieldValidators/ArrayType.php @@ -72,7 +72,7 @@ class ArrayType public function checkArrayOfString(Entity $entity, string $field): bool { - /** @var ?mixed[] */ + /** @var ?mixed[] $list */ $list = $entity->get($field); if ($list === null) { @@ -94,7 +94,7 @@ class ArrayType return true; } - /** @var ?string[] */ + /** @var ?string[] $value */ $value = $entity->get($field); if ($value === null || $value === []) { @@ -133,10 +133,10 @@ class ArrayType ->getEntity($entityType) ->getField($field); - /** @var ?string */ + /** @var ?string $path */ $path = $fieldDefs->getParam('optionsPath'); - /** @var string[]|null|false */ + /** @var string[]|null|false $optionList */ $optionList = $path ? $this->metadata->get($path) : $fieldDefs->getParam('options'); @@ -185,7 +185,7 @@ class ArrayType { $maxLength = $validationValue ?? self::DEFAULT_MAX_LENGTH; - /** @var string[] */ + /** @var string[] $value */ $value = $entity->get($field) ?? []; foreach ($value as $item) { @@ -214,7 +214,7 @@ class ArrayType $preparedPattern = '/^' . $pattern . '$/'; - /** @var string[] */ + /** @var string[] $value */ $value = $entity->get($field) ?? []; foreach ($value as $item) { @@ -236,7 +236,7 @@ class ArrayType return true; } - /** @var string[] */ + /** @var string[] $value */ $value = $entity->get($field) ?? []; $optionList = $this->getOptionList($entity->getEntityType(), $field) ?? []; diff --git a/application/Espo/Classes/FieldValidators/EmailType.php b/application/Espo/Classes/FieldValidators/EmailType.php index fa20c4bf01..bb1a661094 100644 --- a/application/Espo/Classes/FieldValidators/EmailType.php +++ b/application/Espo/Classes/FieldValidators/EmailType.php @@ -102,10 +102,10 @@ class EmailType public function checkMaxLength(Entity $entity, string $field): bool { - /** @var ?string */ + /** @var ?string $value */ $value = $entity->get($field); - /** @var int */ + /** @var int $maxLength */ $maxLength = $this->metadata->get(['entityDefs', 'EmailAddress', 'fields', 'name', 'maxLength']) ?? self::DEFAULT_MAX_LENGTH; diff --git a/application/Espo/Classes/FieldValidators/EnumType.php b/application/Espo/Classes/FieldValidators/EnumType.php index 7a90fab053..af7ad11661 100644 --- a/application/Espo/Classes/FieldValidators/EnumType.php +++ b/application/Espo/Classes/FieldValidators/EnumType.php @@ -63,10 +63,10 @@ class EnumType ->getEntity($entity->getEntityType()) ->getField($field); - /** @var ?string */ + /** @var ?string $path */ $path = $fieldDefs->getParam('optionsPath'); - /** @var string[]|null|false */ + /** @var string[]|null|false $optionList */ $optionList = $path ? $this->metadata->get($path) : $fieldDefs->getParam('options'); diff --git a/application/Espo/Classes/FieldValidators/LinkMultipleType.php b/application/Espo/Classes/FieldValidators/LinkMultipleType.php index 0ea0013268..77df8006f1 100644 --- a/application/Espo/Classes/FieldValidators/LinkMultipleType.php +++ b/application/Espo/Classes/FieldValidators/LinkMultipleType.php @@ -57,7 +57,7 @@ class LinkMultipleType return false; } - /** @var string[] */ + /** @var string[] $idList */ $idList = $entity->getLinkMultipleIdList($field); return count($idList) > 0; @@ -65,7 +65,7 @@ class LinkMultipleType public function checkPattern(Entity $entity, string $field): bool { - /** @var ?mixed[] */ + /** @var ?mixed[] $idList */ $idList = $entity->get($field . 'Ids'); if ($idList === null || $idList === []) { @@ -103,14 +103,14 @@ class LinkMultipleType return true; } - /** @var ?stdClass */ + /** @var ?stdClass $columnsData */ $columnsData = $entity->get($field . 'Columns'); if ($columnsData === null) { return true; } - /** @var ?array */ + /** @var ?array $columnsMap */ $columnsMap = $this->defs ->getEntity($entity->getEntityType()) ->getField($field) @@ -229,10 +229,10 @@ class LinkMultipleType return false; } - /** @var ?string */ + /** @var ?string $path */ $path = $fieldDefs->getParam('optionsPath'); - /** @var string[]|null|false */ + /** @var string[]|null|false $optionList */ $optionList = $path ? $this->metadata->get($path) : $fieldDefs->getParam('options'); diff --git a/application/Espo/Classes/FieldValidators/LinkParentType.php b/application/Espo/Classes/FieldValidators/LinkParentType.php index 502b65d15f..eeedad5902 100644 --- a/application/Espo/Classes/FieldValidators/LinkParentType.php +++ b/application/Espo/Classes/FieldValidators/LinkParentType.php @@ -66,7 +66,7 @@ class LinkParentType public function checkPattern(Entity $entity, string $field): bool { - /** @var ?string */ + /** @var ?string $idValue */ $idValue = $entity->get($field . 'Id'); if ($idValue === null) { @@ -86,14 +86,14 @@ class LinkParentType public function checkValid(Entity $entity, string $field): bool { - /** @var ?string */ + /** @var ?string $typeValue */ $typeValue = $entity->get($field . 'Type'); if ($typeValue === null) { return true; } - /** @var ?string[] */ + /** @var ?string[] $entityTypeList */ $entityTypeList = $this->defs ->getEntity($entity->getEntityType()) ->getField($field) diff --git a/application/Espo/Classes/FieldValidators/PhoneType.php b/application/Espo/Classes/FieldValidators/PhoneType.php index 4a4db522e7..7982932ecc 100644 --- a/application/Espo/Classes/FieldValidators/PhoneType.php +++ b/application/Espo/Classes/FieldValidators/PhoneType.php @@ -112,10 +112,10 @@ class PhoneType public function checkMaxLength(Entity $entity, string $field): bool { - /** @var ?string */ + /** @var ?string $value */ $value = $entity->get($field); - /** @var int */ + /** @var int $maxLength */ $maxLength = $this->metadata->get(['entityDefs', 'PhoneNumber', 'fields', 'name', 'maxLength']) ?? self::DEFAULT_MAX_LENGTH; @@ -154,7 +154,7 @@ class PhoneType return false; } - /** @var string[]|null|false */ + /** @var string[]|null|false $typeList */ $typeList = $this->defs ->getEntity($entityType) ->getField($field) diff --git a/application/Espo/Classes/FieldValidators/UrlType.php b/application/Espo/Classes/FieldValidators/UrlType.php index 240f43b92f..2a7f8b5ef0 100644 --- a/application/Espo/Classes/FieldValidators/UrlType.php +++ b/application/Espo/Classes/FieldValidators/UrlType.php @@ -62,7 +62,7 @@ class UrlType return true; } - /** @var string */ + /** @var string $pattern */ $pattern = $this->metadata->get(['app', 'regExpPatterns', 'uriOptionalProtocol', 'pattern']); $preparedPattern = '/^' . $pattern . '$/'; diff --git a/application/Espo/Core/ORM/EntityManagerProxy.php b/application/Espo/Core/ORM/EntityManagerProxy.php index 4920b5888f..2c10a429bd 100644 --- a/application/Espo/Core/ORM/EntityManagerProxy.php +++ b/application/Espo/Core/ORM/EntityManagerProxy.php @@ -53,7 +53,7 @@ class EntityManagerProxy private function getEntityManager(): EntityManager { if (!$this->entityManager) { - /** @var EntityManager */ + /** @var EntityManager $entityManager */ $entityManager = $this->container->get('entityManager'); $this->entityManager = $entityManager;