viscous/espocrm
1
0
Fork 0
mirror of https://github.com/espocrm/espocrm.git synced 2026-06-28 15:06:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix phpdoc

Browse Source
This commit is contained in:
Yuri Kuznetsov
2022-08-10 17:13:31 +03:00
parent 62975b2957
commit 42175f98e4
25 changed files with 46 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
application/Espo/Core/Acl/AccessChecker/AccessCheckerFactory.php
View File

@@ -85,7 +85,7 @@ class AccessCheckerFactory
*/
private function getClassName(string $scope): string
{
/** @var ?class-string<AccessChecker> */
/** @var ?class-string<AccessChecker> $className1 */
$className1 = $this->metadata->get(['aclDefs', $scope, 'accessCheckerClassName']);
if ($className1) {

2
application/Espo/Core/Acl/AccessChecker/AccessCheckers/Foreign.php
View File

@@ -97,7 +97,7 @@ class Foreign implements
->getRelation($link)
->getForeignEntityType();
/** @var ?string */
/** @var ?string $id */
$id = $entity->get($link . 'Id');
if (!$id) {

2
application/Espo/Core/Acl/AssignmentChecker/AssignmentCheckerFactory.php
View File

@@ -75,7 +75,7 @@ class AssignmentCheckerFactory
*/
private function getClassName(string $scope): string
{
/** @var ?class-string<AssignmentChecker<\Espo\ORM\Entity>> */
/** @var ?class-string<AssignmentChecker<\Espo\ORM\Entity>> $className */
$className = $this->metadata->get(['aclDefs', $scope, 'assignmentCheckerClassName']);
if ($className) {

8
application/Espo/Core/Acl/DefaultAssignmentChecker.php
View File

@@ -228,7 +228,7 @@ class DefaultAssignmentChecker implements AssignmentChecker
return true;
}
/** @var string[] */
/** @var string[] $userTeamIdList */
$userTeamIdList = $user->getLinkMultipleIdList(self::FIELD_TEAMS);
foreach ($newIdList as $id) {
@@ -331,7 +331,7 @@ class DefaultAssignmentChecker implements AssignmentChecker
private function isPermittedAssignedUsersLevelNo(User $user, CoreEntity $entity): bool
{
/** @var string[] */
/** @var string[] $userIdList */
$userIdList = $entity->getLinkMultipleIdList(self::FIELD_ASSIGNED_USERS);
$fetchedAssignedUserIdList = $entity->getFetched(self::ATTR_ASSIGNED_USERS_IDS);
@@ -351,12 +351,12 @@ class DefaultAssignmentChecker implements AssignmentChecker
private function isPermittedAssignedUsersLevelTeam(User $user, CoreEntity $entity): bool
{
/** @var string[] */
/** @var string[] $userIdList */
$userIdList = $entity->getLinkMultipleIdList(self::FIELD_ASSIGNED_USERS);
$fetchedAssignedUserIdList = $entity->getFetched(self::ATTR_ASSIGNED_USERS_IDS);
/** @var string[] */
/** @var string[] $teamIdList */
$teamIdList = $user->getLinkMultipleIdList(self::FIELD_TEAMS);
foreach ($userIdList as $userId) {

2
application/Espo/Core/Acl/DefaultOwnershipChecker.php
View File

@@ -85,7 +85,7 @@ class DefaultOwnershipChecker implements OwnershipOwnChecker, OwnershipTeamCheck
return false;
}
/** @var string[] */
/** @var string[] $userTeamIdList */
$userTeamIdList = $user->getLinkMultipleIdList(self::FIELD_TEAMS);
if (

8
application/Espo/Core/Acl/GlobalRestriction.php
View File

@@ -110,7 +110,7 @@ class GlobalRestriction
$useCache = $config->get('useCache');
if ($useCache && $this->dataCache->has($this->cacheKey)) {
/** @var stdClass */
/** @var stdClass $cachedData */
$cachedData = $this->dataCache->get($this->cacheKey);
$this->data = $cachedData;
@@ -136,15 +136,15 @@ class GlobalRestriction
private function buildData(): void
{
/** @var string[] */
/** @var string[] $scopeList */
$scopeList = array_keys($this->metadata->get(['entityDefs']) ?? []);
$data = (object) [];
foreach ($scopeList as $scope) {
/** @var string[] */
/** @var string[] $fieldList */
$fieldList = array_keys($this->metadata->get(['entityDefs', $scope, 'fields']) ?? []);
/** @var string[] */
/** @var string[] $linkList */
$linkList = array_keys($this->metadata->get(['entityDefs', $scope, 'links']) ?? []);
$isNotEmpty = false;

2
application/Espo/Core/Acl/Map/Map.php
View File

@@ -95,7 +95,7 @@ class Map
$this->cacheKey = $cacheKeyProvider->get();
if ($this->config->get('useCache') && $this->dataCache->has($this->cacheKey)) {
/** @var stdClass */
/** @var stdClass $cachedData */
$cachedData = $this->dataCache->get($this->cacheKey);
$this->data = $cachedData;

2
application/Espo/Core/Acl/OwnershipChecker/OwnershipCheckerFactory.php
View File

@@ -80,7 +80,7 @@ class OwnershipCheckerFactory
*/
private function getClassName(string $scope): string
{
/** @var ?class-string<OwnershipChecker> */
/** @var ?class-string<OwnershipChecker> $className */
$className = $this->metadata->get(['aclDefs', $scope, 'ownershipCheckerClassName']);
if ($className) {

6
application/Espo/Core/Acl/Table/DefaultRoleListProvider.php
View File

@@ -53,7 +53,7 @@ class DefaultRoleListProvider implements RoleListProvider
{
$roleList = [];
/** @var iterable<RoleEntity> */
/** @var iterable<RoleEntity> $userRoleList */
$userRoleList = $this->entityManager
->getRDBRepository('User')
->getRelation($this->user, 'roles')
@@ -63,14 +63,14 @@ class DefaultRoleListProvider implements RoleListProvider
$roleList[] = $role;
}
/** @var iterable<\Espo\Entities\Team> */
/** @var iterable<\Espo\Entities\Team> $teamList */
$teamList = $this->entityManager
->getRDBRepository('User')
->getRelation($this->user, 'teams')
->find();
foreach ($teamList as $team) {
/** @var iterable<RoleEntity> */
/** @var iterable<RoleEntity> $teamRoleList */
$teamRoleList = $this->entityManager
->getRDBRepository('Team')
->getRelation($team, 'roles')

2
application/Espo/Core/Acl/Table/DefaultTable.php
View File

@@ -146,7 +146,7 @@ class DefaultTable implements Table
$this->cacheKey = $cacheKeyProvider->get();
if ($config->get('useCache') && $dataCache->has($this->cacheKey)) {
/** @var stdClass */
/** @var stdClass $cachedData */
$cachedData = $dataCache->get($this->cacheKey);
$this->data = $cachedData;

4
application/Espo/Core/Action/Actions/Merge/Merger.php
View File

@@ -209,7 +209,7 @@ class Merger
{
$list = [];
/** @var iterable<PhoneNumber> */
/** @var iterable<PhoneNumber> $collection */
$collection = $this->entityManager
->getRDBRepository($entity->getEntityType())
->getRelation($entity, 'phoneNumbers')
@@ -229,7 +229,7 @@ class Merger
{
$list = [];
/** @var iterable<EmailAddress> */
/** @var iterable<EmailAddress> $collection */
$collection = $this->entityManager
->getRDBRepository($entity->getEntityType())
->getRelation($entity, 'emailAddresses')

2
application/Espo/Core/Api/ActionProcessor.php
View File

@@ -178,7 +178,7 @@ class ActionProcessor
return false;
}
/** @var class-string */
/** @var class-string $className */
$className = $type->getName();
$firstParamClass = new ReflectionClass($className);

2
application/Espo/Core/Api/Auth.php
View File

@@ -178,7 +178,7 @@ class Auth
*/
protected function decodeAuthorizationString(string $string): array
{
/** @var string */
/** @var string $stringDecoded */
$stringDecoded = base64_decode($string);
if (strpos($stringDecoded, ':') === false) {

8
application/Espo/Core/Authentication/AuthToken/EspoManager.php
View File

@@ -50,7 +50,7 @@ class EspoManager implements Manager
{
$this->entityManager = $entityManager;
/** @var RDBRepository<AuthTokenEntity> */
/** @var RDBRepository<AuthTokenEntity> $repository */
$repository = $entityManager->getRDBRepository(AuthTokenEntity::ENTITY_TYPE);
$this->repository = $repository;
@@ -58,7 +58,7 @@ class EspoManager implements Manager
public function get(string $token): ?AuthToken
{
/** @var ?AuthTokenEntity */
/** @var ?AuthTokenEntity $authToken */
$authToken = $this->entityManager
->getRDBRepository(AuthTokenEntity::ENTITY_TYPE)
->select([
@@ -83,7 +83,7 @@ class EspoManager implements Manager
public function create(Data $data): AuthToken
{
/** @var AuthTokenEntity */
/** @var AuthTokenEntity $authToken */
$authToken = $this->repository->getNew();
$authToken->set([
@@ -169,7 +169,7 @@ class EspoManager implements Manager
}
if (function_exists('openssl_random_pseudo_bytes')) {
/** @var string */
/** @var string $randomValue */
$randomValue = openssl_random_pseudo_bytes($length);
return bin2hex($randomValue);

4
application/Espo/Core/Authentication/Authentication.php
View File

@@ -353,7 +353,7 @@ class Authentication
private function processAuthTokenCheck(AuthToken $authToken): bool
{
if ($this->allowAnyAccess && $authToken->getPortalId() && !$this->isPortal()) {
/** @var ?Portal */
/** @var ?Portal $portal */
$portal = $this->entityManager->getEntity('Portal', $authToken->getPortalId());
if ($portal) {
@@ -562,7 +562,7 @@ class Authentication
return null;
}
/** @var AuthLogRecord */
/** @var AuthLogRecord $authLogRecord */
$authLogRecord = $this->entityManager->getNewEntity('AuthLogRecord');
$requestUrl =

6
application/Espo/Core/Authentication/Helper/UserFinder.php
View File

@@ -44,7 +44,7 @@ class UserFinder
public function find(string $username, string $hash): ?User
{
/** @var ?User */
/** @var ?User $user */
$user = $this->entityManager
->getRDBRepository(User::ENTITY_TYPE)
->where([
@@ -59,7 +59,7 @@ class UserFinder
public function findApiHmac(string $apiKey): ?User
{
/** @var ?User */
/** @var ?User $user */
$user = $this->entityManager
->getRDBRepository(User::ENTITY_TYPE)
->where([
@@ -74,7 +74,7 @@ class UserFinder
public function findApiApiKey(string $apiKey): ?User
{
/** @var ?User */
/** @var ?User $user */
$user = $this->entityManager
->getRDBRepository(User::ENTITY_TYPE)
->where([

4
application/Espo/Core/Authentication/LoginFactory.php
View File

@@ -52,14 +52,14 @@ class LoginFactory
public function create(string $method, bool $isPortal = false): Login
{
/** @var class-string<Login> */
/** @var class-string<Login> $className */
$className = $this->metadata->get(['authenticationMethods', $method, 'implementationClassName']);
if (!$className) {
$sanitizedName = preg_replace('/[^a-zA-Z0-9]+/', '', $method);
if (!class_exists($className)) {
/** @var class-string<Login> */
/** @var class-string<Login> $className */
$className = "Espo\\Core\\Authentication\\Logins\\" . $sanitizedName;
}
}

2
application/Espo/Core/Authentication/Logins/LDAP.php
View File

@@ -428,7 +428,7 @@ class LDAP implements Login
'(' . $options['userNameAttribute'] . '=' . $username . ')' .
$loginFilterString . ')';
/** @var array<int,array{dn: string}> */
/** @var array<int,array{dn: string}> $result */
$result = $ldapClient->search($searchString, null, Client::SEARCH_SCOPE_SUB);
$this->log->debug('LDAP: user search string: "' . $searchString . '"');

2
application/Espo/Core/Authentication/TwoFactor/LoginFactory.php
View File

@@ -48,7 +48,7 @@ class LoginFactory
public function create(string $method): Login
{
/** @var ?class-string<Login> */
/** @var ?class-string<Login> $className */
$className = $this->metadata->get(['app', 'authentication2FAMethods', $method, 'loginClassName']);
if (!$className) {

2
application/Espo/Core/Authentication/TwoFactor/UserSetupFactory.php
View File

@@ -48,7 +48,7 @@ class UserSetupFactory
public function create(string $method): UserSetup
{
/** @var ?class-string<UserSetup> */
/** @var ?class-string<UserSetup> $className */
$className = $this->metadata->get(['app', 'authentication2FAMethods', $method, 'userSetupClassName']);
if (!$className) {

2
application/Espo/Core/Console/CommandManager.php
View File

@@ -129,7 +129,7 @@ class CommandManager
*/
private function getClassName(string $command): string
{
/** @var ?class-string<Command> */
/** @var ?class-string<Command> $className */
$className =
$this->metadata->get(['app', 'consoleCommands', lcfirst($command), 'className']);

6
application/Espo/Core/Console/Commands/AclCheck.php
View File

@@ -73,7 +73,7 @@ class AclCheck implements Command
$container = $this->container;
/** @var \Espo\ORM\EntityManager */
/** @var \Espo\ORM\EntityManager $entityManager */
$entityManager = $container->get('entityManager');
$user = $entityManager->getEntity('User', $userId);
@@ -83,7 +83,7 @@ class AclCheck implements Command
}
if ($user->isPortal()) {
/** @var string[] */
/** @var string[] $portalIdList */
$portalIdList = $user->getLinkMultipleIdList('portals');
foreach ($portalIdList as $portalId) {
@@ -91,7 +91,7 @@ class AclCheck implements Command
$containerPortal = $application->getContainer();
/** @var \Espo\ORM\EntityManager */
/** @var \Espo\ORM\EntityManager $entityManager */
$entityManager = $containerPortal->get('entityManager');
$user = $entityManager->getEntity('User', $userId);

4
application/Espo/Core/Console/Commands/AppInfo.php
View File

@@ -53,7 +53,7 @@ class AppInfo implements Command
public function run(Params $params, IO $io): void
{
/** @var string[] */
/** @var string[] $fileList */
$fileList = $this->fileManager->getFileList('application/Espo/Classes/AppInfo');
$typeList = array_map(
@@ -90,7 +90,7 @@ class AppInfo implements Command
protected function processType(IO $io, string $type, Params $params): void
{
/** @var class-string */
/** @var class-string $className */
$className = 'Espo\\Classes\\AppInfo\\' . ucfirst($type);
$obj = $this->injectableFactory->create($className);

2
application/Espo/Core/Console/Commands/Help.php
View File

@@ -47,7 +47,7 @@ class Help implements Command
public function run(Params $params, IO $io): void
{
/** @var string[] */
/** @var string[] $fullCommandList */
$fullCommandList = array_keys($this->metadata->get(['app', 'consoleCommands']) ?? []);
$commandList = array_filter(

6
application/Espo/Core/Console/Commands/Upgrade.php
View File

@@ -289,7 +289,7 @@ class Upgrade implements Command
private function upload(string $filePath): string
{
try {
/** @var string */
/** @var string $fileData */
$fileData = file_get_contents($filePath);
$fileData = 'data:application/zip;base64,' . base64_encode($fileData);
@@ -366,7 +366,7 @@ class Upgrade implements Command
$command = $phpExecutablePath . " command.php upgrade-step --step=". ucfirst($stepName) .
" --id=" . $upgradeId;
/** @var string */
/** @var string $shellResult */
$shellResult = shell_exec($command);
if ($shellResult !== 'true') {
@@ -389,7 +389,7 @@ class Upgrade implements Command
private function confirm(): bool
{
/** @var resource */
/** @var resource $fh */
$fh = fopen('php://stdin', 'r');
$inputLine = trim(fgets($fh)); /** @phpstan-ignore-line */