fix phpdoc
This commit is contained in:
@@ -150,7 +150,7 @@ class MassConvertCurrency implements MassAction
|
||||
|
||||
$this->convertEntity($entity, $fieldList, $targetCurrency, $rates);
|
||||
|
||||
/** @var string */
|
||||
/** @var string $id */
|
||||
$id = $entity->getId();
|
||||
|
||||
$ids[] = $id;
|
||||
|
||||
@@ -120,7 +120,7 @@ class MassDelete implements MassAction
|
||||
'modifiedById' => $this->user->getId(),
|
||||
]);
|
||||
|
||||
/** @var string */
|
||||
/** @var string $id */
|
||||
$id = $entity->getId();
|
||||
|
||||
$ids[] = $id;
|
||||
|
||||
@@ -114,7 +114,7 @@ class MassFollow implements MassAction
|
||||
continue;
|
||||
}
|
||||
|
||||
/** @var string */
|
||||
/** @var string $id */
|
||||
$id = $entity->getId();
|
||||
|
||||
$ids[] = $id;
|
||||
|
||||
@@ -93,7 +93,7 @@ class MassRecalculateFormula implements MassAction
|
||||
'modifiedById' => 'system',
|
||||
]);
|
||||
|
||||
/** @var string */
|
||||
/** @var string $id */
|
||||
$id = $entity->getId();
|
||||
|
||||
$ids[] = $id;
|
||||
|
||||
@@ -94,7 +94,7 @@ class MassUnfollow implements MassAction
|
||||
foreach ($collection as $entity) {
|
||||
$this->streamService->unfollowEntity($entity, $userId);
|
||||
|
||||
/** @var string */
|
||||
/** @var string $id */
|
||||
$id = $entity->getId();
|
||||
|
||||
$ids[] = $id;
|
||||
|
||||
@@ -108,7 +108,7 @@ class MassActionFactory
|
||||
*/
|
||||
private function getClassName(string $action, string $entityType): ?string
|
||||
{
|
||||
/** @var ?class-string<MassAction> */
|
||||
/** @var ?class-string<MassAction> $className */
|
||||
$className = $this->getEntityTypeClassName($action, $entityType);
|
||||
|
||||
if ($className) {
|
||||
|
||||
@@ -74,7 +74,7 @@ class AssignmentNotificatorFactory
|
||||
*/
|
||||
private function getClassName(string $entityType): string
|
||||
{
|
||||
/** @var ?class-string<AssignmentNotificator> */
|
||||
/** @var ?class-string<AssignmentNotificator> $className1 */
|
||||
$className1 = $this->metadata->get(['notificationDefs', $entityType, 'assignmentNotificatorClassName']);
|
||||
|
||||
if ($className1) {
|
||||
@@ -82,7 +82,7 @@ class AssignmentNotificatorFactory
|
||||
}
|
||||
|
||||
/* For backward compatibility. */
|
||||
/** @var ?class-string<AssignmentNotificator> */
|
||||
/** @var ?class-string<AssignmentNotificator> $className2 */
|
||||
$className2 = $this->classFinder->find('Notificators', $entityType);
|
||||
|
||||
if ($className2) {
|
||||
|
||||
@@ -70,9 +70,9 @@ class DefaultAssignmentNotificator implements AssignmentNotificator
|
||||
}
|
||||
|
||||
if ($entity->hasLinkMultipleField('assignedUsers')) {
|
||||
/** @var string[] */
|
||||
/** @var string[] $userIdList */
|
||||
$userIdList = $entity->getLinkMultipleIdList('assignedUsers');
|
||||
/** @var ?string[] */
|
||||
/** @var ?string[] $fetchedAssignedUserIdList */
|
||||
$fetchedAssignedUserIdList = $entity->getFetched('assignedUsersIds');
|
||||
|
||||
if (!is_array($fetchedAssignedUserIdList)) {
|
||||
|
||||
@@ -426,7 +426,7 @@ class Entity extends BaseEntity
|
||||
public function removeLinkMultipleId(string $field, string $id): void
|
||||
{
|
||||
if ($this->hasLinkMultipleId($field, $id)) {
|
||||
/** @var string[] */
|
||||
/** @var string[] $list */
|
||||
$list = $this->getLinkMultipleIdList($field);
|
||||
|
||||
$index = array_search($id, $list);
|
||||
|
||||
@@ -83,7 +83,7 @@ class ValueFactoryFactory implements ValueFactoryFactoryInteface
|
||||
->getEntity($entityType)
|
||||
->getField($field);
|
||||
|
||||
/** @var ?class-string<ValueFactory> */
|
||||
/** @var ?class-string<ValueFactory> $className */
|
||||
$className = $fieldDefs->getParam('valueFactoryClassName');
|
||||
|
||||
if ($className) {
|
||||
|
||||
@@ -47,7 +47,7 @@ class Acl extends BaseAcl
|
||||
*/
|
||||
public function checkReadOnlyAccount(string $scope): bool
|
||||
{
|
||||
/** @var AclManager */
|
||||
/** @var AclManager $aclManager */
|
||||
$aclManager = $this->aclManager;
|
||||
|
||||
return $aclManager->checkReadOnlyAccount($this->user, $scope);
|
||||
@@ -58,7 +58,7 @@ class Acl extends BaseAcl
|
||||
*/
|
||||
public function checkReadOnlyContact(string $scope): bool
|
||||
{
|
||||
/** @var AclManager */
|
||||
/** @var AclManager $aclManager */
|
||||
$aclManager = $this->aclManager;
|
||||
|
||||
return $aclManager->checkReadOnlyContact($this->user, $scope);
|
||||
@@ -69,7 +69,7 @@ class Acl extends BaseAcl
|
||||
*/
|
||||
public function checkOwnershipAccount(Entity $entity): bool
|
||||
{
|
||||
/** @var AclManager */
|
||||
/** @var AclManager $aclManager */
|
||||
$aclManager = $this->aclManager;
|
||||
|
||||
return $aclManager->checkOwnershipAccount($this->user, $entity);
|
||||
@@ -80,7 +80,7 @@ class Acl extends BaseAcl
|
||||
*/
|
||||
public function checkOwnershipContact(Entity $entity): bool
|
||||
{
|
||||
/** @var AclManager */
|
||||
/** @var AclManager $aclManager */
|
||||
$aclManager = $this->aclManager;
|
||||
|
||||
return $aclManager->checkOwnershipContact($this->user, $entity);
|
||||
|
||||
@@ -84,7 +84,7 @@ class AccessCheckerFactory
|
||||
*/
|
||||
private function getClassName(string $scope): string
|
||||
{
|
||||
/** @var ?class-string<AccessChecker> */
|
||||
/** @var ?class-string<AccessChecker> $className1 */
|
||||
$className1 = $this->metadata->get(['aclDefs', $scope, 'portalAccessCheckerClassName']);
|
||||
|
||||
if ($className1) {
|
||||
@@ -96,7 +96,7 @@ class AccessCheckerFactory
|
||||
}
|
||||
|
||||
// For backward compatibility.
|
||||
/** @var ?class-string<AccessChecker> */
|
||||
/** @var ?class-string<AccessChecker> $className2 */
|
||||
$className2 = $this->classFinder->find('AclPortal', $scope);
|
||||
|
||||
if ($className2) {
|
||||
|
||||
@@ -103,7 +103,7 @@ class DefaultOwnershipChecker implements
|
||||
|
||||
public function checkAccount(User $user, Entity $entity): bool
|
||||
{
|
||||
/** @var string[] */
|
||||
/** @var string[] $accountIdList */
|
||||
$accountIdList = $user->getLinkMultipleIdList(self::FIELD_ACCOUNTS);
|
||||
|
||||
if (!count($accountIdList)) {
|
||||
|
||||
@@ -65,7 +65,7 @@ class RoleListProvider implements RoleListProviderInterface
|
||||
{
|
||||
$roleList = [];
|
||||
|
||||
/** @var iterable<PortalRole> */
|
||||
/** @var iterable<PortalRole> $userRoleList */
|
||||
$userRoleList = $this->entityManager
|
||||
->getRDBRepository('User')
|
||||
->getRelation($this->user, 'portalRoles')
|
||||
@@ -75,7 +75,7 @@ class RoleListProvider implements RoleListProviderInterface
|
||||
$roleList[] = $role;
|
||||
}
|
||||
|
||||
/** @var iterable<PortalRole> */
|
||||
/** @var iterable<PortalRole> $portalRoleList */
|
||||
$portalRoleList = $this->entityManager
|
||||
->getRDBRepository('Portal')
|
||||
->getRelation($this->portal, 'portalRoles')
|
||||
|
||||
@@ -123,7 +123,7 @@ class AclManager extends InternalAclManager
|
||||
$key = $user->hasId() ? $user->getId() : spl_object_hash($user);
|
||||
|
||||
if (!array_key_exists($key, $this->mapHashMap)) {
|
||||
/** @var Table */
|
||||
/** @var Table $table */
|
||||
$table = $this->getTable($user);
|
||||
|
||||
$this->mapHashMap[$key] = $this->portalMapFactory->create($user, $table, $this->getPortal());
|
||||
|
||||
@@ -108,7 +108,7 @@ class Application extends BaseApplication
|
||||
throw new Forbidden("Portal {$portalId} is not active.");
|
||||
}
|
||||
|
||||
/** @var PortalContainer */
|
||||
/** @var PortalContainer $container */
|
||||
$container = $this->container;
|
||||
|
||||
$container->setPortal($portal);
|
||||
|
||||
@@ -86,7 +86,7 @@ class Provider
|
||||
{
|
||||
$key = $type . 'HookClassNameList';
|
||||
|
||||
/** @var class-string[] */
|
||||
/** @var class-string[] $classNameList */
|
||||
$classNameList = $this->metadata->get(['recordDefs', $entityType, $key]) ?? [];
|
||||
|
||||
$interfaceName = $this->typeInterfaceMap[$type] ?? null;
|
||||
|
||||
@@ -182,7 +182,7 @@ class SearchParamsFetcher
|
||||
throw new BadRequest('maxSize must be integer.');
|
||||
}
|
||||
|
||||
/** @var ?string */
|
||||
/** @var ?string $q */
|
||||
$q = $params['q'] ?? null;
|
||||
|
||||
if (
|
||||
|
||||
@@ -1696,7 +1696,7 @@ class Service implements Crud,
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var ?TEntity */
|
||||
/** @var ?TEntity $duplicatingEntity */
|
||||
$duplicatingEntity = $this->entityManager->getEntityById($entity->getEntityType(), $duplicatingEntityId);
|
||||
|
||||
if (!$duplicatingEntity) {
|
||||
|
||||
@@ -105,7 +105,7 @@ class FilterFactory
|
||||
throw new RuntimeException("Empty access control filter name.");
|
||||
}
|
||||
|
||||
/** @var ?class-string<Filter> */
|
||||
/** @var ?class-string<Filter> $className */
|
||||
$className = $this->metadata->get(
|
||||
[
|
||||
'selectDefs',
|
||||
|
||||
@@ -98,7 +98,7 @@ class Factory
|
||||
|
||||
private function create(string $entityType, User $user, string $type): object
|
||||
{
|
||||
/** @var class-string */
|
||||
/** @var class-string $className */
|
||||
$className = $this->metadata->get(
|
||||
[
|
||||
'selectDefs',
|
||||
|
||||
@@ -81,7 +81,7 @@ class ItemConverterFactory
|
||||
*/
|
||||
private function getClassName(string $entityType, string $field): ?string
|
||||
{
|
||||
/** @var ?class-string<ItemConverter> */
|
||||
/** @var ?class-string<ItemConverter> $className1 */
|
||||
$className1 = $this->metadata->get([
|
||||
'selectDefs', $entityType, 'orderItemConverterClassNameMap', $field
|
||||
]);
|
||||
@@ -98,7 +98,7 @@ class ItemConverterFactory
|
||||
return null;
|
||||
}
|
||||
|
||||
/** @var ?class-string<ItemConverter> */
|
||||
/** @var ?class-string<ItemConverter> $className2 */
|
||||
$className2 = $this->metadata->get([
|
||||
'app', 'select', 'orderItemConverterClassNameMap', $type
|
||||
]);
|
||||
|
||||
@@ -56,11 +56,11 @@ class EnumType implements ItemConverter
|
||||
|
||||
public function convert(Item $item): OrderList
|
||||
{
|
||||
/** @var string */
|
||||
/** @var string $orderBy */
|
||||
$orderBy = $item->getOrderBy();
|
||||
$order = $item->getOrder();
|
||||
|
||||
/** @var ?string[] */
|
||||
/** @var ?string[] $list */
|
||||
$list = $this->metadata->get([
|
||||
'entityDefs', $this->entityType, 'fields', $orderBy, 'options'
|
||||
]);
|
||||
|
||||
@@ -862,7 +862,7 @@ class SelectManager
|
||||
* @param $params Parameters in front-end format.
|
||||
* @param $withAcl To apply ACL.
|
||||
* @param $checkWherePermission To check passed filters, whether a user has an access to use these filters.
|
||||
* @param forbidComplexExpressions To forbid complex expression usage.
|
||||
* @param $forbidComplexExpressions To forbid complex expression usage.
|
||||
* @return array Parameters for ORM.
|
||||
*/
|
||||
public function buildSelectParams(
|
||||
|
||||
@@ -51,7 +51,7 @@ class FilterFactory
|
||||
|
||||
public function create(string $entityType, User $user): Filter
|
||||
{
|
||||
/** @var class-string<Filter> */
|
||||
/** @var class-string<Filter> $className */
|
||||
$className = $this->metadata->get(['selectDefs', $entityType, 'textFilterClassName']) ??
|
||||
DefaultFilter::class;
|
||||
|
||||
|
||||
@@ -63,7 +63,7 @@ class SenderFactory implements Factory
|
||||
throw new RuntimeException("No `smsProvider` in config.");
|
||||
}
|
||||
|
||||
/** @var ?class-string<Sender> */
|
||||
/** @var ?class-string<Sender> $className */
|
||||
$className = $this->metadata->get(['app', 'smsProviders', $provider, 'senderClassName']);
|
||||
|
||||
if (!$className) {
|
||||
|
||||
@@ -149,7 +149,7 @@ abstract class Base
|
||||
$this->actionManager = $actionManager;
|
||||
$this->params = $actionManager->getParams();
|
||||
|
||||
/** @var FileManager */
|
||||
/** @var FileManager $fileManager */
|
||||
$fileManager = $container->get('fileManager');
|
||||
|
||||
$this->zipUtil = new ZipArchive($fileManager);
|
||||
@@ -258,7 +258,7 @@ abstract class Base
|
||||
|
||||
public function createConfigWriter(): ConfigWriter
|
||||
{
|
||||
/** @var \Espo\Core\InjectableFactory */
|
||||
/** @var \Espo\Core\InjectableFactory $injectableFactory */
|
||||
$injectableFactory = $this->getContainer()->get('injectableFactory');
|
||||
|
||||
return $injectableFactory->create(ConfigWriter::class);
|
||||
@@ -439,9 +439,9 @@ abstract class Base
|
||||
}
|
||||
}
|
||||
|
||||
/** @var string */
|
||||
/** @var string $errorMessage */
|
||||
$errorMessage = preg_replace('/\{version\}/', $currentVersion, $errorMessage);
|
||||
/** @var string */
|
||||
/** @var string $errorMessage */
|
||||
$errorMessage = preg_replace('/\{requiredVersion\}/', $version ?? '', $errorMessage);
|
||||
|
||||
$this->throwErrorAndRemovePackage($errorMessage);
|
||||
@@ -626,7 +626,7 @@ abstract class Base
|
||||
|
||||
foreach ($deleteList as $itemPath) {
|
||||
if (is_dir($itemPath)) {
|
||||
/** @var string[] */
|
||||
/** @var string[] $fileList */
|
||||
$fileList = $this->getFileManager()->getFileList($itemPath, true, '', true, true);
|
||||
|
||||
$fileList = $this->concatStringWithArray($itemPath, $fileList);
|
||||
@@ -731,10 +731,10 @@ abstract class Base
|
||||
|
||||
foreach ($paths as $filesPath) {
|
||||
if (file_exists($filesPath)) {
|
||||
/** @var string[] */
|
||||
/** @var string[] $files */
|
||||
$files = $this->getFileManager()->getFileList($filesPath, true, '', true, true);
|
||||
|
||||
/** @var string[] */
|
||||
/** @var string[] $fileList */
|
||||
$fileList = array_merge($fileList, $files);
|
||||
}
|
||||
}
|
||||
@@ -743,7 +743,7 @@ abstract class Base
|
||||
$vendorFileList = $this->getVendorFileList('copy');
|
||||
|
||||
if (!empty($vendorFileList)) {
|
||||
/** @var string[] */
|
||||
/** @var string[] $fileList */
|
||||
$fileList = array_merge($fileList, $vendorFileList);
|
||||
}
|
||||
}
|
||||
@@ -873,13 +873,13 @@ abstract class Base
|
||||
|
||||
switch ($type) {
|
||||
case 'copy':
|
||||
/** @var string[] */
|
||||
/** @var string[] $list */
|
||||
$list = $this->getFileManager()->getFileList($filesPath, true, '', true, true);
|
||||
|
||||
break;
|
||||
|
||||
case 'delete':
|
||||
/** @var string[] */
|
||||
/** @var string[] $list */
|
||||
$list = $this->getFileManager()->getFileList($filesPath, false, '', null, true);
|
||||
|
||||
break;
|
||||
|
||||
@@ -96,7 +96,7 @@ class Autoload
|
||||
$useCache = $this->config->get('useCache');
|
||||
|
||||
if ($useCache && $this->dataCache->has($this->cacheKey)) {
|
||||
/** @var ?array<string,mixed> */
|
||||
/** @var ?array<string,mixed> $data */
|
||||
$data = $this->dataCache->get($this->cacheKey);
|
||||
|
||||
$this->data = $data;
|
||||
|
||||
@@ -324,7 +324,7 @@ class Config
|
||||
$internalData = $this->fileManager->isFile($this->internalConfigPath) ?
|
||||
$this->fileManager->getPhpContents($this->internalConfigPath) : [];
|
||||
|
||||
/** @var array<string,mixed> */
|
||||
/** @var array<string,mixed> $mergedData */
|
||||
$mergedData = Util::merge(
|
||||
Util::merge($systemData, $data),
|
||||
$internalData
|
||||
|
||||
@@ -64,7 +64,7 @@ class Crypt
|
||||
throw new RuntimeException("openssl extension is not loaded.");
|
||||
}
|
||||
|
||||
/** @var string */
|
||||
/** @var string $iv */
|
||||
$iv = openssl_random_pseudo_bytes(16);
|
||||
|
||||
$this->iv = $iv;
|
||||
|
||||
@@ -181,7 +181,7 @@ class FieldUtil
|
||||
}
|
||||
|
||||
if (!array_key_exists($type, $this->fieldByTypeListCache[$entityType])) {
|
||||
/** @var array<string,array<string,mixed>> */
|
||||
/** @var array<string,array<string,mixed>> $fieldDefs */
|
||||
$fieldDefs = $this->metadata->get(['entityDefs', $entityType, 'fields'], []);
|
||||
|
||||
$list = [];
|
||||
|
||||
@@ -431,7 +431,7 @@ class Language
|
||||
}
|
||||
|
||||
if ($this->useCache) {
|
||||
/** @var array<string, mixed> */
|
||||
/** @var array<string, mixed> $cachedData */
|
||||
$cachedData = $this->dataCache->get($cacheKey);
|
||||
|
||||
$this->data[$language] = $cachedData;
|
||||
|
||||
@@ -131,7 +131,7 @@ class Metadata
|
||||
}
|
||||
|
||||
if ($this->dataCache->has($this->cacheKey) && !$reload) {
|
||||
/** @var array<string,mixed> */
|
||||
/** @var array<string,mixed> $data */
|
||||
$data = $this->dataCache->get($this->cacheKey);
|
||||
|
||||
$this->data = $data;
|
||||
@@ -207,7 +207,7 @@ class Metadata
|
||||
}
|
||||
|
||||
if ($this->dataCache->has($this->objCacheKey) && !$reload) {
|
||||
/** @var stdClass */
|
||||
/** @var stdClass $data */
|
||||
$data = $this->dataCache->get($this->objCacheKey);
|
||||
|
||||
$this->objData = $data;
|
||||
@@ -448,9 +448,9 @@ class Metadata
|
||||
],
|
||||
];
|
||||
|
||||
/** @var array<string,array<string,mixed>> */
|
||||
/** @var array<string,array<string,mixed>> $mergedChangedData */
|
||||
$mergedChangedData = Util::merge($this->changedData, $newData);
|
||||
/** @var array<string,mixed> */
|
||||
/** @var array<string,mixed> $mergedData */
|
||||
$mergedData = Util::merge($this->getData(), $newData);
|
||||
|
||||
$this->changedData = $mergedChangedData;
|
||||
@@ -517,15 +517,15 @@ class Metadata
|
||||
]
|
||||
];
|
||||
|
||||
/** @var array<string,array<string,mixed>> */
|
||||
/** @var array<string,array<string,mixed>> $mergedDeletedData */
|
||||
$mergedDeletedData = Util::merge($this->deletedData, $unsetData);
|
||||
$this->deletedData = $mergedDeletedData;
|
||||
|
||||
/** @var array<string,array<string,mixed>> */
|
||||
$unsedDeletedData = Util::unsetInArrayByValue('__APPEND__', $this->deletedData, true);
|
||||
$this->deletedData = $unsedDeletedData;
|
||||
/** @var array<string,array<string,mixed>> $unsetDeletedData */
|
||||
$unsetDeletedData = Util::unsetInArrayByValue('__APPEND__', $this->deletedData, true);
|
||||
$this->deletedData = $unsetDeletedData;
|
||||
|
||||
/** @var array<string,mixed> */
|
||||
/** @var array<string,mixed> $data */
|
||||
$data = Util::unsetInArray($this->getData(), $metadataUnsetData, true);
|
||||
$this->data = $data;
|
||||
}
|
||||
|
||||
@@ -117,7 +117,7 @@ class Module
|
||||
$this->dataCache &&
|
||||
$this->dataCache->has($this->cacheKey)
|
||||
) {
|
||||
/** @var array<string,array<string,mixed>> */
|
||||
/** @var array<string,array<string,mixed>> $data */
|
||||
$data = $this->dataCache->get($this->cacheKey);
|
||||
|
||||
$this->data = $data;
|
||||
|
||||
@@ -122,7 +122,7 @@ class Route
|
||||
* noAuth?:bool,
|
||||
* params?:array<string,mixed>,
|
||||
* }
|
||||
* >
|
||||
* > $data
|
||||
*/
|
||||
$data = $this->dataCache->get($this->cacheKey);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user