From 331fb6936447fc8b10f06d9b7d552e51426c2d72 Mon Sep 17 00:00:00 2001 From: Yuri Kuznetsov Date: Sun, 16 Oct 2022 17:53:31 +0300 Subject: [PATCH] phpdoc --- application/Espo/Core/Field/Address.php | 6 ++---- application/Espo/Core/Field/Currency.php | 3 ++- application/Espo/Core/Field/Date.php | 3 ++- application/Espo/Core/Field/DateTime.php | 2 ++ application/Espo/Core/Field/DateTimeOptional.php | 4 ++-- application/Espo/Core/Field/EmailAddress.php | 4 ++-- .../Espo/Core/Field/EmailAddressGroup.php | 7 +++---- application/Espo/Core/Field/Link.php | 3 ++- application/Espo/Core/Field/LinkMultiple.php | 2 ++ application/Espo/Core/Field/LinkMultipleItem.php | 2 ++ application/Espo/Core/Field/LinkParent.php | 4 ++-- application/Espo/Core/Field/PhoneNumber.php | 5 ++--- application/Espo/Core/Field/PhoneNumberGroup.php | 12 ++++-------- application/Espo/Core/Record/CreateParams.php | 4 +++- application/Espo/Core/Record/DeleteParams.php | 3 +++ application/Espo/Core/Record/FindParams.php | 3 +++ application/Espo/Core/Record/ReadParams.php | 3 +++ application/Espo/Core/Record/UpdateParams.php | 4 +++- application/Espo/Core/Select/Order/Item.php | 4 +++- application/Espo/Core/Select/Order/Params.php | 14 +++++--------- .../Espo/Core/Select/Text/Filter/Data.php | 11 ++++------- .../Espo/Core/Select/Text/FilterParams.php | 3 +++ .../Core/Select/Text/FullTextSearch/Data.php | 6 +++--- .../Text/FullTextSearch/DataComposer/Params.php | 3 +++ application/Espo/Core/Select/Where/Params.php | 4 +++- application/Espo/ORM/DatabaseParams.php | 15 +++------------ application/Espo/ORM/Query/Delete.php | 2 ++ application/Espo/ORM/Query/Insert.php | 2 ++ application/Espo/ORM/Query/LockTable.php | 3 ++- application/Espo/ORM/Query/Part/Condition.php | 13 +++++-------- application/Espo/ORM/Query/Part/Expression.php | 2 ++ application/Espo/ORM/Query/Part/Join.php | 4 ++-- application/Espo/ORM/Query/Part/Order.php | 4 ++-- application/Espo/ORM/Query/Part/OrderList.php | 6 ++---- application/Espo/ORM/Query/Part/Selection.php | 3 ++- .../Espo/ORM/Query/Part/Where/AndGroup.php | 2 ++ .../Espo/ORM/Query/Part/Where/Comparison.php | 16 +++------------- application/Espo/ORM/Query/Part/Where/Not.php | 10 ++++------ .../Espo/ORM/Query/Part/Where/OrGroup.php | 6 +++--- application/Espo/ORM/Query/Part/WhereClause.php | 6 +++--- application/Espo/ORM/Query/Part/WhereItem.php | 2 +- application/Espo/ORM/Query/Select.php | 3 ++- application/Espo/ORM/Query/Union.php | 2 ++ application/Espo/ORM/Query/Update.php | 2 ++ 44 files changed, 114 insertions(+), 108 deletions(-) diff --git a/application/Espo/Core/Field/Address.php b/application/Espo/Core/Field/Address.php index 5b7ace74a9..38f68f74f0 100644 --- a/application/Espo/Core/Field/Address.php +++ b/application/Espo/Core/Field/Address.php @@ -33,17 +33,15 @@ use Espo\Core\Field\Address\AddressBuilder; /** * An address value object. Immutable. + * + * @immutable */ class Address { private $street = null; - private $city = null; - private $country = null; - private $state = null; - private $postalCode = null; public function __construct( diff --git a/application/Espo/Core/Field/Currency.php b/application/Espo/Core/Field/Currency.php index 99a6db90fb..a57a62ffbe 100644 --- a/application/Espo/Core/Field/Currency.php +++ b/application/Espo/Core/Field/Currency.php @@ -36,11 +36,12 @@ use InvalidArgumentException; /** * A currency value object. Immutable. + * + * @immutable */ class Currency { private string $amount; - private string $code; /** diff --git a/application/Espo/Core/Field/Date.php b/application/Espo/Core/Field/Date.php index 8eef546ae9..6d9c4ba1e7 100644 --- a/application/Espo/Core/Field/Date.php +++ b/application/Espo/Core/Field/Date.php @@ -39,11 +39,12 @@ use RuntimeException; /** * A date value object. Immutable. + * + * @immutable */ class Date implements DateTimeable { private string $value; - private DateTimeImmutable $dateTime; private const SYSTEM_FORMAT = 'Y-m-d'; diff --git a/application/Espo/Core/Field/DateTime.php b/application/Espo/Core/Field/DateTime.php index b020ac9bd4..96145634e4 100644 --- a/application/Espo/Core/Field/DateTime.php +++ b/application/Espo/Core/Field/DateTime.php @@ -39,6 +39,8 @@ use RuntimeException; /** * A date-time value object. Immutable. + * + * @immutable */ class DateTime implements DateTimeable { diff --git a/application/Espo/Core/Field/DateTimeOptional.php b/application/Espo/Core/Field/DateTimeOptional.php index 32cc092270..d0a0649d0c 100644 --- a/application/Espo/Core/Field/DateTimeOptional.php +++ b/application/Espo/Core/Field/DateTimeOptional.php @@ -29,8 +29,6 @@ namespace Espo\Core\Field; -use Espo\Core\Field\DateTime; -use Espo\Core\Field\Date; use Espo\Core\Field\DateTime\DateTimeable; use DateTimeImmutable; @@ -41,6 +39,8 @@ use RuntimeException; /** * A date-time or date. Immutable. + * + * @immutable */ class DateTimeOptional implements DateTimeable { diff --git a/application/Espo/Core/Field/EmailAddress.php b/application/Espo/Core/Field/EmailAddress.php index 51a15577ad..393cd6eeaf 100644 --- a/application/Espo/Core/Field/EmailAddress.php +++ b/application/Espo/Core/Field/EmailAddress.php @@ -35,13 +35,13 @@ use FILTER_VALIDATE_EMAIL; /** * An email address value. Immutable. + * + * @immutable */ class EmailAddress { private string $address; - private bool $isOptedOut = false; - private bool $isInvalid = false; public function __construct(string $address) diff --git a/application/Espo/Core/Field/EmailAddressGroup.php b/application/Espo/Core/Field/EmailAddressGroup.php index 2518824180..36c65ba5c3 100644 --- a/application/Espo/Core/Field/EmailAddressGroup.php +++ b/application/Espo/Core/Field/EmailAddressGroup.php @@ -34,14 +34,13 @@ use RuntimeException; /** * An email address group. Contains a list of email addresses. One email address is set as primary. * If not empty, then there always should be a primary address. Immutable. + * + * @immutable */ class EmailAddressGroup { - /** - * @var EmailAddress[] - */ + /** @var EmailAddress[] */ private array $list = []; - private ?EmailAddress $primary = null; /** diff --git a/application/Espo/Core/Field/Link.php b/application/Espo/Core/Field/Link.php index dd913d301b..4d6cd306ec 100644 --- a/application/Espo/Core/Field/Link.php +++ b/application/Espo/Core/Field/Link.php @@ -33,11 +33,12 @@ use RuntimeException; /** * A link value object. Immutable. + * + * @immutable */ class Link { private string $id; - private ?string $name = null; public function __construct(string $id) diff --git a/application/Espo/Core/Field/LinkMultiple.php b/application/Espo/Core/Field/LinkMultiple.php index 2429162ae7..dd79b55de3 100644 --- a/application/Espo/Core/Field/LinkMultiple.php +++ b/application/Espo/Core/Field/LinkMultiple.php @@ -33,6 +33,8 @@ use RuntimeException; /** * A link-multiple value object. Immutable. + * + * @immutable */ class LinkMultiple { diff --git a/application/Espo/Core/Field/LinkMultipleItem.php b/application/Espo/Core/Field/LinkMultipleItem.php index 79b3556d2a..8237e668b1 100644 --- a/application/Espo/Core/Field/LinkMultipleItem.php +++ b/application/Espo/Core/Field/LinkMultipleItem.php @@ -33,6 +33,8 @@ use RuntimeException; /** * A link-multiple item. Immutable. + * + * @immutable */ class LinkMultipleItem { diff --git a/application/Espo/Core/Field/LinkParent.php b/application/Espo/Core/Field/LinkParent.php index 84ea04b777..d1ee0e3781 100644 --- a/application/Espo/Core/Field/LinkParent.php +++ b/application/Espo/Core/Field/LinkParent.php @@ -33,13 +33,13 @@ use RuntimeException; /** * A link-parent value object. Immutable. + * + * @immutable */ class LinkParent { private string $entityType; - private string $id; - private ?string $name = null; public function __construct(string $entityType, string $id) diff --git a/application/Espo/Core/Field/PhoneNumber.php b/application/Espo/Core/Field/PhoneNumber.php index 02deb5fd5a..8f3585933b 100644 --- a/application/Espo/Core/Field/PhoneNumber.php +++ b/application/Espo/Core/Field/PhoneNumber.php @@ -33,15 +33,14 @@ use RuntimeException; /** * A phone number value. Immutable. + * + * @immutable */ class PhoneNumber { private string $number; - private ?string $type = null; - private bool $isOptedOut = false; - private bool $isInvalid = false; public function __construct(string $number) diff --git a/application/Espo/Core/Field/PhoneNumberGroup.php b/application/Espo/Core/Field/PhoneNumberGroup.php index 5bf0d61fcf..53fe28d1ce 100644 --- a/application/Espo/Core/Field/PhoneNumberGroup.php +++ b/application/Espo/Core/Field/PhoneNumberGroup.php @@ -34,18 +34,14 @@ use RuntimeException; /** * A phone number group. Contains a list of phone numbers. One phone number is set as primary. * If not empty, then there always should be a primary number. Immutable. + * + * @immutable */ class PhoneNumberGroup { - /** - * @var PhoneNumber[] - */ + /** @var PhoneNumber[] */ private $list = []; - - /** - * @var ?PhoneNumber - */ - private $primary = null; + private ?PhoneNumber $primary = null; /** * @param PhoneNumber[] $list diff --git a/application/Espo/Core/Record/CreateParams.php b/application/Espo/Core/Record/CreateParams.php index 693695ce6c..8f36b28d25 100644 --- a/application/Espo/Core/Record/CreateParams.php +++ b/application/Espo/Core/Record/CreateParams.php @@ -29,10 +29,12 @@ namespace Espo\Core\Record; +/** + * @immutable + */ class CreateParams { private bool $skipDuplicateCheck = false; - private ?string $duplicateSourceId = null; public function __construct() {} diff --git a/application/Espo/Core/Record/DeleteParams.php b/application/Espo/Core/Record/DeleteParams.php index 301f28aa5a..01d0c6bd6a 100644 --- a/application/Espo/Core/Record/DeleteParams.php +++ b/application/Espo/Core/Record/DeleteParams.php @@ -29,6 +29,9 @@ namespace Espo\Core\Record; +/** + * @immutable + */ class DeleteParams { public function __construct() {} diff --git a/application/Espo/Core/Record/FindParams.php b/application/Espo/Core/Record/FindParams.php index 1987de64da..1ae8a4ef49 100644 --- a/application/Espo/Core/Record/FindParams.php +++ b/application/Espo/Core/Record/FindParams.php @@ -29,6 +29,9 @@ namespace Espo\Core\Record; +/** + * @immutable + */ class FindParams { private bool $noTotal = false; diff --git a/application/Espo/Core/Record/ReadParams.php b/application/Espo/Core/Record/ReadParams.php index ae196ec907..9f3b9855e9 100644 --- a/application/Espo/Core/Record/ReadParams.php +++ b/application/Espo/Core/Record/ReadParams.php @@ -29,6 +29,9 @@ namespace Espo\Core\Record; +/** + * @immutable + */ class ReadParams { public function __construct() {} diff --git a/application/Espo/Core/Record/UpdateParams.php b/application/Espo/Core/Record/UpdateParams.php index 6fff221203..835b8f40c0 100644 --- a/application/Espo/Core/Record/UpdateParams.php +++ b/application/Espo/Core/Record/UpdateParams.php @@ -29,10 +29,12 @@ namespace Espo\Core\Record; +/** + * @immutable + */ class UpdateParams { private bool $skipDuplicateCheck = false; - private ?int $versionNumber = null; public function __construct() {} diff --git a/application/Espo/Core/Select/Order/Item.php b/application/Espo/Core/Select/Order/Item.php index 501bd6aed7..b5011ace6a 100644 --- a/application/Espo/Core/Select/Order/Item.php +++ b/application/Espo/Core/Select/Order/Item.php @@ -33,10 +33,12 @@ use Espo\Core\Select\SearchParams; use InvalidArgumentException; +/** + * @immutable + */ class Item { private string $orderBy; - private string $order; private function __construct(string $orderBy, string $order) diff --git a/application/Espo/Core/Select/Order/Params.php b/application/Espo/Core/Select/Order/Params.php index 41a644252e..64735c6d21 100644 --- a/application/Espo/Core/Select/Order/Params.php +++ b/application/Espo/Core/Select/Order/Params.php @@ -33,20 +33,16 @@ use Espo\Core\Select\SearchParams; use InvalidArgumentException; +/** + * @immutable + */ class Params { private bool $forbidComplexExpressions = false; - private bool $forceDefault = false; - - /** - * @var mixed - */ + /** @var mixed */ private $orderBy = null; - - /** - * @var mixed - */ + /** @var mixed */ private $order = null; private function __construct() diff --git a/application/Espo/Core/Select/Text/Filter/Data.php b/application/Espo/Core/Select/Text/Filter/Data.php index e6ab63e45e..91a5ea7379 100644 --- a/application/Espo/Core/Select/Text/Filter/Data.php +++ b/application/Espo/Core/Select/Text/Filter/Data.php @@ -31,19 +31,16 @@ namespace Espo\Core\Select\Text\Filter; use Espo\ORM\Query\Part\WhereItem; +/** + * @immutable + */ class Data { private string $filter; - - /** - * @var string[] - */ + /** @var string[] */ private array $attributeList; - private bool $skipWildcards = false; - private ?WhereItem $fullTextSearchWhereItem = null; - private bool $forceFullTextSearch = false; /** diff --git a/application/Espo/Core/Select/Text/FilterParams.php b/application/Espo/Core/Select/Text/FilterParams.php index a36cb1c87d..c351b3dfa0 100644 --- a/application/Espo/Core/Select/Text/FilterParams.php +++ b/application/Espo/Core/Select/Text/FilterParams.php @@ -29,6 +29,9 @@ namespace Espo\Core\Select\Text; +/** + * @immutable + */ class FilterParams { private bool $noFullTextSearch = false; diff --git a/application/Espo/Core/Select/Text/FullTextSearch/Data.php b/application/Espo/Core/Select/Text/FullTextSearch/Data.php index 5af9b2fed9..311b8b268a 100644 --- a/application/Espo/Core/Select/Text/FullTextSearch/Data.php +++ b/application/Espo/Core/Select/Text/FullTextSearch/Data.php @@ -33,20 +33,20 @@ use Espo\ORM\Query\Part\Expression; use InvalidArgumentException; +/** + * @immutable + */ class Data { private Expression $expression; - /** * @var string[] */ private array $fieldList; - /** * @var string[] */ private array $columnList; - /** * @var Mode::* $mode */ diff --git a/application/Espo/Core/Select/Text/FullTextSearch/DataComposer/Params.php b/application/Espo/Core/Select/Text/FullTextSearch/DataComposer/Params.php index 33d32ba8ce..38a8980784 100644 --- a/application/Espo/Core/Select/Text/FullTextSearch/DataComposer/Params.php +++ b/application/Espo/Core/Select/Text/FullTextSearch/DataComposer/Params.php @@ -29,6 +29,9 @@ namespace Espo\Core\Select\Text\FullTextSearch\DataComposer; +/** + * @immutable + */ class Params { private function __construct() {} diff --git a/application/Espo/Core/Select/Where/Params.php b/application/Espo/Core/Select/Where/Params.php index 5aa417b3c5..b21284615e 100644 --- a/application/Espo/Core/Select/Where/Params.php +++ b/application/Espo/Core/Select/Where/Params.php @@ -31,10 +31,12 @@ namespace Espo\Core\Select\Where; use InvalidArgumentException; +/** + * @immutable + */ class Params { private bool $applyPermissionCheck = false; - private bool $forbidComplexExpressions = false; private function __construct() diff --git a/application/Espo/ORM/DatabaseParams.php b/application/Espo/ORM/DatabaseParams.php index 9cd790593d..4a45005c13 100644 --- a/application/Espo/ORM/DatabaseParams.php +++ b/application/Espo/ORM/DatabaseParams.php @@ -29,32 +29,23 @@ namespace Espo\ORM; +/** + * @immutable + */ class DatabaseParams { private ?string $platform = null; - private ?string $host = null; - private ?int $port = null; - private ?string $name = null; - private ?string $username = null; - private ?string $password = null; - private ?string $charset = null; - private ?string $sslCa = null; - private ?string $sslCert = null; - private ?string $sslKey = null; - private ?string $sslCaPath = null; - private ?string $sslCipher = null; - private bool $sslVerifyDisabled = false; public static function create(): self diff --git a/application/Espo/ORM/Query/Delete.php b/application/Espo/ORM/Query/Delete.php index f1df16773b..436cd51a79 100644 --- a/application/Espo/ORM/Query/Delete.php +++ b/application/Espo/ORM/Query/Delete.php @@ -33,6 +33,8 @@ use RuntimeException; /** * Delete parameters. + * + * @immutable */ class Delete implements Query { diff --git a/application/Espo/ORM/Query/Insert.php b/application/Espo/ORM/Query/Insert.php index d2098a0c77..a82c7a79ab 100644 --- a/application/Espo/ORM/Query/Insert.php +++ b/application/Espo/ORM/Query/Insert.php @@ -33,6 +33,8 @@ use RuntimeException; /** * Insert parameters. + * + * @immutable */ class Insert implements Query { diff --git a/application/Espo/ORM/Query/LockTable.php b/application/Espo/ORM/Query/LockTable.php index fee84b360a..57ac48b6db 100644 --- a/application/Espo/ORM/Query/LockTable.php +++ b/application/Espo/ORM/Query/LockTable.php @@ -33,13 +33,14 @@ use RuntimeException; /** * LOCK TABLE parameters. + * + * @immutable */ class LockTable implements Query { use BaseTrait; public const MODE_SHARE = 'SHARE'; - public const MODE_EXCLUSIVE = 'EXCLUSIVE'; /** diff --git a/application/Espo/ORM/Query/Part/Condition.php b/application/Espo/ORM/Query/Part/Condition.php index 13d2eb85cc..b04b5e0724 100644 --- a/application/Espo/ORM/Query/Part/Condition.php +++ b/application/Espo/ORM/Query/Part/Condition.php @@ -29,18 +29,15 @@ namespace Espo\ORM\Query\Part; -use Espo\ORM\Query\Part\{ - WhereItem, - Where\AndGroup, - Where\OrGroup, - Where\Not, - Where\Comparison, -}; +use Espo\ORM\Query\Part\Where\AndGroup; +use Espo\ORM\Query\Part\Where\Comparison; +use Espo\ORM\Query\Part\Where\Not; +use Espo\ORM\Query\Part\Where\OrGroup; use Espo\ORM\Query\Select; /** - * A util-class for creating items that can be used as a where-clause. + * An util-class for creating items that can be used as a where-clause. */ class Condition { diff --git a/application/Espo/ORM/Query/Part/Expression.php b/application/Espo/ORM/Query/Part/Expression.php index 84b082656b..c49e31ac3d 100644 --- a/application/Espo/ORM/Query/Part/Expression.php +++ b/application/Espo/ORM/Query/Part/Expression.php @@ -35,6 +35,8 @@ use RuntimeException; /** * A complex expression. Can be a function or a simple column reference. Immutable. + * + * @immutable */ class Expression implements WhereItem { diff --git a/application/Espo/ORM/Query/Part/Join.php b/application/Espo/ORM/Query/Part/Join.php index 66a6205ed8..bd851e7581 100644 --- a/application/Espo/ORM/Query/Part/Join.php +++ b/application/Espo/ORM/Query/Part/Join.php @@ -33,13 +33,13 @@ use RuntimeException; /** * A join item. Immutable. + * + * @immutable */ class Join { private string $target; - private ?string $alias = null; - private ?WhereItem $conditions = null; private function __construct(string $target, ?string $alias = null) diff --git a/application/Espo/ORM/Query/Part/Order.php b/application/Espo/ORM/Query/Part/Order.php index 45dae11795..46edef0726 100644 --- a/application/Espo/ORM/Query/Part/Order.php +++ b/application/Espo/ORM/Query/Part/Order.php @@ -33,15 +33,15 @@ use RuntimeException; /** * An order item. Immutable. + * + * @immutable */ class Order { public const ASC = 'ASC'; - public const DESC = 'DESC'; private Expression $expression; - private bool $isDesc = false; private function __construct(Expression $expression) diff --git a/application/Espo/ORM/Query/Part/OrderList.php b/application/Espo/ORM/Query/Part/OrderList.php index 42e87f9fae..c451b33456 100644 --- a/application/Espo/ORM/Query/Part/OrderList.php +++ b/application/Espo/ORM/Query/Part/OrderList.php @@ -35,15 +35,13 @@ use Iterator; /** * A list of order items. * + * @immutable * @implements Iterator */ class OrderList implements Iterator { private int $position = 0; - - /** - * @var Order[] - */ + /** @var Order[] */ private array $list; /** diff --git a/application/Espo/ORM/Query/Part/Selection.php b/application/Espo/ORM/Query/Part/Selection.php index 2c983ed867..77991a3f10 100644 --- a/application/Espo/ORM/Query/Part/Selection.php +++ b/application/Espo/ORM/Query/Part/Selection.php @@ -31,11 +31,12 @@ namespace Espo\ORM\Query\Part; /** * A select item. Immutable. + * + * @immutable */ class Selection { private $expression; - private $alias = null; private function __construct(Expression $expression, ?string $alias = null) diff --git a/application/Espo/ORM/Query/Part/Where/AndGroup.php b/application/Espo/ORM/Query/Part/Where/AndGroup.php index 376e10c4ab..1f3f972037 100644 --- a/application/Espo/ORM/Query/Part/Where/AndGroup.php +++ b/application/Espo/ORM/Query/Part/Where/AndGroup.php @@ -36,6 +36,8 @@ use Espo\ORM\Query\Part\{ /** * AND-group. Immutable. + * + * @immutable */ class AndGroup implements WhereItem { diff --git a/application/Espo/ORM/Query/Part/Where/Comparison.php b/application/Espo/ORM/Query/Part/Where/Comparison.php index c3bd693a0a..4632e5223b 100644 --- a/application/Espo/ORM/Query/Part/Where/Comparison.php +++ b/application/Espo/ORM/Query/Part/Where/Comparison.php @@ -40,34 +40,24 @@ use InvalidArgumentException; /** * Compares an expression to a value or another expression. Immutable. + * + * @immutable */ class Comparison implements WhereItem { private const OPERATOR_EQUAL = '='; - private const OPERATOR_NOT_EQUAL = '!='; - private const OPERATOR_GREATER = '>'; - private const OPERATOR_GREATER_OR_EQUAL = '>='; - private const OPERATOR_LESS = '<'; - private const OPERATOR_LESS_OR_EQUAL = '<='; - private const OPERATOR_LIKE = '*'; - private const OPERATOR_NOT_LIKE = '!*'; - private const OPERATOR_IN_SUB_QUERY = '=s'; - private const OPERATOR_NOT_IN_SUB_QUERY = '!=s'; private string $rawKey; - - /** - * @var mixed - */ + /** @var mixed */ private $rawValue; /** diff --git a/application/Espo/ORM/Query/Part/Where/Not.php b/application/Espo/ORM/Query/Part/Where/Not.php index d2888c0156..1afd612c7e 100644 --- a/application/Espo/ORM/Query/Part/Where/Not.php +++ b/application/Espo/ORM/Query/Part/Where/Not.php @@ -29,18 +29,16 @@ namespace Espo\ORM\Query\Part\Where; -use Espo\ORM\Query\Part\{ - WhereItem, -}; +use Espo\ORM\Query\Part\WhereItem; /** * A NOT-operator. Immutable. + * + * @immutable */ class Not implements WhereItem { - /** - * @var array - */ + /** @var array */ private $rawValue = []; public function getRaw(): array diff --git a/application/Espo/ORM/Query/Part/Where/OrGroup.php b/application/Espo/ORM/Query/Part/Where/OrGroup.php index d4528e793b..ee88c3dfca 100644 --- a/application/Espo/ORM/Query/Part/Where/OrGroup.php +++ b/application/Espo/ORM/Query/Part/Where/OrGroup.php @@ -33,13 +33,13 @@ use Espo\ORM\Query\Part\WhereItem; /** * OR-group. Immutable. + * + * @immutable */ class OrGroup implements WhereItem { - /** - * @var array - */ + /** @var array */ private $rawValue = []; public function __construct() diff --git a/application/Espo/ORM/Query/Part/WhereClause.php b/application/Espo/ORM/Query/Part/WhereClause.php index 6865a359de..e69df7b90c 100644 --- a/application/Espo/ORM/Query/Part/WhereClause.php +++ b/application/Espo/ORM/Query/Part/WhereClause.php @@ -29,12 +29,12 @@ namespace Espo\ORM\Query\Part; -use Espo\ORM\Query\{ - Part\Where\AndGroup, -}; +use Espo\ORM\Query\Part\Where\AndGroup; /** * A where-clause. Immutable. + * + * @immutable */ class WhereClause extends AndGroup { diff --git a/application/Espo/ORM/Query/Part/WhereItem.php b/application/Espo/ORM/Query/Part/WhereItem.php index 6dc34075c9..75c9ab1924 100644 --- a/application/Espo/ORM/Query/Part/WhereItem.php +++ b/application/Espo/ORM/Query/Part/WhereItem.php @@ -30,7 +30,7 @@ namespace Espo\ORM\Query\Part; /** - * Can used as a where-clause. + * Can be used as a where-clause. */ interface WhereItem { diff --git a/application/Espo/ORM/Query/Select.php b/application/Espo/ORM/Query/Select.php index c997e13866..d5e130bfbc 100644 --- a/application/Espo/ORM/Query/Select.php +++ b/application/Espo/ORM/Query/Select.php @@ -39,6 +39,8 @@ use RuntimeException; /** * Select parameters. * + * @immutable + * * @todo Add validation and normalization. */ class Select implements SelectingQuery @@ -47,7 +49,6 @@ class Select implements SelectingQuery use BaseTrait; public const ORDER_ASC = Order::ASC; - public const ORDER_DESC = Order::DESC; /** diff --git a/application/Espo/ORM/Query/Union.php b/application/Espo/ORM/Query/Union.php index de7e6ed130..50f585705a 100644 --- a/application/Espo/ORM/Query/Union.php +++ b/application/Espo/ORM/Query/Union.php @@ -33,6 +33,8 @@ use RuntimeException; /** * Union parameters. + * + * @immutable */ class Union implements SelectingQuery { diff --git a/application/Espo/ORM/Query/Update.php b/application/Espo/ORM/Query/Update.php index 47e5376617..c32f02b9bf 100644 --- a/application/Espo/ORM/Query/Update.php +++ b/application/Espo/ORM/Query/Update.php @@ -33,6 +33,8 @@ use RuntimeException; /** * Update parameters. + * + * @immutable */ class Update implements Query {