espocrm-extensions/espocrm-base
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc fix

Browse Source
This commit is contained in:
Yuri Kuznetsov
2021-04-25 11:25:45 +03:00
parent 38aeda6d83
commit 168f37dc8a
19 changed files with 68 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files
application/Espo/Core/Acl.php
+9 -9
View File
@@ -200,7 +200,7 @@ class Acl
* Get attributes forbidden for a user.
*
* @param $thresholdLevel Should not be used. Stands for possible future enhancements. *
* @return array<string>
* @return array<int, string>
*/
public function getScopeForbiddenAttributeList(
string $scope,
@@ -216,7 +216,7 @@ class Acl
* Get fields forbidden for a user.
*
* @param $thresholdLevel Should not be used. Stands for possible future enhancements.
* @return array<string>
* @return array<int, string>
*/
public function getScopeForbiddenFieldList(
string $scope,
@@ -232,7 +232,7 @@ class Acl
* Get links forbidden for a user.
*
* @param $thresholdLevel Should not be used. Stands for possible future enhancements.
* @return array<string>
* @return array<int, string>
*/
public function getScopeForbiddenLinkList(
string $scope,
@@ -266,8 +266,8 @@ class Acl
/**
* Get a restricted field list for a specific scope by a restriction type.
*
* @param string|array<string> $type
* @return array<string>
* @param string|array<int, string> $type
* @return array<int, string>
*/
public function getScopeRestrictedFieldList(string $scope, $type): array
{
@@ -277,8 +277,8 @@ class Acl
/**
* Get a restricted attribute list for a specific scope by a restriction type.
*
* @param string|array<string> $type
* @return array<string>
* @param string|array<int, string> $type
* @return array<int, string>
*/
public function getScopeRestrictedAttributeList(string $scope, $type): array
{
@@ -288,8 +288,8 @@ class Acl
/**
* Get a restricted link list for a specific scope by a restriction type.
*
* @param string|array<string> $type
* @return array<string>
* @param string|array<int, string> $type
* @return array<int, string>
*/
public function getScopeRestrictedLinkList(string $scope, $type): array
{
application/Espo/Core/Acl/Map/Map.php
+2 -2
View File
@@ -112,7 +112,7 @@ class Map
* @param $action An action.
* @param $thresholdLevel An attribute will be treated as forbidden if the level is
* equal to or lower than the threshold.
* @return array<string>
* @return array<int, string>
*/
public function getScopeForbiddenAttributeList(
string $scope,
@@ -184,7 +184,7 @@ class Map
* @param $action An action.
* @param $thresholdLevel An attribute will be treated as forbidden if the level is
* equal to or lower than the threshold.
* @return array<string>
* @return array<int, string>
*/
public function getScopeForbiddenFieldList(
string $scope,
application/Espo/Core/Acl/Map/MetadataProvider.php
+3 -3
View File
@@ -45,7 +45,7 @@ class MetadataProvider
}
/**
* @return array<string>
* @return array<int, string>
*/
public function getScopeList(): array
{
@@ -58,7 +58,7 @@ class MetadataProvider
}
/**
* @return array<string>
* @return array<int, string>
*/
public function getScopeFieldList(string $scope): array
{
@@ -66,7 +66,7 @@ class MetadataProvider
}
/**
* @return array<string>
* @return array<int, string>
*/
public function getPermissionList(): array
{
application/Espo/Core/Acl/Table/DefaultRoleListProvider.php
+1 -1
View File
@@ -49,7 +49,7 @@ class DefaultRoleListProvider implements RoleListProvider
}
/**
* @return array<Role>
* @return array<int, Role>
*/
public function get(): array
{
application/Espo/Core/Acl/Table/RoleListProvider.php
+1 -1
View File
@@ -32,7 +32,7 @@ namespace Espo\Core\Acl\Table;
interface RoleListProvider
{
/**
* @return array<Role>
* @return array<int, Role>
*/
public function get(): array;
}
application/Espo/Core/AclManager.php
+9 -9
View File
@@ -450,7 +450,7 @@ class AclManager
* Get attributes forbidden for a user.
*
* @param $thresholdLevel Should not be used. Stands for possible future enhancements.
* @return array<string>
* @return array<int, string>
*/
public function getScopeForbiddenAttributeList(
User $user,
@@ -478,7 +478,7 @@ class AclManager
* Get fields forbidden for a user.
*
* @param $thresholdLevel Should not be used. Stands for possible future enhancements.
* @return array<string>
* @return array<int, string>
*/
public function getScopeForbiddenFieldList(
User $user,
@@ -506,7 +506,7 @@ class AclManager
* Get links forbidden for a user.
*
* @param $thresholdLevel Should not be used. Stands for possible future enhancements.
* @return array<string>
* @return array<int, string>
*/
public function getScopeForbiddenLinkList(
User $user,
@@ -589,8 +589,8 @@ class AclManager
/**
* Get a restricted field list for a specific scope by a restriction type.
*
* @param string|array<string> $type
* @return array<string>
* @param string|array<int, string> $type
* @return array<int, string>
*/
public function getScopeRestrictedFieldList(string $scope, $type): array
{
@@ -615,8 +615,8 @@ class AclManager
/**
* Get a restricted attribute list for a specific scope by a restriction type.
*
* @param string|array<string> $type
* @return array<string>
* @param string|array<int, string> $type
* @return array<int, string>
*/
public function getScopeRestrictedAttributeList(string $scope, $type): array
{
@@ -641,8 +641,8 @@ class AclManager
/**
* Get a restricted link list for a specific scope by a restriction type.
*
* @param string|array<string> $type
* @return array<string>
* @param string|array<int, string> $type
* @return array<int, string>
*/
public function getScopeRestrictedLinkList(string $scope, $type): array
{
application/Espo/Core/Authentication/ConfigDataProvider.php
+1 -1
View File
@@ -93,7 +93,7 @@ class ConfigDataProvider
/**
* Allowed methods of 2FA.
*
* @return array<string>
* @return array<int, string>
*/
public function getTwoFactorMethodList(): array
{
application/Espo/Core/Console/Params.php
+4 -4
View File
@@ -40,12 +40,12 @@ class Params
private $options;
/**
* @var array<string>
* @var array<int, string>
*/
private $flagList;
/**
* @var array<string>
* @var array<int, string>
*/
private $argumentList;
@@ -65,7 +65,7 @@ class Params
}
/**
* @return array<string>
* @return array<int, string>
*/
public function getFlagList(): array
{
@@ -73,7 +73,7 @@ class Params
}
/**
* @return array<string>
* @return array<int, string>
*/
public function getArgumentList(): array
{
application/Espo/Core/FieldValidation/Params.php
+4 -4
View File
@@ -42,7 +42,7 @@ class Params
/**
* A field list that will be skipped in validation.
*
* @return array<string>
* @return array<int, string>
*/
public function getSkipFieldList(): array
{
@@ -52,7 +52,7 @@ class Params
/**
* A field list that will be skipped in validation for a specific validation type.
*
* @return array<string>
* @return array<int, string>
*/
public function getTypeSkipFieldList(string $type): array
{
@@ -62,7 +62,7 @@ class Params
/**
* Clone with a specified field list that will be skipped in validation.
*
* @param array<string> $list
* @param array<int, string> $list
*/
public function withSkipFieldList(array $list): self
{
@@ -76,7 +76,7 @@ class Params
/**
* Clone with a specified field list that will be skipped in validation for a specific validation type.
*
* @param array<string> $list
* @param array<int, string> $list
*/
public function withTypeSkipFieldList(string $type, array $list): self
{
application/Espo/Core/Fields/Currency/CurrencyConfigDataProvider.php
+1 -1
View File
@@ -61,7 +61,7 @@ class CurrencyConfigDataProvider
/**
* Get a list of available currencies.
*
* @return array<string>
* @return array<int, string>
*/
public function getCurrencyList(): array
{
application/Espo/Core/Fields/EmailAddressGroup.php
+7 -7
View File
@@ -38,7 +38,7 @@ use RuntimeException;
class EmailAddressGroup
{
/**
* @var array<EmailAddress>
* @var array<int, EmailAddress>
*/
private $list = [];
@@ -48,7 +48,7 @@ class EmailAddressGroup
private $primary = null;
/**
* @param array<EmailAddress> $list
* @param array<int, EmailAddress> $list
*
* @throws RuntimeException
*/
@@ -95,7 +95,7 @@ class EmailAddressGroup
/**
* Get a list of all email addresses.
*
* @return array<EmailAddress>
* @return array<int, EmailAddress>
*/
public function getList(): array
{
@@ -113,7 +113,7 @@ class EmailAddressGroup
/**
* Get a list of email addresses w/o a primary.
*
* @return array<EmailAddress>
* @return array<int, EmailAddress>
*/
public function getSecondaryList(): array
{
@@ -133,7 +133,7 @@ class EmailAddressGroup
/**
* Get a list of email addresses represented as strings.
*
* @return array<string>
* @return array<int, string>
*/
public function getAddressList(): array
{
@@ -191,7 +191,7 @@ class EmailAddressGroup
/**
* Clone with an added email address list.
*
* @param array<EmailAddress> $list
* @param array<int, EmailAddress> $list
*/
public function withAddedList(array $list): self
{
@@ -249,7 +249,7 @@ class EmailAddressGroup
/**
* Create from an email address list. A first item will be set as primary.
*
* @param array<EmailAddress> $list
* @param array<int, EmailAddress> $list
*/
public static function fromList(array $list): self
{
application/Espo/Core/Fields/LinkMultiple.php
+5 -5
View File
@@ -39,7 +39,7 @@ class LinkMultiple
private $list = [];
/**
* @param array<LinkMultipleItem> $list
* @param array<int, LinkMultipleItem> $list
*
* @throws RuntimeException
*/
@@ -72,7 +72,7 @@ class LinkMultiple
/**
* Get a list of IDs.
*
* @return array<string>
* @return array<int, string>
*/
public function getIdList(): array
{
@@ -88,7 +88,7 @@ class LinkMultiple
/**
* Get a list of items.
*
* @return array<LinkMultipleItem>
* @return array<int, LinkMultipleItem>
*/
public function getList(): array
{
@@ -128,7 +128,7 @@ class LinkMultiple
/**
* Clone with an added item list.
* .
* @param array<LinkMultipleItem> $list
* @param array<int, LinkMultipleItem> $list
*
* @throws RuntimeException
*/
@@ -180,7 +180,7 @@ class LinkMultiple
/**
* Create from an item list.
*
* @param array<LinkMultipleItem> $list
* @param array<int, LinkMultipleItem> $list
*
* @throws RuntimeException
*/
application/Espo/Core/Fields/LinkMultipleItem.php
+1 -1
View File
@@ -91,7 +91,7 @@ class LinkMultipleItem
/**
* Get a list of set columns.
*
* @return array<string>
* @return array<int, string>
*/
public function getColumnList(): array
{
application/Espo/Core/Fields/PhoneNumberGroup.php
+7 -7
View File
@@ -38,7 +38,7 @@ use RuntimeException;
class PhoneNumberGroup
{
/**
* @var array<PhoneNumber>
* @var array<int, PhoneNumber>
*/
private $list = [];
@@ -48,7 +48,7 @@ class PhoneNumberGroup
private $primary = null;
/**
* @param array<PhoneNumber> $list
* @param array<int, PhoneNumber> $list
*
* @throws RuntimeException
*/
@@ -95,7 +95,7 @@ class PhoneNumberGroup
/**
* Get a list of all phone numbers.
*
* @return array<PhoneNumber>
* @return array<int, PhoneNumber>
*/
public function getList(): array
{
@@ -113,7 +113,7 @@ class PhoneNumberGroup
/**
* Get a list of phone numbers w/o a primary.
*
* @return array<PhoneNumber>
* @return array<int, PhoneNumber>
*/
public function getSecondaryList(): array
{
@@ -133,7 +133,7 @@ class PhoneNumberGroup
/**
* Get a list of phone numbers represented as strings.
*
* @return array<string>
* @return array<int, string>
*/
public function getNumberList(): array
{
@@ -191,7 +191,7 @@ class PhoneNumberGroup
/**
* Clone with an added phone number list.
*
* @param array<PhoneNumber> $list
* @param array<int, PhoneNumber> $list
*/
public function withAddedList(array $list): self
{
@@ -249,7 +249,7 @@ class PhoneNumberGroup
/**
* Create from a phone number list. A first item will be set as primary.
*
* @param array<PhoneNumber> $list
* @param array<int, PhoneNumber> $list
*/
public static function fromList(array $list): self
{
application/Espo/Core/Portal/Acl/Table/RoleListProvider.php
+1 -1
View File
@@ -59,7 +59,7 @@ class RoleListProvider implements RoleListProviderInterface
}
/**
* @return array<Role>
* @return array<int, Role>
*/
public function get(): array
{
application/Espo/Core/Utils/File/Manager.php
+1 -1
View File
@@ -86,7 +86,7 @@ class Manager
* If TRUE - returns only file list, if FALSE - only directory list.
* @param bool $returnSingleArray Return a single array.
*
* @return array<string>
* @return array<int, string>
*/
public function getFileList(
string $path,
application/Espo/ORM/Defs/Defs.php
+2 -2
View File
@@ -46,7 +46,7 @@ class Defs
/**
* Get an entity type list.
*
* @return array<string>
* @return array<int, string>
*/
public function getEntityTypeList(): array
{
@@ -56,7 +56,7 @@ class Defs
/**
* Get an entity definitions list.
*
* @return array<EntityDefs>
* @return array<int, EntityDefs>
*/
public function getEntityList(): array
{
application/Espo/ORM/Defs/EntityDefs.php
+8 -8
View File
@@ -71,7 +71,7 @@ class EntityDefs
/**
* Get an attribute name list.
*
* @return array<string>
* @return array<int, string>
*/
public function getAttributeNameList(): array
{
@@ -81,7 +81,7 @@ class EntityDefs
/**
* Get a relation name list.
*
* @return array<string>
* @return array<int, string>
*/
public function getRelationNameList(): array
{
@@ -91,7 +91,7 @@ class EntityDefs
/**
* Get an index name list.
*
* @return array<string>
* @return array<int, string>
*/
public function getIndexNameList(): array
{
@@ -101,7 +101,7 @@ class EntityDefs
/**
* Get a field name list.
*
* @return array<string>
* @return array<int, string>
*/
public function getFieldNameList(): array
{
@@ -111,7 +111,7 @@ class EntityDefs
/**
* Get an attribute definitions list.
*
* @return array<AttributeDefs>
* @return array<int, AttributeDefs>
*/
public function getAttributeList(): array
{
@@ -127,7 +127,7 @@ class EntityDefs
/**
* Get a relation definitions list.
*
* @return array<RelationDefs>
* @return array<int, RelationDefs>
*/
public function getRelationList(): array
{
@@ -143,7 +143,7 @@ class EntityDefs
/**
* Get an index definitions list.
*
* @return array<IndexDefs>
* @return array<int, IndexDefs>
*/
public function getIndexList(): array
{
@@ -159,7 +159,7 @@ class EntityDefs
/**
* Get a field definitions list.
*
* @return array<FieldDefs>
* @return array<int, FieldDefs>
*/
public function getFieldList(): array
{
application/Espo/ORM/Metadata.php
+1 -1
View File
@@ -116,7 +116,7 @@ class Metadata
/**
* Get a list of entity types.
*
* @return array<string>
* @return array<int, string>
*/
public function getEntityTypeList(): array
{