35 Commits

Author SHA1 Message Date
f3db4e8041 20250728 1.2.2
[-] Удалён интерфейс IStoredAtSQL (перемещён в пакет php_db_components_pack.

[+] Добавлен класс шифрования Encryptor.
2025-07-28 16:51:22 +03:00
d217322a35 20250727 1.2.1
[*] В GUID.php константа GUID_EMPTY_STRING переименована в GUID_EMPTY.

[*] В классе GUID метод isInvalidOrEmpty переименован в IsInvalidOrEmpty.

[*] В классе ClassMapper в функцию SetParameterToClass добавлен "перевод" строки в класс GUID.
2025-07-27 14:59:19 +03:00
24bf2a009f 20250724 1.2
[+] Добавлен новый тип GUID.

[*] В класс ObjectArray добавлена реализация интерфейсов IHashable, ISortable, IComparable.

[*] В класс Dictionary добавлена реализация интерфейсов IArrayable, IHashable, ISortable, IComparable.

[-] Класс GUIDExtension и все его методы помечены как устаревшие и скоро будут удалены.
2025-07-24 13:02:04 +03:00
f8f14244d0 20250723 1.2 Бета 2 2025-07-23 17:18:28 +03:00
04f6849ff4 20250721 1.2 Бета 1 2025-07-21 17:51:37 +03:00
2c3ea12fc1 20250714 1.1.3 2025-07-14 16:09:49 +03:00
e342c7f41f 20250712 1.1.2 2025-07-14 10:08:33 +03:00
7e57e5cb56 20250713 1.1.1 fix 2025-07-13 12:33:09 +03:00
62762374e0 20250713 1.1.1 2025-07-13 12:23:08 +03:00
117deab9d8 20250712 1.1.1 Beta 4 2025-07-12 16:27:53 +03:00
3fbb7dc81c 20250711 1.1.1 Beta 3 2025-07-11 19:40:30 +03:00
83a76dc8e2 20250709 1.1.1 Beta 2 2025-07-10 07:37:11 +03:00
6e831e2650 20250707
Бета 1.1.1
2025-07-07 18:02:04 +03:00
52de613b0f 20250629 1.1 Stable 2025-06-29 20:29:52 +03:00
58b3b74d99 20250628 1.1 Beta 2 2025-06-28 23:22:37 +03:00
f5420ce2c0 20250628
Бета 1.1
2025-06-28 18:15:18 +03:00
e9118609b6 20250626
В класс VersionInfo добавлены статические методы MinVersion и MaxVersion.

Метод CompareWithRange обновлён с учётом новых методов
2025-06-26 21:39:26 +03:00
1290a567de 20250625
* Добавлено перечисление VersionCompareRangeOption.
* В классе VersionInfo добавлен метод CompareWithRange.
2025-06-25 23:24:50 +03:00
df660676d0 20250624
* В класс VersionInfo добавлен метод CompareWithRange (требует улучшения)
2025-06-24 22:30:57 +03:00
3e199fc460 20250615
* Исправлена ошибка Class "GetOnly" not found.
2025-06-15 15:53:22 +03:00
a58b6f1358 20250612
* Добавлен атрибут для свойств класса #[GetOnly]. Он маркирует только те свойства, которые имеют только get часть, чтобы при маппинге класс корректно его прошёл.

* Улучшен класс ClassMapper. В его базовый метод добавлена проверка на атрибут #[GetOnly].
2025-06-14 09:53:55 +03:00
a439c0d2c9 20250612
* Добавлено перечисление стадий в информации о версии VersionInfoStage.

* Добавлен новый класс, описывающий информацию о версии, VersionInfo (подробнее см. VersionInfo.md).
2025-06-12 16:09:03 +03:00
ef0f2ff54d 20250608-1
[File] обновлён метод RemoveDir. Теперь он корректно удаляет любую директорию. Также изменился синтаксис этого метода: public static function RemoveDir (string $directory, array $errorMessages = self::REMOVE_DIRECTORY_ERROR_MESSAGES): ActionState, где $errorMessages -- массив с локализованным списком ошибок. Теперь вместо bool возвращается ActionState, куда заносятся все ошибки при удалении.
[File] добавлен метод FileSize (string $filename, array $errorLocalization = self::FILE_SIZE_ERROR_MESSAGES): ActionState, который получает размер файла
[File] добавлен метод FileSizeToString (int $fileSize, array $fileSizeUnits = self::FILE_SIZE_UNITS, string $decimalSeparator = ','): string, который преобразует размер файла в байтах в красивое строковое представление
2025-06-08 21:57:58 +03:00
28dbf773f1 20250608
[File] обновлён метод RemoveDir. Теперь он корректно удаляет не пустую директорию.
[File] добавлен метод DirectoryExists (string $directory, bool $checkReadAccess = true,
                              bool $checkWriteAccess = false): bool
2025-06-08 11:45:40 +03:00
0730509096 Merge remote-tracking branch 'origin/main'
# Conflicts:
#	sources/classes/File.php
2025-05-26 13:33:04 +03:00
e9333e8624 20250526
Добавлен класс File, который реализует функционал работы с файлами и выполнение операций над файлами одной командой.
2025-05-26 13:32:17 +03:00
71958482c5 20250526
Добавлен класс File, который реализует функционал работы с файлами и выполнение операций над файлами одной командой.
2025-05-26 13:28:46 +03:00
97f73a73e2 20250525
Добавлен новый класс Tuple, реализующий работу кортежей почти как в C#.
2025-05-25 12:45:43 +03:00
6a4df8373c 20250524
- Добавлено перечисление VarNotBoolAction, для определения действий в классе BoolExtensions (методы AnyTrue и TrueCount), если передана часть не булевого типа.

- В расширении BoolExtensions в методах AnyTrue и TrueCount убрано выброс исключение, если какой-то аргумент из массива expressions не является булевым типом. Вместо него в обоих методах введён необязательный параметр $ifNotBool (тип VarNotBoolAction), который определяет действие: игнорирование (этот аргумент просто исключается из проверки), считать правдивым (вместо него ставится true) и считать ложным (вместо него ставится false).
2025-05-24 14:31:14 +03:00
10ec8df983 20250522
* [Dictionary, ObjectArray] Исправлен баг сериализации. Теперь классы нормально восстанавливаются.
2025-05-22 22:03:39 +03:00
2d16baaef9 20250520
[Dictionary] добавлен метод AddRange (array $dictionary), который добавляет элементы в виде ассоциативного массива ключ => значение в словарь.

[Dictionary] Добавлен метод ToArray (), который возвращает все элементы словаря в виде массива..
2025-05-20 12:42:06 +03:00
2e684cb862 20250519
* [Dictionary, ObjectArray] Исправлен метод сериализации. Теперь классы нормально восстанавливаются.
2025-05-19 07:04:25 +03:00
f98a277986 Merge remote-tracking branch 'Babaev-anGit/main' 2025-05-16 23:35:54 +03:00
5b83b096e5 20250516
* [Dictionary] Добавлен метод Keys (): array, который возвращает все ключи словаря.
* [Dictionary] Добавлен метод Sort (bool $descending = false): void, который сортирует внутренние данные по ключам (в обратном порядке, если выбран $descending = true).
2025-05-16 23:35:48 +03:00
b011d3930c 20250516
* [Dictionary] Добавлен метод Keys (): array, который возвращает все ключи словаря.
* [Dictionary] Добавлен метод Sort (bool $descending = false): void, который сортирует внутренние данные по ключам (в обратном порядке, если выбран $descending = true).
2025-05-16 23:34:24 +03:00
69 changed files with 6356 additions and 170 deletions

7
.gitignore vendored
View File

@@ -78,4 +78,9 @@ fabric.properties
.idea/caches/build_file_checksums.ser .idea/caches/build_file_checksums.ser
.idea/ .idea/
vendor/ vendor/
/tests/extensions/class.txt
/tests/classesserialized1.txt
/tests/classesserialized2.txt
/tests/classesserialized3.txt
/tests/classesserialized4.txt

View File

@@ -17,10 +17,11 @@
], ],
"require": { "require": {
"php": "^8.4", "php": "^8.4",
"ext-mbstring": "*" "ext-mbstring": "*",
"ext-openssl": "*"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "^12.1.5" "phpunit/phpunit": "^12.2.7"
}, },
"autoload": { "autoload": {
"psr-4": { "psr-4": {

116
composer.lock generated
View File

@@ -4,21 +4,21 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically" "This file is @generated automatically"
], ],
"content-hash": "8024da85d3650f107ba3254f5dfc3b79", "content-hash": "45c3c2e33a7aa403660825318375a599",
"packages": [], "packages": [],
"packages-dev": [ "packages-dev": [
{ {
"name": "myclabs/deep-copy", "name": "myclabs/deep-copy",
"version": "1.13.1", "version": "1.13.3",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/myclabs/DeepCopy.git", "url": "https://github.com/myclabs/DeepCopy.git",
"reference": "1720ddd719e16cf0db4eb1c6eca108031636d46c" "reference": "faed855a7b5f4d4637717c2b3863e277116beb36"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/1720ddd719e16cf0db4eb1c6eca108031636d46c", "url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/faed855a7b5f4d4637717c2b3863e277116beb36",
"reference": "1720ddd719e16cf0db4eb1c6eca108031636d46c", "reference": "faed855a7b5f4d4637717c2b3863e277116beb36",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@@ -57,7 +57,7 @@
], ],
"support": { "support": {
"issues": "https://github.com/myclabs/DeepCopy/issues", "issues": "https://github.com/myclabs/DeepCopy/issues",
"source": "https://github.com/myclabs/DeepCopy/tree/1.13.1" "source": "https://github.com/myclabs/DeepCopy/tree/1.13.3"
}, },
"funding": [ "funding": [
{ {
@@ -65,20 +65,20 @@
"type": "tidelift" "type": "tidelift"
} }
], ],
"time": "2025-04-29T12:36:36+00:00" "time": "2025-07-05T12:25:42+00:00"
}, },
{ {
"name": "nikic/php-parser", "name": "nikic/php-parser",
"version": "v5.4.0", "version": "v5.5.0",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/nikic/PHP-Parser.git", "url": "https://github.com/nikic/PHP-Parser.git",
"reference": "447a020a1f875a434d62f2a401f53b82a396e494" "reference": "ae59794362fe85e051a58ad36b289443f57be7a9"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/447a020a1f875a434d62f2a401f53b82a396e494", "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/ae59794362fe85e051a58ad36b289443f57be7a9",
"reference": "447a020a1f875a434d62f2a401f53b82a396e494", "reference": "ae59794362fe85e051a58ad36b289443f57be7a9",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@@ -121,9 +121,9 @@
], ],
"support": { "support": {
"issues": "https://github.com/nikic/PHP-Parser/issues", "issues": "https://github.com/nikic/PHP-Parser/issues",
"source": "https://github.com/nikic/PHP-Parser/tree/v5.4.0" "source": "https://github.com/nikic/PHP-Parser/tree/v5.5.0"
}, },
"time": "2024-12-30T11:07:19+00:00" "time": "2025-05-31T08:24:38+00:00"
}, },
{ {
"name": "phar-io/manifest", "name": "phar-io/manifest",
@@ -245,16 +245,16 @@
}, },
{ {
"name": "phpunit/php-code-coverage", "name": "phpunit/php-code-coverage",
"version": "12.2.1", "version": "12.3.1",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/sebastianbergmann/php-code-coverage.git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git",
"reference": "448f2c504d86dbff3949dcd02c95aa85db2c7617" "reference": "ddec29dfc128eba9c204389960f2063f3b7fa170"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/448f2c504d86dbff3949dcd02c95aa85db2c7617", "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/ddec29dfc128eba9c204389960f2063f3b7fa170",
"reference": "448f2c504d86dbff3949dcd02c95aa85db2c7617", "reference": "ddec29dfc128eba9c204389960f2063f3b7fa170",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@@ -281,7 +281,7 @@
"type": "library", "type": "library",
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-main": "12.2.x-dev" "dev-main": "12.3.x-dev"
} }
}, },
"autoload": { "autoload": {
@@ -310,7 +310,7 @@
"support": { "support": {
"issues": "https://github.com/sebastianbergmann/php-code-coverage/issues", "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues",
"security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy", "security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy",
"source": "https://github.com/sebastianbergmann/php-code-coverage/tree/12.2.1" "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/12.3.1"
}, },
"funding": [ "funding": [
{ {
@@ -330,7 +330,7 @@
"type": "tidelift" "type": "tidelift"
} }
], ],
"time": "2025-05-04T05:25:05+00:00" "time": "2025-06-18T08:58:13+00:00"
}, },
{ {
"name": "phpunit/php-file-iterator", "name": "phpunit/php-file-iterator",
@@ -579,16 +579,16 @@
}, },
{ {
"name": "phpunit/phpunit", "name": "phpunit/phpunit",
"version": "12.1.4", "version": "12.2.7",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/sebastianbergmann/phpunit.git", "url": "https://github.com/sebastianbergmann/phpunit.git",
"reference": "5ee57ad690bda2c487594577600931a99053436c" "reference": "8b1348b254e5959acaf1539c6bd790515fb49414"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/5ee57ad690bda2c487594577600931a99053436c", "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/8b1348b254e5959acaf1539c6bd790515fb49414",
"reference": "5ee57ad690bda2c487594577600931a99053436c", "reference": "8b1348b254e5959acaf1539c6bd790515fb49414",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@@ -598,19 +598,19 @@
"ext-mbstring": "*", "ext-mbstring": "*",
"ext-xml": "*", "ext-xml": "*",
"ext-xmlwriter": "*", "ext-xmlwriter": "*",
"myclabs/deep-copy": "^1.13.1", "myclabs/deep-copy": "^1.13.3",
"phar-io/manifest": "^2.0.4", "phar-io/manifest": "^2.0.4",
"phar-io/version": "^3.2.1", "phar-io/version": "^3.2.1",
"php": ">=8.3", "php": ">=8.3",
"phpunit/php-code-coverage": "^12.1.2", "phpunit/php-code-coverage": "^12.3.1",
"phpunit/php-file-iterator": "^6.0.0", "phpunit/php-file-iterator": "^6.0.0",
"phpunit/php-invoker": "^6.0.0", "phpunit/php-invoker": "^6.0.0",
"phpunit/php-text-template": "^5.0.0", "phpunit/php-text-template": "^5.0.0",
"phpunit/php-timer": "^8.0.0", "phpunit/php-timer": "^8.0.0",
"sebastian/cli-parser": "^4.0.0", "sebastian/cli-parser": "^4.0.0",
"sebastian/comparator": "^7.0.1", "sebastian/comparator": "^7.1.0",
"sebastian/diff": "^7.0.0", "sebastian/diff": "^7.0.0",
"sebastian/environment": "^8.0.0", "sebastian/environment": "^8.0.2",
"sebastian/exporter": "^7.0.0", "sebastian/exporter": "^7.0.0",
"sebastian/global-state": "^8.0.0", "sebastian/global-state": "^8.0.0",
"sebastian/object-enumerator": "^7.0.0", "sebastian/object-enumerator": "^7.0.0",
@@ -624,7 +624,7 @@
"type": "library", "type": "library",
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-main": "12.1-dev" "dev-main": "12.2-dev"
} }
}, },
"autoload": { "autoload": {
@@ -656,7 +656,7 @@
"support": { "support": {
"issues": "https://github.com/sebastianbergmann/phpunit/issues", "issues": "https://github.com/sebastianbergmann/phpunit/issues",
"security": "https://github.com/sebastianbergmann/phpunit/security/policy", "security": "https://github.com/sebastianbergmann/phpunit/security/policy",
"source": "https://github.com/sebastianbergmann/phpunit/tree/12.1.4" "source": "https://github.com/sebastianbergmann/phpunit/tree/12.2.7"
}, },
"funding": [ "funding": [
{ {
@@ -680,7 +680,7 @@
"type": "tidelift" "type": "tidelift"
} }
], ],
"time": "2025-05-02T07:01:56+00:00" "time": "2025-07-11T04:11:13+00:00"
}, },
{ {
"name": "sebastian/cli-parser", "name": "sebastian/cli-parser",
@@ -741,16 +741,16 @@
}, },
{ {
"name": "sebastian/comparator", "name": "sebastian/comparator",
"version": "7.0.1", "version": "7.1.0",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/sebastianbergmann/comparator.git", "url": "https://github.com/sebastianbergmann/comparator.git",
"reference": "b478f34614f934e0291598d0c08cbaba9644bee5" "reference": "03d905327dccc0851c9a08d6a979dfc683826b6f"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/b478f34614f934e0291598d0c08cbaba9644bee5", "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/03d905327dccc0851c9a08d6a979dfc683826b6f",
"reference": "b478f34614f934e0291598d0c08cbaba9644bee5", "reference": "03d905327dccc0851c9a08d6a979dfc683826b6f",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@@ -761,7 +761,7 @@
"sebastian/exporter": "^7.0" "sebastian/exporter": "^7.0"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "^12.0" "phpunit/phpunit": "^12.2"
}, },
"suggest": { "suggest": {
"ext-bcmath": "For comparing BcMath\\Number objects" "ext-bcmath": "For comparing BcMath\\Number objects"
@@ -769,7 +769,7 @@
"type": "library", "type": "library",
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-main": "7.0-dev" "dev-main": "7.1-dev"
} }
}, },
"autoload": { "autoload": {
@@ -809,15 +809,27 @@
"support": { "support": {
"issues": "https://github.com/sebastianbergmann/comparator/issues", "issues": "https://github.com/sebastianbergmann/comparator/issues",
"security": "https://github.com/sebastianbergmann/comparator/security/policy", "security": "https://github.com/sebastianbergmann/comparator/security/policy",
"source": "https://github.com/sebastianbergmann/comparator/tree/7.0.1" "source": "https://github.com/sebastianbergmann/comparator/tree/7.1.0"
}, },
"funding": [ "funding": [
{ {
"url": "https://github.com/sebastianbergmann", "url": "https://github.com/sebastianbergmann",
"type": "github" "type": "github"
},
{
"url": "https://liberapay.com/sebastianbergmann",
"type": "liberapay"
},
{
"url": "https://thanks.dev/u/gh/sebastianbergmann",
"type": "thanks_dev"
},
{
"url": "https://tidelift.com/funding/github/packagist/sebastian/comparator",
"type": "tidelift"
} }
], ],
"time": "2025-03-07T07:00:32+00:00" "time": "2025-06-17T07:41:58+00:00"
}, },
{ {
"name": "sebastian/complexity", "name": "sebastian/complexity",
@@ -946,16 +958,16 @@
}, },
{ {
"name": "sebastian/environment", "name": "sebastian/environment",
"version": "8.0.0", "version": "8.0.2",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/sebastianbergmann/environment.git", "url": "https://github.com/sebastianbergmann/environment.git",
"reference": "8afe311eca49171bf95405cc0078be9a3821f9f2" "reference": "d364b9e5d0d3b18a2573351a1786fbf96b7e0792"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/8afe311eca49171bf95405cc0078be9a3821f9f2", "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/d364b9e5d0d3b18a2573351a1786fbf96b7e0792",
"reference": "8afe311eca49171bf95405cc0078be9a3821f9f2", "reference": "d364b9e5d0d3b18a2573351a1786fbf96b7e0792",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@@ -998,15 +1010,27 @@
"support": { "support": {
"issues": "https://github.com/sebastianbergmann/environment/issues", "issues": "https://github.com/sebastianbergmann/environment/issues",
"security": "https://github.com/sebastianbergmann/environment/security/policy", "security": "https://github.com/sebastianbergmann/environment/security/policy",
"source": "https://github.com/sebastianbergmann/environment/tree/8.0.0" "source": "https://github.com/sebastianbergmann/environment/tree/8.0.2"
}, },
"funding": [ "funding": [
{ {
"url": "https://github.com/sebastianbergmann", "url": "https://github.com/sebastianbergmann",
"type": "github" "type": "github"
},
{
"url": "https://liberapay.com/sebastianbergmann",
"type": "liberapay"
},
{
"url": "https://thanks.dev/u/gh/sebastianbergmann",
"type": "thanks_dev"
},
{
"url": "https://tidelift.com/funding/github/packagist/sebastian/environment",
"type": "tidelift"
} }
], ],
"time": "2025-02-07T04:56:08+00:00" "time": "2025-05-21T15:05:44+00:00"
}, },
{ {
"name": "sebastian/exporter", "name": "sebastian/exporter",
@@ -1609,4 +1633,4 @@
}, },
"platform-dev": {}, "platform-dev": {},
"plugin-api-version": "2.6.0" "plugin-api-version": "2.6.0"
} }

View File

@@ -0,0 +1,29 @@
<?php
/**
* Отключаю несущественные инспекции (из-за Attribute)
*
* @noinspection PhpMultipleClassDeclarationsInspection
*/
namespace goodboyalex\php_components_pack\attributes;
use Attribute;
/**
* Атрибут указания, что параметр является параметром только для чтения и не подлежит маппингу.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.0.25
*/
#[Attribute(flags: Attribute::TARGET_PROPERTY)]
final readonly class GetOnly
{
/**
* Конструктор
*/
public function __construct ()
{
}
}

View File

@@ -8,7 +8,7 @@
namespace goodboyalex\php_components_pack\classes; namespace goodboyalex\php_components_pack\classes;
use goodboyalex\php_components_pack\interfaces\ISerializable; use goodboyalex\php_components_pack\interfaces\ISerializable;
use goodboyalex\php_components_pack\models\ActionStateMessageModel; use goodboyalex\php_components_pack\models\ActionStateMessage;
use goodboyalex\php_components_pack\traits\ActionState\ActionStateAddTrait; use goodboyalex\php_components_pack\traits\ActionState\ActionStateAddTrait;
use goodboyalex\php_components_pack\traits\ActionState\ActionStateGetTrait; use goodboyalex\php_components_pack\traits\ActionState\ActionStateGetTrait;
use goodboyalex\php_components_pack\traits\ActionState\ActionStateHasTrait; use goodboyalex\php_components_pack\traits\ActionState\ActionStateHasTrait;
@@ -103,7 +103,7 @@ final class ActionState implements ISerializable
// Для каждого сообщения // Для каждого сообщения
foreach ($list as $messageSerialized) { foreach ($list as $messageSerialized) {
// - создаю новое сообщение // - создаю новое сообщение
$message = new ActionStateMessageModel(); $message = new ActionStateMessage();
// - десериализую его // - десериализую его
$message->UnSerialize($messageSerialized); $message->UnSerialize($messageSerialized);
// - добавляю в список // - добавляю в список

View File

@@ -5,8 +5,11 @@ namespace goodboyalex\php_components_pack\classes;
use DateTimeImmutable; use DateTimeImmutable;
use DateTimeInterface; use DateTimeInterface;
use Exception; use Exception;
use goodboyalex\php_components_pack\attributes\GetOnly;
use goodboyalex\php_components_pack\types\GUID;
use ReflectionClass; use ReflectionClass;
use ReflectionException; use ReflectionException;
use ReflectionProperty;
use stdClass; use stdClass;
use UnitEnum; use UnitEnum;
@@ -15,7 +18,7 @@ use UnitEnum;
* *
* @author Александр Бабаев * @author Александр Бабаев
* @package php_components_pack * @package php_components_pack
* @version 1.0 * @version 1.0.1
* @since 1.0 * @since 1.0
*/ */
final class ClassMapper final class ClassMapper
@@ -59,6 +62,11 @@ final class ClassMapper
// -- пропускаю // -- пропускаю
continue; continue;
// - если свойство маркируется как GetOnly
if (self::HasGetOnlyAttributes($from, $name))
// -- пропускаю
continue;
// - если свойство не разрешено // - если свойство не разрешено
if (count($options['allowed']) > 0 && !in_array($name, $options['allowed'])) if (count($options['allowed']) > 0 && !in_array($name, $options['allowed']))
// -- пропускаю // -- пропускаю
@@ -71,6 +79,32 @@ final class ClassMapper
} }
} }
/**
* Проверяет, есть ли у свойства класса $class атрибуты GetOnly.
*
* @param object $class Объект класса.
* @param string $propertyName Имя свойства.
*
* @return bool true если у свойства есть атрибут GetOnly, иначе false.
*/
private static function HasGetOnlyAttributes (object $class, string $propertyName): bool
{
// Создаем отражение свойства класса
try {
$reflectionProperty = new ReflectionProperty(get_class($class), $propertyName);
}
catch (ReflectionException) {
// - возвращаю false, если произошла ошибка создания отражения свойства класса
return false;
}
// Получаем список атрибутов у данного свойства
$attributes = $reflectionProperty->getAttributes(GetOnly::class);
// Возвращаем true, если атрибут найден, иначе false
return !empty($attributes);
}
/** /**
* Подготавливает значения свойств класса. * Подготавливает значения свойств класса.
* *
@@ -308,6 +342,11 @@ final class ClassMapper
*/ */
$property->setAccessible(true); $property->setAccessible(true);
// Если значение string, а требуется GUID
if (is_string($value) && $property->getType()->getName() === GUID::class)
// - то присваиваю значение GUID
$value = GUID::Parse($value, true);
// Если значение null // Если значение null
if (!is_bool($value) && ($value == null || $value == "null")) if (!is_bool($value) && ($value == null || $value == "null"))
// - то присваиваю значение по умолчанию // - то присваиваю значение по умолчанию

View File

@@ -4,8 +4,13 @@ namespace goodboyalex\php_components_pack\classes;
use ArrayAccess; use ArrayAccess;
use Countable; use Countable;
use goodboyalex\php_components_pack\interfaces\IArrayable;
use goodboyalex\php_components_pack\interfaces\IComparable;
use goodboyalex\php_components_pack\interfaces\IHashable;
use goodboyalex\php_components_pack\interfaces\ISerializable; use goodboyalex\php_components_pack\interfaces\ISerializable;
use goodboyalex\php_components_pack\interfaces\ISortable;
use goodboyalex\php_components_pack\traits\ArrayBasicTrait; use goodboyalex\php_components_pack\traits\ArrayBasicTrait;
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayComparableTrait;
use IteratorAggregate; use IteratorAggregate;
/** /**
@@ -13,10 +18,11 @@ use IteratorAggregate;
* *
* @author Александр Бабаев * @author Александр Бабаев
* @package php_components_pack * @package php_components_pack
* @version 1.0 * @version 1.0.3
* @since 1.0.14 * @since 1.0.14
*/ */
final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISerializable final class Dictionary
implements ArrayAccess, IteratorAggregate, Countable, ISerializable, IArrayable, IHashable, ISortable, IComparable
{ {
/** /**
* @var array $Container Контейнер. * @var array $Container Контейнер.
@@ -26,18 +32,8 @@ final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISe
// Реализация наследуемых интерфейсов и классов // Реализация наследуемых интерфейсов и классов
use ArrayBasicTrait; use ArrayBasicTrait;
/** // Реализация интерфейса IComparable
* Добавление элемента в словарь. use ObjectArrayComparableTrait;
*
* @param string $key Ключ.
* @param mixed $value Хранимое значение.
*
* @return void
*/
public function Add (string $key, mixed $value): void
{
$this->Container[$key] = $value;
}
/** /**
* Получение значения по ключу. * Получение значения по ключу.
@@ -80,6 +76,44 @@ final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISe
return isset($this->Container[$key]); return isset($this->Container[$key]);
} }
/**
* @inheritDoc
*/
public function count (): int
{
return count($this->Container);
}
/**
* Возвращает все ключи словаря.
*
* @return array Массив всех ключей словаря.
*/
public function Keys (): array
{
return array_keys($this->Container);
}
/**
* @inheritDoc
*/
public function ToArray (): array
{
return $this->Container;
}
/**
* @inheritDoc
*/
public function FromArray (array $array): void
{
// Очищаем словарь
$this->Clear();
// Добавляем элементы в словарь
$this->AddRange($array);
}
/** /**
* Очистка всех элементов. * Очистка всех элементов.
* *
@@ -90,11 +124,65 @@ final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISe
$this->Container = []; $this->Container = [];
} }
/**
* Добавление элементов в словарь.
*
* @param array $dictionary Ассоциативный массив вида ключ => значение, который будет добавлен в словарь.
*
* @return void
*/
public function AddRange (array $dictionary): void
{
// Для каждого элемента массива
foreach ($dictionary as $key => $value)
// - добавляем его в словарь.
$this->Add($key, $value);
}
/**
* Добавление элемента в словарь.
*
* @param string $key Ключ.
* @param mixed $value Хранимое значение.
*
* @return void
*/
public function Add (string $key, mixed $value): void
{
$this->Container[$key] = $value;
}
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function count (): int public function Hash (): string
{ {
return count($this->Container); return md5(json_encode($this->Container, JSON_UNESCAPED_UNICODE));
}
/**
* @inheritDoc
*
* @warning Свойство <code>$property</code> не используется.
*/
public function Sort (string $property = '', bool $descending = false): void
{
// Если задана сортировка по убыванию
if ($descending)
// - сортируем данные в обратном порядке
krsort($this->Container);
else
// - иначе, стандартная сортировка по ключам в порядке возрастания
ksort($this->Container);
}
/**
* @inheritDoc
*
* @warning Свойство <code>$propertyFunction</code> не используется.
*/
public function SortCallback (callable $propertyFunction, bool $descending = false): void
{
$this->Sort(descending: $descending);
} }
} }

View File

@@ -0,0 +1,60 @@
<?php
namespace goodboyalex\php_components_pack\classes;
/**
* Класс криптографической защиты.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.2.2
*/
final class Encryptor
{
/**
* Шифрует данные.
*
* @param string $string Данные для шифрования.
* @param string $key Ключ шифрования.
*
* @return string|false Шифрованные данные или false в случае ошибки.
*/
public static function Encrypt (string $string, string $key): string|false
{
// Метод шифрования
$cipher = 'aes-256-cbc';
// Длинна ненулевого вектора инициализации
$ivLen = openssl_cipher_iv_length($cipher);
// Ненулевой вектор инициализации
$iv = openssl_random_pseudo_bytes($ivLen);
// Шифрую и вывожу
return openssl_encrypt($string, $cipher, $key, iv: $iv) . ":" . base64_encode($iv);
}
/**
* Дешифрует данные.
*
* @param string $string Данные для дешифрования.
* @param string $key Ключ шифрования.
*
* @return string|false Дешифрованные данные или false в случае ошибки.
*/
public static function Decrypt (string $string, string $key): false|string
{
// Метод шифрования
$cipher = 'aes-256-cbc';
// Разделённый массив с шифрованными данными и вектором инициализации
$cryptArray = explode(':', $string);
// Ненулевой вектор инициализации
$iv = base64_decode($cryptArray[1]);
// Дешифрую и вывожу
return openssl_decrypt($cryptArray[0], $cipher, $key, iv: $iv);
}
}

351
sources/classes/File.php Normal file
View File

@@ -0,0 +1,351 @@
<?php
namespace goodboyalex\php_components_pack\classes;
use Exception;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
/**
* Класс, реализующий функционал работы с файлами и выполнение операций над файлами одной командой.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0.2
* @since 1.0.21
*/
final class File
{
/**
* @var array Массив сообщений об ошибках при удалении директории.
*/
public const array REMOVE_DIRECTORY_ERROR_MESSAGES = [
'directory_not_exist' => "Директория не существует или нет доступа на запись!",
'error_deleting_file_or_link' => 'Ошибка удаления файла или ссылки: %s!',
'error_deleting_directory' => 'Ошибка удаления каталога: %s. Код возврата: %d!',
'unhandled_error' => 'Ошибка удаления директории %s: %s!'
];
/**
* @var array Массив сообщений об ошибках при получении размера файла.
*/
public const array FILE_SIZE_ERROR_MESSAGES = [
'file_not_exist' => 'Файл не существует!',
'not_a_file' => 'Указанный путь не является файлом!',
'cannot_get_size' => 'Не удалось получить размер файла!'
];
/**
* @var array Массив локализации размеров файлов.
*/
public const array FILE_SIZE_UNITS = ['байт', 'КБ', 'МБ', 'ГБ', 'ТБ'];
/**
* Получает список файлов в директории и поддиректориях, соответствующей шаблону $pattern.
*
* @param string $dir Родительская директория
* @param string $pattern Шаблон имени файла
*
* @return false|array Список файлов или false в случае ошибки
*/
public static function FindFiles (string $dir, string $pattern = '*.php'): false|array
{
// Получаем список файлов и каталогов в текущей директории
$files = glob("$dir/$pattern");
// Если произошла ошибка
if ($files === false)
// - то возвращаем false
return false;
// Перебираем поддиректории
foreach (glob("$dir/*", GLOB_ONLYDIR | GLOB_NOSORT) as $subDir) {
// - если ошибка
if ($subDir === false)
// - то пропускаем
continue;
// - рекурсивный вызов для каждой поддиректории
$files = array_merge($files, self::FindFiles($subDir, $pattern));
}
// Возвращаем список файлов
return $files;
}
/**
* Получает имя файла без пути к нему и расширения.
*
* @param string $fileName Полное имя файла с путем к нему.
*
* @return string Имя файла без пути к нему и расширения.
*/
public static function ExtractFileNameWithoutExtension (string $fileName): string
{
// Имя файла без пути к нему
$fileNameOnly = self::ExtractFileName($fileName);
// Расширение файла
$fileExtension = self::ExtractFileExtension($fileName);
// Возвращаем имя файла без пути к нему и расширения.
return substr($fileNameOnly, 0, -strlen($fileExtension) - 1);
}
/**
* Получает имя файла без пути к нему, но с расширением.
*
* @param string $fileName Полное имя файла с путем к нему.
*
* @return string Имя файла без пути к нему, но с расширением.
*/
public static function ExtractFileName (string $fileName): string
{
return basename($fileName);
}
/**
* Получает расширение файла.
*
* @param string $fileName Имя файла с путем к нему.
*
* @return string Расширение файла.
*/
public static function ExtractFileExtension (string $fileName): string
{
return pathinfo($fileName, PATHINFO_EXTENSION);
}
/**
* Получает относительный путь к файлу, относительно заданной папки
*
* @param string $fullPath Полный путь к файлу
* @param string $basePath Вырезаемый путь (с начала)
*
* @return false|string Относительный путь к файлу
*/
public static function GetRelativePath (string $fullPath, string $basePath): false|string
{
return stripos($fullPath, $basePath) !== false ? str_replace($basePath, "", $fullPath) : false;
}
/**
* Удаляет директорию вместе со всеми файлами и поддиректориями.
*
* @param string $directory Полный путь к директории.
* @param array $errorMessages Сообщения об ошибках удаления (по умолчанию, см.
* {@link REMOVE_DIRECTORY_ERROR_MESSAGES}).
*
* @return ActionState Результат удаления.
*/
public static function RemoveDir (string $directory,
array $errorMessages = self::REMOVE_DIRECTORY_ERROR_MESSAGES): ActionState
{
// Создаю результат
$result = new ActionState(false);
try {
// Проверяем наличие директории и доступ на запись
if (!self::DirectoryExists(directory: $directory, checkWriteAccess: true)) {
// - если нет, то добавляем ошибку
$result->AddError($errorMessages['directory_not_exist']);
// - и возвращаем результат
return $result;
}
// Создаем рекурсивный итерационный объект для перебора всего дерева каталогов
$iterator = new RecursiveIteratorIterator(
new RecursiveDirectoryIterator($directory),
RecursiveIteratorIterator::CHILD_FIRST
);
// Проходим по каждому элементу (каталогам и файлам)
foreach ($iterator as $item) {
// - получаем путь к файлу
$realPath = $item->getRealPath();
// - если это файл или ссылка
if ($item->isFile() || $item->isLink())
// -- то удаляем его
if (!@unlink($realPath)) {
// --- если не удалось удалить, то добавляем ошибку
$result->AddError(sprintf($errorMessages['error_deleting_file_or_link'], $realPath));
// --- и возвращаем результат
return $result;
}
}
// Определение текущей операционной системы
$os = strtolower(PHP_OS_FAMILY);
// Экранируем аргумент для предотвращения инъекций
$escapedDirectory = escapeshellarg($directory);
// Дальнейшие действия зависят от операционной системы
switch ($os) {
// - для Windows
case 'windows':
// -- выполняем команду Windows
exec("rd /s /q $escapedDirectory", $output, $returnCode);
break;
// - для Linux/macOS
default:
// -- выполняем команду Linux/macOS
exec("rm -rf $escapedDirectory", $output, $returnCode);
break;
}
// Проверяем код возврата
if ($returnCode !== 0) {
// - если не удалось удалить, то добавляем ошибку
$result->AddError(sprintf($errorMessages['error_deleting_directory'], $directory, $returnCode));
// --- и возвращаем результат
return $result;
}
// Если все прошло успешно (а если мы сюда попали, то все должно быть хорошо), то добавляем результат true
$result->Value = true;
// - и возвращаем его
return $result;
}
catch (Exception $exception) {
// Если произошла ошибка, то добавляем ошибку
$result->AddError(sprintf($errorMessages['unhandled_error'], $directory, $exception->getMessage()));
// - задаем результат false
$result->Value = false;
// - и возвращаем его
return $result;
}
}
/**
* Проверяет, существует ли директория.
*
* @param string $directory Путь к директории.
* @param bool $checkReadAccess Проверять ли доступ на чтение директории (по умолчанию true).
* @param bool $checkWriteAccess Проверять ли доступ на запись директории (по умолчанию false).
*
* @return bool Результат проверки.
*/
public static function DirectoryExists (string $directory, bool $checkReadAccess = true,
bool $checkWriteAccess = false): bool
{
// Очищаем кэш
clearstatcache();
// Проверяем, существует ли директория
if (!file_exists($directory))
// - если нет, то возвращаем false
return false;
// Проверяем, является ли директория директорией, а не файлом
if (!is_dir($directory))
// - если нет, то возвращаем false
return false;
// Проверяем, есть ли доступ на чтение директории
if ($checkReadAccess && !is_readable($directory))
// - если нет, то возвращаем false
return false;
// Проверяем, есть ли доступ на запись директории
if ($checkWriteAccess && !is_writable($directory))
// - если нет, то возвращаем false
return false;
// Если все проверки пройдены успешно, то возвращаем true
return true;
}
/**
* Получает размер файла в байтах.
*
* @param string $filename Имя файла.
* @param array $errorLocalization Массив сообщений об ошибках при получении размера файла (по умолчанию, см.
* {@link FILE_SIZE_ERROR_MESSAGES}).
*
* @return ActionState Результат с размером файла в байтах.
*/
public static function FileSize (string $filename,
array $errorLocalization = self::FILE_SIZE_ERROR_MESSAGES): ActionState
{
// Очищаем кэш
clearstatcache();
// Создаём результат
$result = new ActionState(-1);
// Проверяем, существует ли файл
if (!file_exists($filename)) {
// - если нет, то добавляем ошибку
$result->AddError($errorLocalization['file_not_exist']);
// - и возвращаем результат
return $result;
}
// Проверяем, является ли $filename файлом
if (!is_file($filename)) {
// - если нет, то добавляем ошибку
$result->AddError($errorLocalization['not_a_file']);
// - и возвращаем результат
return $result;
}
// Получаем размер файла
$size = filesize($filename);
// Проверяем, получилось ли получить размер файла
if ($size === false) {
// - если нет, то добавляем ошибку
$result->AddError($errorLocalization['cannot_get_size']);
// - и возвращаем результат
return $result;
}
// Устанавливаем значение результата
$result->Value = $size;
// Возвращаем результат
return $result;
}
/**
* Преобразует размер файла в байтах в красивое строковое представление.
*
* @param int $fileSize Размер файла в байтах.
* @param array $fileSizeUnits Локализованные единицы измерения размера файла (по умолчанию, см.
* {@link FILE_SIZE_UNITS}).
* @param string $decimalSeparator Разделитель десятичной части (по умолчанию, запятая).
*
* @return string Размер файла в красивом строковом представлении. Например, если размер файла составляет 1500
* байт, вывод будет «1.46 КБ».
*/
public static function FileSizeToString (int $fileSize, array $fileSizeUnits = self::FILE_SIZE_UNITS,
string $decimalSeparator = ','): string
{
/**
* Вычисление степени для преобразования: берём минимум из 4 и результата округления до ближайшего целого числа
* в меньшую сторону логарифма размера файла в байтах по основанию 1024 (это показывает, сколько раз нужно
* разделить размер файла на 1024, чтобы получить значение в более крупных единицах измерения). Ограничение в 4
* необходимо для того, чтобы соответствовать единице измерения ТБ (терабайт).
*/
$power = min(4, floor(log($fileSize, 1024)));
/**
* Преобразование размера файла: размер файла делим на 1024 в степени, равной степени $power,
* затем округляем полученное до 2 цифр после запятой.
*/
$size = number_format(round($fileSize / pow(1024, $power), 2), 2, $decimalSeparator);
// Возвращаем преобразованное значение вместе с единицей измерения
return "$size $fileSizeUnits[$power]";
}
}

View File

@@ -0,0 +1,710 @@
# Описание класса JsonReWriter
## Информация о версии
Версия класса: 1.0
Впервые введено в пакет с версии: 1.1.0
Описание класса: Класс для работы с JSON-файлами.
## Публичные свойства и константы класса
В классе определены следующие свойства:
- `string $JsonString` - строка JSON (чтение/запись).
## Быстрый старт
### Правила формирования ключей.
Ключ для чтения/записи данных класса формируется следующим образом: `ключ/подключ/подключ подключа` .
Например, если дан json-файл:
{
"test": {
"subtest": {
"AAA": "123",
"BBB": 1.23
}
},
"test1": {
"test": 123
},
"test2": {
"test": true
},
"test3": {
"test": {
"res": "[1,2,3]"
}
}
}
Пусть требуется получить значение `BBB`, тогда ключ должен быть `test/subtest/BBB`.
### Чтение.
1. Создайте элемент класса `$json = new JsonReWriter ();`
2. Если у вас требуется загрузить json из файла `$fileName`, то воспользуйтесь методом `LoadFromFile`:
`$json->LoadFromFile($fileName);`, если же json представлен строкой `$jsonStr`, то загрузите её в свойство
`$JsonString`: `$json->JsonString = $jsonStr;`
3. Далее можно пользоваться любым методом для чтения `Read*`, в том числе и общим `$json->Read(...)`.
**Пример:**
// Имя файла
$fileName = __DIR__ . "/test.json";
// Создаю класс
$json = new JsonReWriter();
// Загшружаю данные из файла
$json->LoadFromFile($fileName);
// Получаю число
$float = $json->ReadFloat("test/subtest/BBB", 0.2);
В итоге в `$float` будет `1.23`.
### Запись.
1. Создайте элемент класса `$json = new JsonReWriter ();`
2. Далее можно пользоваться любым методом для записи `Write*`, в том числе и общим `$json->Write(...)`.
3. Если вам требуется создать json файл с именем `$fileName`, то воспользуйтесь методом `SaveToFile`:
`$json->SaveToFile($fileName);`, если же json должен быть представлен строкой `$jsonStr`, то загрузите её из свойства
`$JsonString`: `$jsonStr = $json->JsonString;`
**Пример:**
// Имя файла
$fileName = __DIR__ . "/test.json";
// Создаю класс
$json = new JsonReWriter();
// Загшружаю данные из файла
$json->LoadFromFile($fileName);
// Получаю число
try {
$json->Write("test/subtest/BBB", 0.2);
}
catch (JsonException $e) {
echo $e->getMessage();
}
В итоге в `test/subtest/BBB` вместо `1.23` будет `0.2`.
## Коды ошибок JsonErrorCode
Ниже представлена таблица основных кодов ошибки:
| Ошибка | Описание | Введено с версии |
|:-------------------:|:---------------------------------------------------------------------------:|:----------------:|
| Unknown | Неизвестная ошибка | 1.0 |
| None | Ошибок нет | 1.0 |
| Depth | Достигнута максимальная глубина стека | 1.0 |
| StateMismatch | Неверный или некорректный JSON | 1.0 |
| CTRLChar | Ошибка управляющего символа, возможно, неверная кодировка | 1.0 |
| Syntax | Синтаксическая ошибка | 1.0 |
| UTF8 | Некорректные для кодировки UTF-8 символы, возможно, неверная кодировка | 1.0 |
| Recursion | Одна или несколько зацикленных ссылок в кодируемом значении | 1.0 |
| InfOrNan | Одно или несколько значений NAN или INF в кодируемом значении | 1.0 |
| UnsupportedType | Передали значение с неподдерживаемым типом | 1.0 |
| InvalidPropertyName | Имя свойства не может быть закодировано | 1.0 |
| UTF16 | Некорректный для кодировки UTF-16 символ, возможно, некорректно закодирован | 1.0 |
| KeyIsNotArray | Ключ не содержит вложений, хотя от него требуется обратное | 1.0 |
| NotISerializable | Класс не реализует интерфейс ISerializable | 1.0 |
### Методы и функции перечисления JsonErrorCode
Перечисление содержит **статический метод** `static function FromLastError (): JsonErrorCode`, который получает код
ошибки из последней JSON ошибки.
Например, при успешной загрузке, можем проверить ошибки:
$errors = JsonErrorCode::FromLastError ();
После того, как мы выведем `$errors`, мы получим `JsonErrorCode::None`.
## Исключение JsonException
Исключение расширяет класс `Exception`, поэтому может выбрасываться через `throw`.
### Свойства
Исключение содержит следующие свойства:
- `?string $JsonString` - строка JSON (или null);
- `JsonErrorCode $ErrorCode` - код ошибки JSON;
- `?string $ErrorMessage` - сообщение об ошибке JSON (в отличие от функции json_last_error_msg(), данная переменная при
отсутствии ошибок выводит null, а не "No error").
### Методы и функции
#### Конструктор.
Конструктор принимает **3 необязательных параметра**:
* `?string $json` - строка JSON (по умолчанию, `null`);
* `JsonErrorCode $errorCode` - код ошибки (по умолчанию, `JsonErrorCode::Unknown`);
* `?string $errorMessage` - сообщение об ошибке (по умолчанию, `null`).
В результате создаётся новое исключение `JsonException`.
Пример:
throw new JsonException("{}", JsonErrorCode::Depth, "Пример");
Создаст исключение `JsonException`.
## Методы и функции
### Конструктор и деструктор.
Конструктор не принимает никаких параметров.
В результате создаётся новый класс `JsonReWriter`.
**Пример:**
// Контсуктор
$json = new JsonReWriter ();
// Деструктор
unset($json);
Создаст и уничтожит класс `JsonReWriter`.
### Сохранение и загрузка из файла.
За сохранение и загрузку отвечают 2 метода: `SaveToFile` и `LoadFromFile`.
#### Сохранение в файл (метод `SaveToFile`)
Этот метод сохраняет содержимое JSON в файл. Он содержит **1 обязательный параметр**:
* `string $fileName` - имя файла на диске.
Метод возвращает `bool` - сохранены ли данные в файл: `true` - да, `false` - нет.
Синтаксис:
public function SaveToFile (string $fileName): bool
**Пример:**
// Имя файла
$fileName = __DIR__ . "/test.json";
// Создаём класс
$json = new JsonReWriter();
// Заполним данными
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->WriteArray("test3/test/res", [1, 2, 3]);
} catch (JsonException $e) {
echo $e->getMessage();
}
// Сохраняем созданный JSON файл
$json->SaveToFile($fileName);
Содержимое файла `test.json` представлено далее:
{
"test": {
"subtest": {
"AAA": "123",
"BBB": 1.23
}
},
"test1": {
"test": 123
},
"test2": {
"test": true
},
"test3": {
"test": {
"res": "[1,2,3]"
}
}
}
#### Загрузка файла (метод `LoadFromFile`)
Этот метод загружает содержимое файла в класс. Он содержит **1 обязательный параметр**:
* `string $fileName` - имя файла на диске.
Метод возвращает `bool` - загружены ли данные из файла: `true` - да, `false` - нет.
Синтаксис:
public function LoadFromFile (string $fileName): bool
**Пример:**
Пусть дан файл `test.json`, содержимое которого представлено далее:
{
"test": {
"subtest": {
"AAA": "123",
"BBB": 1.23
}
},
"test1": {
"test": 123
},
"test2": {
"test": true
},
"test3": {
"test": {
"res": "[1,2,3]"
}
}
}
Следующий код загрузит это содержимое в класс:
// Имя файла
$fileName = __DIR__ . "/test.json";
// Создаём класс
$json = new JsonReWriter();
// Загружаю данные
$json->LoadFromFile($fileName);
### Чтение данных
Для чтения данных используется один общий метод `Read` и 7 его производных метода: `ReadString`, `ReadInt`, `ReadFloat`,
`ReadBool`, `ReadArray`, `ReadObject` и `ReadSerializable`.
#### Метод `Read`
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
необязательный параметр** `mixed $default` (значение по умолчанию, задан по умолчанию в `null`).
Этот метод возвращает `mixed`: значение ключа JSON или значение по умолчанию.
Синтаксис:
public function Read (string $key, mixed $default = null): mixed
**Пример,**
// Создаю класс
$json = new JsonReWriter();
// Заполняю данными
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->Write("test3/test/res", json_encode([1, 2, 3]));
} catch (JsonException $e) {
echo $e->getMessage();
}
// Получаю значение
$float = (float)$json->Read("test/subtest/BBB"));
В результате, переменная `$float` будет иметь значение `1.23`.
#### Метод `ReadString`
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
необязательный параметр** `string $default` (значение по умолчанию, задан по умолчанию в `""`).
Этот метод возвращает `string`: значение ключа JSON или значение по умолчанию.
Синтаксис:
public function ReadString (string $key, string $default = ""): string
#### Метод `ReadInt`
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
необязательный параметр** `int $default` (значение по умолчанию, задан по умолчанию в `0`).
Этот метод возвращает `int`: значение ключа JSON или значение по умолчанию.
Синтаксис:
public function ReadInt (string $key, int $default = 0): int
#### Метод `ReadFloat`
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
необязательный параметр** `float $default` (значение по умолчанию, задан по умолчанию в `0.0`).
Этот метод возвращает `float`: значение ключа JSON или значение по умолчанию.
Синтаксис:
public function ReadFloat (string $key, float $default = 0.0): float
#### Метод `ReadBool`
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
необязательный параметр** `bool $default` (значение по умолчанию, задан по умолчанию в `false`).
Этот метод возвращает `bool`: значение ключа JSON или значение по умолчанию.
Синтаксис:
public function ReadBool (string $key, bool $default = false): bool
#### Метод `ReadArray`
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
необязательный параметр** `array $default` (значение по умолчанию, задан по умолчанию в `[]`).
Этот метод возвращает `array`: значение ключа JSON или значение по умолчанию.
Синтаксис:
public function ReadArray (string $key, array $default = []): array
#### Метод `ReadObject`
Это метод, который читает значение ключа JSON. Он имеет **2 обязательных параметра**:
- `string $key` (ключ);
- `object $default` (значение по умолчанию).
Этот метод возвращает `object`: значение ключа JSON или значение по умолчанию.
Синтаксис:
public function ReadObject (string $key, object $default): object
#### Метод `ReadSerializable`
Это метод, который читает значение ключа JSON. Он имеет **2 обязательных параметра**:
- `string $key` (ключ);
- `string $serializableClassName` (имя класса, реализующего интерфейс ISerializable, с namespace).
Этот метод возвращает класс, реализующий интерфейс `ISerializable`.
**Важно!** Этот метод может выбросить исключение `JsonException`, если класс, заданный в `$serializableClassName` не
реализует интерфейс `ISerializable`.
Синтаксис:
public function ReadSerializable (string $key, string $serializableClassName): ISerializable
**Пример,**
Пусть для примера, класс `Demo` из namespace `iam\namespace` реализует интерфейс `ISerializable`.
// Создаю класс
$json = new JsonReWriter();
// ... Здесь где-то загрузка данных
// Получаю класс
try {
/**
* @var Demo $unSerializableClass
*/
$unSerializableClass = $json->ReadSerializable("test", "iam\\namespace\\Demo");
} catch (JsonException $e) {
echo $e->getMessage();
}
В результате, переменная `$unSerializableClass` будет содержать данные класса `Demo`.
### Запись данных
Для чтения данных используется один общий метод `Write` и 3 его производных метода: `WriteArray`, `WriteObject` и
`WriteSerializable`.
**Важно!** Лобой из вышеуказанных методов может выбросить исключение `JsonException`, если ключ не содержит вложений,
хотя от него требуется обратное.
#### Метод `Write`
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
- `string $key` (ключ);
- `mixed $value` (записываемое значение).
Этот метод ничего не возвращает.
Синтаксис:
public function Write (string $key, mixed $value): void
**Пример,**
// Имя файла
$fileName = __DIR__ . "/test.json";
// Создаём класс
$json = new JsonReWriter();
// Заполним данными
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->WriteArray("test3/test/res", [1, 2, 3]);
} catch (JsonException $e) {
echo $e->getMessage();
}
// Сохраняем созданный JSON файл
$json->SaveToFile($fileName);
Содержимое файла `test.json` представлено далее:
{
"test": {
"subtest": {
"AAA": "123",
"BBB": 1.23
}
},
"test1": {
"test": 123
},
"test2": {
"test": true
},
"test3": {
"test": {
"res": "[1,2,3]"
}
}
}
#### Метод `WriteArray`
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
- `string $key` (ключ);
- `array $array` (записываемое значение).
Этот метод ничего не возвращает.
Синтаксис:
public function WriteArray (string $key, array $array): void
#### Метод `WriteObject`
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
- `string $key` (ключ);
- `object $value` (записываемое значение).
Этот метод ничего не возвращает.
Синтаксис:
public function WriteObject (string $key, object $value): void
#### Метод `WriteSerializable`
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
- `string $key` (ключ);
- `ISerializable $serializableValue` (записываемое значение).
Этот метод ничего не возвращает.
Синтаксис:
public function WriteSerializable (string $key, ISerializable $serializableValue): void
**Пример,**
Пусть для примера, класс `Demo` из namespace `iam\namespace` реализует интерфейс `ISerializable`.
// Имя файла
$fileName = __DIR__ . "/test.json";
// Создаём класс
$json = new JsonReWriter();
// Создаём класс Demo
$serializableClass = new Demo(...);
// Заполним данными
try {
$json->WriteSerializable("test", $serializableClass);
} catch (JsonException $e) {
echo $e->getMessage();
}
...
### Работа с ключами JSON
Для работы с ключами JSON есть 2 метода: `IsKeyExists` и `GetKeys`.
#### Метод `IsKeyExists`
Это метод проверяем наличие ключа в JSON. Он имеет **1 обязательный параметр** - `string $key` (ключ).
Этот метод возвращает `bool`: `true` если ключ найден и `false` в противном случае.
Синтаксис:
public function IsKeyExists (string $key): bool
**Пример,**
// Создаём класс
$json = new JsonReWriter();
// Заполним данными
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->WriteArray("test3/test/res", [1, 2, 3]);
} catch (JsonException $e) {
echo $e->getMessage();
}
// Проверяем ключи
$check1 = $json->IsKeyExists("test/subtest/AAA");
$check2 = $json->IsKeyExists("test/subtest/ССС");
В результате, `$check1` будет `true`, а `$check2` - `false`.
#### Метод `GetKeys`
Это метод получает список ключей. Он имеет **2 необязательных параметра**:
- `string $parentKey` (ключ родителя (или "" (установлено по умолчанию) для всех);
- `bool $includeChildren` (нужно ли включать дочерние ключи (по умолчанию, да)).
Этот метод возвращает `array`: список ключей.
Синтаксис:
public function GetKeys (string $parentKey = "", bool $includeChildren = true): array
**Пример,**
// Создаём класс
$json = new JsonReWriter();
// Заполним данными
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->WriteArray("test3/test/res", [1, 2, 3]);
} catch (JsonException $e) {
echo $e->getMessage();
}
// Получаем ключи
$keys1 = $json->GetKeys("test");
$keys2 = $json->GetKeys("test", false);
$keys3 = $json->GetKeys();
В результате, `$key1` будет следующим массивом:
[
"test/subtest",
"test/subtest/AAA",
"test/subtest/BBB"
]
`$key2` будет следующим массивом:
[
"subtest"
]
`$key3` будет следующим массивом:
[
"test",
"test/subtest",
"test/subtest/AAA",
"test/subtest/BBB",
"test1",
"test1/test",
"test2",
"test2/test",
"test3",
"test3/test",
"test3/test/res"
]
### Удаление ключей JSON
Для удаления ключей JSON есть 2 метода: `DeleteKey`, который удаляет только определённый ключ и `Clear`, который удаляет
**все ключи** из json-файла.
#### Метод `DeleteKey`
Это метод удаляет только определённый ключ в JSON. Он имеет **1 обязательный параметр** - `string $key` (ключ).
Этот метод возвращает `bool` - результат удаления ключа: `true` - удаление прошло успешно, `false` - произошла ошибка
при удалении.
Синтаксис:
public function DeleteKey (string $key): bool
**Пример,**
// Создаём класс
$json = new JsonReWriter();
// Заполним данными
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->WriteArray("test3/test/res", [1, 2, 3]);
} catch (JsonException $e) {
echo $e->getMessage();
}
// Получаемем ключи до удаления
$check1 = $json->GetKeys("test/subtest");
// Удаляем ключ
$this->DeleteKey("test/subtest/BBB");
// Получаемем ключи после удаления
$check2 = $json->GetKeys("test/subtest");
В результате, `$check1` будет
[
"test/subtest",
"test/subtest/AAA",
"test/subtest/BBB"
]
а `$check2`:
[
"test/subtest",
"test/subtest/AAA"
]
#### Метод `Clear`
Это метод удаляет **все ключи** из json-файла. Он не имеет никаких параметров и ничего не возвращает.
Синтаксис:
public function Clear (): void
**Пример,**
// Создаём класс
$json = new JsonReWriter();
// Заполним данными
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->WriteArray("test3/test/res", [1, 2, 3]);
} catch (JsonException $e) {
echo $e->getMessage();
}
// Очищаем
$json->Clear();
// Получаем ключи
$keys = $json->GetKeys();
В результате, `$key` будет следующим массивом:
[
]

View File

@@ -0,0 +1,90 @@
<?php
namespace goodboyalex\php_components_pack\classes;
use goodboyalex\php_components_pack\enums\JsonErrorCode;
use goodboyalex\php_components_pack\exceptions\JsonException;
use goodboyalex\php_components_pack\traits\JsonReWriter\JsonReWriterDeleteTrait;
use goodboyalex\php_components_pack\traits\JsonReWriter\JsonReWriterKeyTrait;
use goodboyalex\php_components_pack\traits\JsonReWriter\JsonReWriterLoadSaveTrait;
use goodboyalex\php_components_pack\traits\JsonReWriter\JsonReWriterReadTrait;
use goodboyalex\php_components_pack\traits\JsonReWriter\JsonReWriterWriteTrait;
/**
* Класс для работы с JSON-файлами.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.0
*/
final class JsonReWriter
{
/**
* @var string $JsonString Строка JSON.
*/
public string $JsonString {
get {
// Проверка на пустоту
if (count($this->JsonData) === 0)
// - если массив пуст, возвращаем пустой JSON
return '{}';
// Преобразую данные в JSON
$json = json_encode($this->JsonData, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
// Проверка на ошибки
if (json_last_error() !== JSON_ERROR_NONE)
// - если есть ошибки, выбрасываем исключение
throw new JsonException(null, JsonErrorCode::FromLastError(), json_last_error_msg());
// Возвращаем JSON
return $json;
}
set {
// Чтение содержимого файла и преобразование JSON в объект
$this->JsonData = json_decode($value, true);
// Проверка на ошибки
if ($this->JsonData === null && json_last_error() !== JSON_ERROR_NONE)
// - если есть ошибки, выбрасываем исключение
throw new JsonException($value, JsonErrorCode::FromLastError(), json_last_error_msg());
}
}
/**
* @var array $JsonData Массив данных.
*/
private array $JsonData;
/**
* Конструктор класса.
*/
public function __construct ()
{
$this->JsonData = [];
}
/**
* Деструктор класса.
*/
public function __destruct ()
{
unset($this->JsonData);
}
// Подключаем методы чтения JSON
use JsonReWriterReadTrait;
// Подключаем методы записи JSON
use JsonReWriterWriteTrait;
// Подключаем методы сохранения и загрузки JSON
use JsonReWriterLoadSaveTrait;
// Подключаем методы работы с ключами
use JsonReWriterKeyTrait;
// Подключаем методы удаления данных из JSON
use JsonReWriterDeleteTrait;
}

View File

@@ -4,12 +4,20 @@ namespace goodboyalex\php_components_pack\classes;
use ArrayAccess; use ArrayAccess;
use Countable; use Countable;
use goodboyalex\php_components_pack\interfaces\IArrayable;
use goodboyalex\php_components_pack\interfaces\IComparable;
use goodboyalex\php_components_pack\interfaces\IHashable;
use goodboyalex\php_components_pack\interfaces\ISerializable; use goodboyalex\php_components_pack\interfaces\ISerializable;
use goodboyalex\php_components_pack\interfaces\ISortable;
use goodboyalex\php_components_pack\traits\ArrayBasicTrait; use goodboyalex\php_components_pack\traits\ArrayBasicTrait;
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayComparableTrait;
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayConstantsTrait; use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayConstantsTrait;
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayHashableTrait;
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayLINQTrait; use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayLINQTrait;
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySearchAndSortTrait; use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySearchAndSortTrait;
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySerializeExTrait;
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySpecialTrait; use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySpecialTrait;
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayToArrayTrait;
use IteratorAggregate; use IteratorAggregate;
/** /**
@@ -17,10 +25,11 @@ use IteratorAggregate;
* *
* @author Александр Бабаев * @author Александр Бабаев
* @package php_components_pack * @package php_components_pack
* @version 1.0 * @version 1.1
* @since 1.0 * @since 1.0
*/ */
final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, ISerializable final class ObjectArray
implements ArrayAccess, IteratorAggregate, Countable, ISerializable, IArrayable, IHashable, ISortable, IComparable
{ {
/** /**
* @var array $Container Массив объектов, хранящихся в данном классе. * @var array $Container Массив объектов, хранящихся в данном классе.
@@ -42,6 +51,18 @@ final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, IS
// Специальные методы // Специальные методы
use ObjectArraySpecialTrait; use ObjectArraySpecialTrait;
// Расширенные методы для сериализации
use ObjectArraySerializeExTrait;
// Реализация методов интерфейса IArrayable
use ObjectArrayToArrayTrait;
// Реализация методов интерфейса IHashable
use ObjectArrayHashableTrait;
// Реализация методов интерфейса IComparable
use ObjectArrayComparableTrait;
/** /**
* Конструктор класса. * Конструктор класса.
* *

121
sources/classes/Tuple.php Normal file
View File

@@ -0,0 +1,121 @@
<?php
namespace goodboyalex\php_components_pack\classes;
use ArrayAccess;
use ArrayIterator;
use Countable;
use Exception;
use goodboyalex\php_components_pack\interfaces\ISerializable;
use IteratorAggregate;
use Traversable;
/**
* Класс, реализующий функционал кортежей от C#.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.2
* @since 1.0.20
*/
final class Tuple implements ISerializable, ArrayAccess, IteratorAggregate, Countable
{
/**
* @var array Массив значений кортежа.
*/
private array $Values;
/**
* Конструктор кортежа.
*
* @param mixed ...$values Значения кортежа.
*/
public function __construct (...$values)
{
$this->Values = $values;
}
/**
* @inheritDoc
*/
public function Serialize (): string
{
return serialize($this->Values);
}
/**
* @inheritDoc
*/
public function UnSerialize (string $serialized): void
{
$this->Values = unserialize($serialized);
}
/**
* @inheritDoc
*/
public function offsetExists (mixed $offset): bool
{
return isset($this->Values[$offset]);
}
/**
* @inheritDoc
*/
public function offsetGet (mixed $offset): mixed
{
// Если ключ не является целым числом
if (!is_int($offset))
// - возвращаем null
return null;
// Возвращаем значение кортежа по индексу
return $this->Get($offset);
}
/**
* Возвращает значение кортежа по индексу.
*
* @param int $index Индекс значения.
*
* @return mixed Значение кортежа по индексу.
*/
public function Get (int $index): mixed
{
return $this->Values[$index] ?? null;
}
/**
* @inheritDoc
* @throws Exception Элементы кортежа не могут быть изменены после создания! / Tuple elements cannot be changed
* after creation!
*/
public function offsetSet (mixed $offset, mixed $value): void
{
throw new Exception('Элементы кортежа не могут быть изменены после создания! / Tuple elements cannot be changed after creation!');
}
/**
* @inheritDoc
*/
public function offsetUnset (mixed $offset): void
{
unset($this->Values[$offset]);
}
/**
* @inheritDoc
*/
public function getIterator (): Traversable
{
return new ArrayIterator($this->Values);
}
/**
* @inheritDoc
*/
public function count (): int
{
return count($this->Values);
}
}

View File

@@ -0,0 +1,419 @@
# Описание класса VersionInfo
## Информация о версии
Версия класса: 1.2
Впервые введено в пакет с версии: 1.0.24
Последнее обновление в версии: 1.0.27
Описание класса: Класс, описывающий информацию о версии.
## Публичные свойства и константы класса
В классе определены следующие константы:
* `array StagesNames` - имена стадий сборки.
* `string DefaultTemplate` - шаблон вывода по умолчанию.
В классе определены следующе свойства:
* `int $Major` - мажорная версия (**только чтение**).
* `int $Minor` - минорная версия (**только чтение**).
* `int $Release` - номер релиза (**только чтение**).
* `int $Build` - номер сборки (**только чтение**).
* `VersionInfoStage $Stage` - стадия сборки (**только чтение**).
* `int $StageNumber` - номер стадии сборки (**только чтение**).
## Методы и функции
### Конструктор.
Конструктор принимает **4 обязательных** и **2 дополнительных параметра**:
* `int $Major` - мажорная версия (**обязательный**);
* `int $Minor` - минорная версия (**обязательный**);
* `int $Release` - номер релиза (**обязательный**);
* `int $Build` - номер сборки (**обязательный**);
* `VersionInfoStage` $Stage - стадия сборки (по умолчанию, `VersionInfoStage::Undefined`);
* `int $StageNumber` - номер стадии сборки (по умолчанию, `0`).
В результате создаётся новый класс `VersionInfo`.
Пример:
$version = new VersionInfo (1, 0, 0, 0, VersionInfoStage::Beta, 1);
Создаст класс `VersionInfo` для версии `1.0.0.0 Beta 1`.
### Преобразование в строку.
За преобразование в строку отвечает 2 метода: `ToString` и `__toString ()`.
#### Метод `ToString`
Этот метод возвращает строковое представление версии. Он содержит **2 необязательных параметра**:
* `string $template` - шаблон вывода (по умолчанию, `DefaultTemplate`);
* `array $stagesNames` - имена стадий сборки (по умолчанию, `StagesNames`).
Метод возвращает `string` - строковое представление версии.
В шаблоне должны присутствовать маркеры:
| Маркер | Описание | Обязательный |
|:--------------:|:--------------------|:------------:|
| #{Major} | Мажорная версия | ДА |
| #{Minor} | Минорная версия | ДА |
| #{Release} | Номер релиза | ДА |
| #{Build} | Номер сборки | ДА |
| #{Stage} | Стадия сборки | НЕТ |
| #{StageNumber} | Номер стадии сборки | НЕТ |
Эти маркеры в шаблоне заменяются на значения соответствующих свойств.
Синтаксис:
public function ToString (string $template, array $stagesNames): string
Пример,
// Создаю объект
$version = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
// Задаю шаблон
$template = #{Major}.#{Minor}.#{Release} (сборка #{Build});
// Вывожу
echo $version->ToString($template);
В результате на экране появится:
1.2.3 (сборка 4)
#### Метод `__toString`
Этот метод полностью аналогичен методу `ToString` с той лишь разницей, что в этом методе невозможно задать параметры
вывода (такие, как шаблон и имена стадий). Эти параметры берутся по умолчанию.
Этот метод необходим для вывода корректной информации при попытке привести объект класса `VersionInfo` к типу `string`.
Метод возвращает `string` - строковое представление версии.
Синтаксис:
public function __toString (): string
Пример,
// Создаю объект
$version = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
// Вывожу
echo $version;
В результате на экране появится:
1.2.3.4 Beta 5
### Сравнение версий
Для сравнения версий используется две аналогичные друг другу (но различающиеся по способу вызова) функции: `Compare` и
`CompareWith`.
#### Метод `Compare`
Это статический метод, который сравнивает две версии, заданные в **2 обязательных параметрах**:
* `VersionInfo $version1` - версия 1;
* `VersionInfo $version2` - версия 2.
Этот метод возвращает `int`:
| version1 | version2 | Результат |
|:---------:|:---------:|:---------:|
| Младше | Старше | -1 |
| Совпадает | Совпадает | 0 |
| Старше | Младше | 1 |
Синтаксис:
public static function Compare (VersionInfo $version1, VersionInfo $version2): int
Пример,
// Создаю объекты
// - $version11 младше $version12
$version11 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
$version12 = new VersionInfo (1, 2, 3, 5, VersionInfoStage::Beta, 6);
// $version21 совпадает с $version22
$version21 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
$version22 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
// $version31 старше $version32
$version31 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Stable);
$version32 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
// Сравниваю
$verCompare1 = VersionInfo::Compare($version11, $version12);
$verCompare2 = VersionInfo::Compare($version21, $version22);
$verCompare3 = VersionInfo::Compare($version31, $version32);
// Вывожу
echo $verCompare1 . '|' . $verCompare2 . '|' . $verCompare3;
В результате на экране появится:
-1|0|1
#### Метод `CompareWith`
Этот метод полностью аналогичен методу `Compare`. Он отличается лишь только тем, что **не статичен** и вызывается из
ранее созданного экземпляра класса. Он сравнивает текущую версию с переданной. Этот метод имеет только **1 обязательный
параметр**: `VersionInfo $version` - переданная версия.
Этот метод возвращает `int`: `1`, если текущая версия старше переданной, `0`, если совпадает и `-1`, если текущая версия
младше переданной.
Синтаксис:
public function CompareWith (VersionInfo $version): int
Пример,
// Создаю объекты
// - $version11 младше $version12
$version11 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
$version12 = new VersionInfo (1, 2, 3, 5, VersionInfoStage::Beta, 6);
// $version21 совпадает с $version22
$version21 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
$version22 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
// $version31 старше $version32
$version31 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Stable);
$version32 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
// Сравниваю
$verCompare1 = $version11->CompareWith($version12);
$verCompare2 = $version21->CompareWith($version22);
$verCompare3 = $version31->CompareWith($version32);
// Вывожу
echo $verCompare1 . '|' . $verCompare2 . '|' . $verCompare3;
В результате на экране появится:
-1|0|1
#### Метод `CompareWithRange`
Введено в версии `1.0.27`.
Это метод, который проверяет, находится ли текущая версия в заданном диапазоне, указанном в **2 необязательных
параметрах**:
* `VersionInfo (или null) $left` - левая граница, по умолчанию, `null`;
* `VersionInfo (или null) $right` - правая граница, по умолчанию, `null`.
В случае, если будет передан `null` вместо левой границы, то метод создаст класс `VersionInfo` с минимально возможной
версией `0.0.0.0 PreAlpha 0`, а вместо правой - `VersionInfo` с максимально возможной версией
`9223372036854775807.9223372036854775807.9223372036854775807.9223372036854775807 Stable` (здесь `9223372036854775807` -
максимальное число INT по умолчанию - у вас может быть другое).
Границы могут совпадать, тогда поведение будет совпадать с методом `CompareWith` (при условии, что границы включены).
Кроме того, работает защита "от дурака" и если границы перепутаны, то метод автоматически поменяет их местами.
**3-й необязательный параметр** отвечает за параметры сравнения. Это `ObjectArray` из перечисления
`VersionCompareRangeOption`, который может содержать следующие настройки:
| Настройка | Описание | Включена по умолчанию |
|:-------------------:|:-------------------------------------:|:---------------------:|
| LeftBorderIncluded | Включена ли левая граница в диапазон | ДА |
| RightBorderIncluded | Включена ли правая граница в диапазон | ДА |
Этот метод возвращает `int`:
| Текущая версия | Результат |
|:---------------------------------:|:---------:|
| Младше диапазона | -1 |
| Внутри диапазона (или на границе) | 0 |
| Старше диапазона | 1 |
Синтаксис:
public function CompareWithRange (?VersionInfo $left = null, ?VersionInfo $right = null, ?ObjectArray $options = null): int
Пример,
// Создаю объекты
// - 1.2.3.4 Beta 1
$versionInfo1 = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
// - 1.1.3.4 Alpha 2
$versionInfo2 = new VersionInfo(1, 1, 3, 4, VersionInfoStage::Alpha, 2);
// - 1.1.1.1 Alpha 2
$versionInfo3 = new VersionInfo(1, 1, 1, 1, VersionInfoStage::Alpha, 2);
// - 5.5.5.5 Stable
$versionInfo4 = new VersionInfo(5, 5, 5, 5, VersionInfoStage::Stable);
// Сравниваю
echo "Для начала простое сравнение: ";
$ver1d1 = $versionInfo1->CompareWithRange($versionInfo3, $versionInfo4);
$ver1d2 = $versionInfo2->CompareWithRange($versionInfo1, $versionInfo4);
$ver1d2 = $versionInfo4->CompareWithRange($versionInfo2, $versionInfo1);
echo "$ver1d1|$ver1d2|$ver1d3 \r\n"
echo "Немного перепутаем границы =) ";
$ver2d1 = $versionInfo4->CompareWithRange($versionInfo1, $versionInfo2);
echo "И получим: $ver2d1\r\n";
echo "А теперь с границами!\r\n";
echo "- значение равно левой границе: ";
$ver3d1 = $versionInfo2->CompareWithRange($versionInfo2, $versionInfo1);
echo " $ver3d1\r\n";
echo "- значение равно правой границе: ";
$ver3d2 = $versionInfo1->CompareWithRange($versionInfo2, $versionInfo1);
echo " $ver3d2\r\n";
echo "- а теперь с выключением границ:\r\n";
echo "-- для левой: ";
$ver3d3 = $versionInfo2->CompareWithRange($versionInfo2, $versionInfo1, $optionNotBorder);
echo " $ver3d3\r\n";
echo "-- для правой: ";
$ver3d4 = $versionInfo1->CompareWithRange($versionInfo2, $versionInfo1, $optionNotBorder);
echo " $ver3d4\r\n";
echo "А что если границы равны и значение равно?\r\n";
echo "- для включённых границ: ";
$ver4d1 = $versionInfo1->CompareWithRange($versionInfo1, $versionInfo1);
echo " $ver4d1\r\n";
echo "- для выключённых границ: ";
$ver4d2 = $versionInfo1->CompareWithRange($versionInfo1, $versionInfo1, $optionNotBorder);
echo " $ver4d2";
В результате на экране появится:
Для начала простое сравнение: 0|-1|1
Немного перепутаем границы =) И получим: 1
А теперь с границами!
- значение равно левой границе: 0
- значение равно правой границе: 0
- а теперь с выключением границ:
-- для левой: -1
-- для правой: 1
А что если границы равны и значение равно?
- для включённых границ: 0
- для выключённых границ: -1
### Парсинг версий
Для преобразования строки с версией в объект `VersionInfo` используется статичный метод `Parse`.
Он требует **1 обязательный параметр** и **1 необязательный**:
* `string $version` - строка с версией (она должна быть в формате
`#{Major}.#{Minor}.#{Release}.#{Build} #{Stage} #{StageNumber}`, причём `#{Stage}` и `#{StageNumber}` можно не
указывать);
* `array $stagesNames` - имена стадий сборки (по умолчанию, `StagesNames`).
Этот метод возвращает объект {@link VersionInfo} с данными о версии или `new VersionInfo(0, 0, 0, 0)` в случае ошибки.
Синтаксис:
public static function Parse (string $version, array $stagesNames = self::StagesNames): VersionInfo
Пример,
// Создаю текст
$verText = '1.2.3.4 Beta 2';
// Преобразую
$version = VersionInfo::Parse($verText);
// Вывожу
echo $version;
В результате на экране появится:
1.2.3.4 Beta 2
### Вспомогательные методы
#### Метод `IsNotUndefinedOrStable`
Этот **статический** метод проверяет, является ли версия в неопределённой стадии или уже релизом.
Он имеет только **1 обязательный параметр**: `VersionInfoStage $versionStage` - стадия сборки.
Этот метод возвращает `bool`: `true`, если стадия сборки определена и не является релизом и `false` в противном случае.
Синтаксис:
public static function IsNotUndefinedOrStable (VersionInfoStage $versionStage): bool
Пример,
// Создаю объекты
$version1 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Undefined, 5);
$version2 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
$version3 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Stable);
// Сравниваю
$res1 = VersionInfo::IsNotUndefinedOrStabl($version1->Stage);
$res2 = VersionInfo::IsNotUndefinedOrStabl($version2->Stage);
$res3 = VersionInfo::IsNotUndefinedOrStabl($version3->Stage);
// Вывожу
echo $res1 . '|' . $res2 . '|' . $res3;
В результате на экране появится:
false|true|false
#### Метод `MinVersion`
Введено в версии `1.0.28`.
Этот **статический** метод **без параметров** возвращает минимальную версию (объект класса `VersionInfo`).
Синтаксис:
public static function MinVersion (): VersionInfo
Пример,
// Создаю объекты
$version = VersionInfo::MinVersion();
// Вывожу
echo $version;
В результате на экране появится:
0.0.0.0 PreAlpha 0
#### Метод `MaxVersion`
Введено в версии `1.0.28`.
Этот **статический** метод **без параметров** возвращает максимальную версию (объект класса `VersionInfo`).
Синтаксис:
public static function MaxVersion (): VersionInfo
Пример,
// Создаю объекты
$version = VersionInfo::MaxVersion();
// В этом примере считается, что константа PHP_INT_MAX равна 9223372036854775807
// Вывожу
echo $version;
В результате на экране появится:
9223372036854775807.9223372036854775807.9223372036854775807.9223372036854775807

View File

@@ -0,0 +1,391 @@
<?php
namespace goodboyalex\php_components_pack\classes;
use goodboyalex\php_components_pack\enums\VersionCompareRangeOption;
use goodboyalex\php_components_pack\enums\VersionInfoStage;
use goodboyalex\php_components_pack\extensions\StringExtension;
/**
* Класс, описывающий информацию о версии.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.2
* @since 1.0.24
*/
final class VersionInfo
{
/**
* @var array $StagesNames Имена стадий сборки.
*/
public const array StagesNames = [
VersionInfoStage::PreAlpha->value => 'PreAlpha',
VersionInfoStage::Alpha->value => 'Alpha',
VersionInfoStage::Beta->value => 'Beta',
VersionInfoStage::ReleaseCandidate->value => 'rc',
VersionInfoStage::Stable->value => 'Stable'
];
/**
* @var string $DefaultTemplate Шаблон вывода по умолчанию.
*/
public const string DefaultTemplate = '#{Major}.#{Minor}.#{Release}.#{Build} #{Stage} #{StageNumber}';
/**
* @var int $Major Мажорная версия.
*/
private(set) int $Major = 0;
/**
* @var int $Minor Минорная версия.
*/
private(set) int $Minor = 0;
/**
* @var int $Release Номер релиза.
*/
private(set) int $Release = 0;
/**
* @var int $Build Номер сборки.
*/
private(set) int $Build = 0;
/**
* @var VersionInfoStage $Stage Стадия сборки.
*/
private(set) VersionInfoStage $Stage = VersionInfoStage::Undefined;
/**
* @var int $StageNumber Номер стадии сборки.
*/
private(set) int $StageNumber = 0;
/**
* Конструктор.
*
* @param int $Major Мажорная версия.
* @param int $Minor Минорная версия.
* @param int $Release Номер релиза.
* @param int $Build Номер сборки.
* @param VersionInfoStage $Stage Стадия сборки.
* @param int $StageNumber Номер стадии сборки.
*/
public function __construct (int $Major, int $Minor, int $Release, int $Build,
VersionInfoStage $Stage = VersionInfoStage::Undefined, int $StageNumber = 0)
{
$this->Major = $Major;
$this->Minor = $Minor;
$this->Release = $Release;
$this->Build = $Build;
$this->Stage = $Stage;
$this->StageNumber = $StageNumber;
}
/**
* Сравнивает две версии.
*
* @param VersionInfo $version1 Версия 1.
* @param VersionInfo $version2 Версия 2.
*
* @return int Возвращает 1, если версия 1 больше версии 2, 0, если равны, -1, если версия 1 меньше версии 2.
*/
public static function Compare (VersionInfo $version1, VersionInfo $version2): int
{
return $version1->CompareWith($version2);
}
/**
* Сравнивает текущую версию с переданной.
*
* @param VersionInfo $version Переданная версия.
*
* @return int Возвращает 1, если текущая версия больше переданной, 0, если равны, -1, если текущая версия меньше
* переданной.
*/
public function CompareWith (VersionInfo $version): int
{
// Задаем шаблон вывода
$toStringTemplate = '#{Major}.#{Minor}.#{Release}.#{Build}';
// Сначала сравним числа (мажорную, минорную версии, номер релиза и сборки):
$compareResult = version_compare(
$this->ToString($toStringTemplate),
$version->ToString($toStringTemplate)
);
// Если численные части совпадают, проверяем стадии сборки
if ($compareResult === 0) {
// - особый случай: стабильная версия всегда больше любых промежуточных стадий
if ($this->Stage === VersionInfoStage::Stable && self::IsNotUndefinedOrStable($version->Stage))
// - считаем нашу старшей
return 1;
// - особый случай: если наша версия не stable, а другая stable
if ($version->Stage === VersionInfoStage::Stable && self::IsNotUndefinedOrStable($this->Stage))
// - считаем нашу младшей
return -1;
// - преобразуем стадии в целые числа для прямого сравнения
$currentStageValue = $this->Stage->ToInt();
$otherStageValue = $version->Stage->ToInt();
// - если стадии отличаются
if ($currentStageValue !== $otherStageValue)
// - сравниваем их
return $currentStageValue <=> $otherStageValue;
// - если стадии одинаковые
if (self::IsNotUndefinedOrStable($this->Stage) && self::IsNotUndefinedOrStable($version->Stage)
&& $this->StageNumber !== $version->StageNumber)
return $this->StageNumber <=> $version->StageNumber;
// - если все совпадает, то вернём 0
return 0;
}
// Возврат результата сравнения
return $compareResult;
}
/**
* Возвращает строковое представление версии.
*
* @param string $template Шаблон вывода. В шаблоне маркеры #{Major}, #{Minor}, #{Release}, #{Build}, #{Stage} и
* #{StageNumber} заменяются на значения соответствующих свойств. По умолчанию используется
* {@link DefaultTemplate}.
* @param array $stagesNames Имена стадий сборки (по умолчанию из константы {@link StagesNames}).
*
* @return string Строковое представление версии.
*/
public function ToString (string $template = self::DefaultTemplate, array $stagesNames = self::StagesNames): string
{
// Получаем строковое представление стадии сборки
$stage = match ($this->Stage) {
// - для неопределенной стадии сборки и релиза возвращаем пустую строку
VersionInfoStage::Undefined, VersionInfoStage::Stable => '',
// - для остальных стадий сборки возвращаем строковое представление стадии сборки
VersionInfoStage::PreAlpha => $stagesNames[VersionInfoStage::PreAlpha->value],
VersionInfoStage::Alpha => $stagesNames[VersionInfoStage::Alpha->value],
VersionInfoStage::Beta => $stagesNames[VersionInfoStage::Beta->value],
VersionInfoStage::ReleaseCandidate => $stagesNames[VersionInfoStage::ReleaseCandidate->value]
};
// Возвращаем строковое представление номера стадии сборки, если конечно стадия определена и она не релиз
// и номер сборки должен быть задан (больше 0)
$stageNum = self::IsNotUndefinedOrStable($this->Stage) && $this->StageNumber > 0
? "$this->StageNumber" : '';
// Создаём массив для замены
$replaceData = [
'#{Major}' => "$this->Major",
'#{Minor}' => "$this->Minor",
'#{Release}' => "$this->Release",
'#{Build}' => "$this->Build",
'#{Stage}' => $stage,
'#{StageNumber}' => $stageNum
];
// Заменяем все в шаблоне
$result = StringExtension::ReplaceAll($replaceData, $template);
// Возвращаем результат, удаляя лишние пробелы в конце
return rtrim($result, ' ');
}
/**
* Проверяет, является ли версия неопределённой или релизом.
*
* @param VersionInfoStage $versionStage Стадия сборки.
*
* @return bool Возвращает true, если стадия сборки определена и не является релизом.
*/
public static function IsNotUndefinedOrStable (VersionInfoStage $versionStage): bool
{
return $versionStage !== VersionInfoStage::Undefined && $versionStage !== VersionInfoStage::Stable;
}
/**
* Преобразует строку с версией в объект {@link VersionInfo}.
*
* @param string $version Строка с версией (она должна быть в формате {@link DefaultTemplate}).
* @param array $stagesNames Имена стадий сборки (по умолчанию из константы {@link StagesNames}).
*
* @return VersionInfo Возвращает объект {@link VersionInfo} с данными о версии.
*/
public static function Parse (string $version, array $stagesNames = self::StagesNames): VersionInfo
{
// Убираем пробелы в начале и конце строки
$version = trim($version);
// Разбиваем строку на части по пробелам (1 часть - основная - мажор, минор, релиз, сборка,
// 2 часть - стадия и 3 - номер стадии)
$versionParts = explode(' ', $version);
// Проверяем, что строка содержит хотя бы 1 часть
if (count($versionParts) < 1)
// - если нет, то возвращаем пустую версию
return new VersionInfo(0, 0, 0, 0);
// Составим регулярное выражение для парсинга базовой информации о версии
$pattern = '/^(\d+)\.(\d+)\.(\d+)\.(\d+)/';
// Парсим базовую информацию о версии
if (!preg_match($pattern, $versionParts[0], $matches))
// - если не удалось, то возвращаем пустую версию
return new VersionInfo(0, 0, 0, 0);
// Проверяем, что найдены все 4 части
if (!$matches || count($matches) < 5)
// - если нет, то возвращаем пустую версию
return new VersionInfo(0, 0, 0, 0);
// Получаем значения
[, $major, $minor, $release, $build] = $matches;
// Парсим обязательные цифры
// - мажорная версия
$major = intval($major);
// - минорная версия
$minor = intval($minor);
// - номер релиза
$release = intval($release);
// - номер сборки
$build = intval($build);
// Если частей версии больше 1
if (count($versionParts) > 1) {
// - получаем массив для перевода строковых имен стадий в числа
$stageEnumMap = array_flip($stagesNames);
// - получаем стадию
$stage = VersionInfoStage::FromInt(intval($stageEnumMap[$versionParts[1]] ?? 0));
// - если стадия определена и не релиз, и кроме того, есть номер стадии
if (self::IsNotUndefinedOrStable($stage) && count($versionParts) > 2)
// -- получаем номер стадии
$stageNumber = intval($versionParts[2]);
else
// -- иначе, устанавливаем номер стадии 0
$stageNumber = 0;
}
else {
// - иначе, устанавливаем стадию неопределённой
$stage = VersionInfoStage::Undefined;
// - и номер стадии 0
$stageNumber = 0;
}
// Создание объекта VersionInfo
return new VersionInfo($major, $minor, $release, $build, $stage, $stageNumber);
}
/**
* Выводит строковое представление версии (упрощённая версия ToString() с шаблоном по умолчанию, необходимая для
* вывода при попытке привести объект к типу string).
*
* @return string Строковое представление версии.
*/
public function __toString (): string
{
// Получаем строковое представление версии и возвращаем его
return $this->ToString();
}
/**
* Проверяет, находится ли текущая версия в заданном диапазоне.
*
* @param VersionInfo|null $left Левая граница диапазона или null, если граница не задана (будет использована
* минимальная версия).
* @param VersionInfo|null $right Правая граница диапазона или null, если граница не задана (будет использована
* максимальная версия).
* @param ObjectArray|null $options Опции проверки (по умолчанию массив, который разрешает включать границы).
*
* @return int Возвращает 1, если текущая версия старше интервала, 0, если находится в интервале, -1, если текущая
* версия младше интервала.
*
* @version 1.1
* @since 1.0.27
*/
public function CompareWithRange (?VersionInfo $left = null, ?VersionInfo $right = null,
?ObjectArray $options = null): int
{
// Подготавливаем опции, если они не переданы
$options ??= new ObjectArray([
VersionCompareRangeOption::LeftBorderIncluded,
VersionCompareRangeOption::RightBorderIncluded
]);
// Устанавливаем левую границу
$leftBorder = $left ?? self::MinVersion();
// Устанавливаем правую границу
$rightBorder = $right ?? self::MaxVersion();
// Проверяем, что границы не перепутаны
if ($leftBorder->CompareWith($rightBorder) == 0)
// - если границы перепутаны, то меняем их местами
[$leftBorder, $rightBorder] = [$rightBorder, $leftBorder];
// Проверяем текущую версию относительно границ
$compareLeft = $this->CompareWith($leftBorder);
$compareRight = $this->CompareWith($rightBorder);
// Проверяем, что границы включены
// - левая
$leftBorderIncluded = $options->IsExist(fn (VersionCompareRangeOption $option)
=> $option === VersionCompareRangeOption::LeftBorderIncluded);
// - правая
$rightBorderIncluded = $options->IsExist(fn (VersionCompareRangeOption $option)
=> $option === VersionCompareRangeOption::RightBorderIncluded);
// Проверяем включение границ
$isInInterval =
(
($compareLeft >= 0 && $leftBorderIncluded)
|| ($compareLeft > 0)
)
&& (
($compareRight <= 0 && $rightBorderIncluded)
|| ($compareRight < 0)
);
// Итоговая обработка результатов
if ($isInInterval)
// - версия в пределах диапазона
return 0;
else // - версия не в пределах диапазона, и если она младше левой границы (или равна ей при не включении границы)
if ($compareLeft <= 0)
// -- то возвращаем -1
return -1;
else
// -- в противном случае, версия старше правой границы (или равна ей при не включении границы)
return 1;
}
/**
* Возвращает минимальную версию.
*
* @return VersionInfo Минимальная версия.
*
* @since 1.0.28
*/
public static function MinVersion (): VersionInfo
{
return new VersionInfo(0, 0, 0, 0, VersionInfoStage::PreAlpha, 0);
}
/**
* Возвращает максимальную версию.
*
* @return VersionInfo Максимальная версия.
*
* @since 1.0.28
*/
public static function MaxVersion (): VersionInfo
{
return new VersionInfo(PHP_INT_MAX, PHP_INT_MAX, PHP_INT_MAX, PHP_INT_MAX, VersionInfoStage::Stable);
}
}

View File

@@ -0,0 +1,108 @@
<?php
namespace goodboyalex\php_components_pack\enums;
use goodboyalex\php_components_pack\traits\EnumExtensionsTrait;
/**
* Перечисление известных ошибок при работе с JSON файлами.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.0
*/
enum JsonErrorCode: int
{
// Подключаю расширение для Enum
use EnumExtensionsTrait;
/**
* Неизвестная ошибка.
*/
case Unknown = -1;
/**
* Ошибок нет.
*/
case None = 0;
/**
* Достигнута максимальная глубина стека.
*/
case Depth = 1;
/**
* Неверный или некорректный JSON.
*/
case StateMismatch = 2;
/**
* Ошибка управляющего символа, возможно, неверная кодировка.
*/
case CTRLChar = 3;
/**
* Синтаксическая ошибка.
*/
case Syntax = 4;
/**
* Некорректные для кодировки UTF-8 символы, возможно, неверная кодировка.
*/
case UTF8 = 5;
/**
* Одна или несколько зацикленных ссылок в кодируемом значении.
*/
case Recursion = 6;
/**
* Одно или несколько значений NAN или INF в кодируемом значении.
*/
case InfOrNan = 7;
/**
* Передали значение с неподдерживаемым типом.
*/
case UnsupportedType = 8;
/**
* Имя свойства не может быть закодировано.
*/
case InvalidPropertyName = 9;
/**
* Некорректный для кодировки UTF-16 символ, возможно, некорректно закодирован.
*/
case UTF16 = 10;
/**
* Ключ не содержит вложений, хотя от него требуется обратное.
*/
case KeyIsNotArray = 11;
/**
* Класс не реализует интерфейс ISerializable.
*/
case NotISerializable = 12;
/**
* Получает код ошибки из последней JSON ошибки.
*
* @return JsonErrorCode Код ошибки.
*/
public static function FromLastError (): JsonErrorCode
{
// Получаю код ошибки
$error = json_last_error();
// Проверяю, что код ошибки в диапазоне [0; 10]
if ($error < 0 || $error > 10)
// - верну неизвестную ошибку, если код не в диапазоне
return self::Unknown;
// Перевожу код в Enum
return self::FromInt($error);
}
}

View File

@@ -0,0 +1,40 @@
<?php
namespace goodboyalex\php_components_pack\enums;
use goodboyalex\php_components_pack\traits\EnumExtensionsTrait;
/**
* Перечисление типов сериализации массива объектов.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.1
*/
enum ObjectArraySerializeMethod: int
{
// Подключаю расширение для Enum
use EnumExtensionsTrait;
/**
* Сериализация массива объектов с помощью serialize.
*/
case Serialize = 1;
/**
* Сериализация массива объектов с помощью json_encode.
*
* @warning Для корректной работы требуется наличие json_encode в php.ini
* @warning Этот способ сериализации НЕ РЕКОМЕНДУЕТСЯ для массивов объектов, представляющих собой классы, так как
* при десериализации классы не будут созданы: вместо этого будет созданы объекты класса stdClass. Вместо этого
* следует использовать метод JsonEncodeWithToArray.
*/
case JsonEncode = 2;
/**
* Сериализация массива объектов с помощью ToArray, который возвращает массив. Этот массив впоследствии
* сериализуется с помощью json_encode. Десерилизация происходит в обратном порядке.
*/
case JsonEncodeWithToArray = 3;
}

View File

@@ -0,0 +1,34 @@
<?php
namespace goodboyalex\php_components_pack\enums;
use goodboyalex\php_components_pack\traits\EnumExtensionsTrait;
/**
* Перечисление типов действий, которые необходимо выполнить, если переменная не является булевым типом.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.0.19
*/
enum VarNotBoolAction: int
{
// Подключаю расширение для Enum
use EnumExtensionsTrait;
/**
* Игнорировать это утверждение.
*/
case Ignore = 0;
/**
* Считать это утверждение истинным.
*/
case ConsiderItTrue = 1;
/**
* Считать это утверждение ложным.
*/
case ConsiderItFalse = 2;
}

View File

@@ -0,0 +1,29 @@
<?php
namespace goodboyalex\php_components_pack\enums;
use goodboyalex\php_components_pack\traits\EnumExtensionsTrait;
/**
* Перечисление параметров для сравнения версий на промежутке.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.0.27
*/
enum VersionCompareRangeOption: int
{
// Подключаю расширение для Enum
use EnumExtensionsTrait;
/**
* Левая граница включается в диапазон.
*/
case LeftBorderIncluded = 0;
/**
* Правая граница включается в диапазон.
*/
case RightBorderIncluded = 1;
}

View File

@@ -0,0 +1,49 @@
<?php
namespace goodboyalex\php_components_pack\enums;
use goodboyalex\php_components_pack\traits\EnumExtensionsTrait;
/**
* Перечисление стадий в информации о версии.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.0.24
*/
enum VersionInfoStage: int
{
// Подключаю расширение для Enum
use EnumExtensionsTrait;
/**
* Не определена или не задана стадия.
*/
case Undefined = 0;
/**
* Пре-алфа.
*/
case PreAlpha = 1;
/**
* Альфа.
*/
case Alpha = 2;
/**
* Бета.
*/
case Beta = 3;
/**
* Кандидат в релиз.
*/
case ReleaseCandidate = 4;
/**
* Релиз.
*/
case Stable = 5;
}

View File

@@ -0,0 +1,67 @@
<?php
namespace goodboyalex\php_components_pack\exceptions;
use Exception;
use goodboyalex\php_components_pack\enums\JsonErrorCode;
/**
* Ошибка работы с JSON.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.0
*/
final class JsonException extends Exception
{
/**
* @var string|null $JsonString Строка JSON.
*/
public ?string $JsonString;
/**
* @var JsonErrorCode $ErrorCode Код ошибки JSON.
*/
public JsonErrorCode $ErrorCode;
/**
* @link https://www.php.net/manual/ru/function.json-last-error-msg.php
* @var string|null $ErrorMessage Сообщение об ошибке JSON.
*
* Внимание! В отличие от функции json_last_error_msg(), данная переменная при отсутствии ошибок выводит null, а не
* "No error".
*/
public ?string $ErrorMessage;
/**
* Конструктор.
*
* @param string|null $json Строка JSON.
* @param JsonErrorCode $errorCode Код ошибки JSON.
* @param string|null $errorMessage Сообщение об ошибке JSON.
*/
public function __construct (?string $json = null, JsonErrorCode $errorCode = JsonErrorCode::Unknown,
?string $errorMessage = null)
{
// Если код ошибки JSON равен 0
if ($errorMessage === "No error")
// - то присваиваем ему null для совместимости
$errorMessage = null;
// Сохраняем сообщение об ошибке
$this->ErrorMessage = $errorMessage;
// Если сообщение пусто, то присваиваем ему "" для совместимости
$errorMessage = $errorMessage ?? "";
// Запускаем базовый конструктор
parent::__construct($errorMessage);
// Присваиваем имя файла
$this->JsonString = $json;
// Присваиваем код ошибки
$this->ErrorCode = $errorCode;
}
}

View File

@@ -0,0 +1,36 @@
<?php
namespace goodboyalex\php_components_pack\exceptions;
use Exception;
/**
* Ошибка работы с расширением типов.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.1
*/
final class TypeException extends Exception
{
/**
* @var string $TypeName Имя типа.
*/
public string $TypeName;
/**
* Конструктор.
*
* @param string $typeName Имя типа.
* @param string $message Сообщение об ошибке.
*/
public function __construct (string $typeName = "", string $message = "")
{
// Запускаем базовый конструктор
parent::__construct($message);
// Присваиваем тип
$this->TypeName = $typeName;
}
}

View File

@@ -2,14 +2,14 @@
namespace goodboyalex\php_components_pack\extensions; namespace goodboyalex\php_components_pack\extensions;
use Exception; use goodboyalex\php_components_pack\enums\VarNotBoolAction;
/** /**
* Расширение типа "правда/ложь". * Расширение типа "правда/ложь".
* *
* @author Александр Бабаев * @author Александр Бабаев
* @package php_components_pack * @package php_components_pack
* @version 1.0 * @version 1.1
* @since 1.0.7 * @since 1.0.7
*/ */
final class BoolExtensions final class BoolExtensions
@@ -34,38 +34,55 @@ final class BoolExtensions
* <code>true</code>. * <code>true</code>.
* *
* @param array $expressions Переменные формата правда/ложь. * @param array $expressions Переменные формата правда/ложь.
* @param VarNotBoolAction $ifNotBool Действие, если какой-то аргумент <code>expressions</code> не является булевым
* типом. По умолчанию игнорировать.
* *
* @return bool Есть ли хотя бы одно в значении true. * @return bool Есть ли хотя бы одно в значении true.
* *
* @throws Exception Выбрасывается, если хотя бы один аргумент <code>expressions</code> не являются типом
* правда/ложь.
*/ */
public static function AnyTrue (array $expressions): bool public static function AnyTrue (array $expressions, VarNotBoolAction $ifNotBool = VarNotBoolAction::Ignore): bool
{ {
return self::TrueCount($expressions) > 0; return self::TrueCount($expressions, $ifNotBool) > 0;
} }
/** /**
* Вычисляет количество переменных формата правда/ложь <code>expressions</code> в значении <code>true</code>. * Вычисляет количество переменных формата правда/ложь <code>expressions</code> в значении <code>true</code>.
* *
* @param array $expressions Переменные формата правда/ложь. * @param array $expressions Переменные формата правда/ложь.
* @param VarNotBoolAction $ifNotBool Действие, если какой-то аргумент <code>expressions</code> не является булевым
* типом. По умолчанию игнорировать.
* *
* @return int Количество переменных в значении true. * @return int Количество переменных в значении true.
*
* @throws Exception Выбрасывается, если хотя бы один аргумент <code>expressions</code> не являются типом
* правда/ложь.
*/ */
public static function TrueCount (array $expressions): int public static function TrueCount (array $expressions, VarNotBoolAction $ifNotBool = VarNotBoolAction::Ignore): int
{ {
// Проверяем все аргументы // Создаем пустой массив для хранения проверяемых аргументов
$checkArray = [];
// Проверяем все входящие аргументы
foreach ($expressions as $expression) foreach ($expressions as $expression)
// - если аргумент не является типом правда/ложь // - если аргумент не является типом правда/ложь
if (!is_bool($expression)) if (!is_bool($expression))
// -- то выбрасываем исключение // -- то делаем следующее в зависимости от настроек:
throw new Exception('All arguments must be bool. / Все аргументы должны быть типа «правда/ложь».'); switch ($ifNotBool) {
case VarNotBoolAction::Ignore:
// --- игнорируем аргумент
break;
case VarNotBoolAction::ConsiderItTrue:
// --- считаем аргумент как истинное значение
$checkArray[] = true;
break;
case VarNotBoolAction::ConsiderItFalse:
// --- считаем аргумент как ложное значение
$checkArray[] = false;
break;
}
else
// - иначе добавляем аргумент в массив проверяемых аргументов
$checkArray[] = $expression;
// Используем array_filter для фильтрации всех истинных значений // Используем array_filter для фильтрации всех истинных значений
$filtered = array_filter($expressions); $filtered = array_filter($checkArray, fn ($value) => $value === true);
// Возвращаем количество элементов в отфильтрованном массиве // Возвращаем количество элементов в отфильтрованном массиве
return count($filtered); return count($filtered);

View File

@@ -2,6 +2,7 @@
namespace goodboyalex\php_components_pack\extensions; namespace goodboyalex\php_components_pack\extensions;
use Deprecated;
use Random\RandomException; use Random\RandomException;
/** /**
@@ -11,12 +12,15 @@ use Random\RandomException;
* @package php_components_pack * @package php_components_pack
* @version 1.0 * @version 1.0
* @since 1.0 * @since 1.0
* @deprecated 1.2
*
*/ */
final class GUIDExtension final class GUIDExtension
{ {
/** /**
* Пустой Guid. * Пустой Guid.
*/ */
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
public const string GUIDEmpty = "00000000-0000-0000-0000-000000000000"; public const string GUIDEmpty = "00000000-0000-0000-0000-000000000000";
/** /**
@@ -24,6 +28,7 @@ final class GUIDExtension
* *
* @return string Сгенерированный Guid. * @return string Сгенерированный Guid.
*/ */
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
public static function Generate (): string public static function Generate (): string
{ {
// Цикл создания Guid // Цикл создания Guid
@@ -41,6 +46,7 @@ final class GUIDExtension
* *
* @return string Сгенерированный Guid. * @return string Сгенерированный Guid.
*/ */
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
private static function DoGenerate (): string private static function DoGenerate (): string
{ {
try { try {
@@ -80,6 +86,7 @@ final class GUIDExtension
* *
* @return bool Корректен ли Guid. * @return bool Корректен ли Guid.
*/ */
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
public static function Validate (?string $str): bool public static function Validate (?string $str): bool
{ {
// Если Guid пустой // Если Guid пустой
@@ -140,6 +147,7 @@ final class GUIDExtension
* *
* @return bool Пустой ли GUID * @return bool Пустой ли GUID
*/ */
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
public static function IsNotValidOrEmpty (?string $str): bool public static function IsNotValidOrEmpty (?string $str): bool
{ {
return !self::Validate($str) || $str == self::GUIDEmpty; return !self::Validate($str) || $str == self::GUIDEmpty;

View File

@@ -0,0 +1,179 @@
# Описание класса TypeExtension
## Информация о версии
Версия класса: 1.0
Впервые введено в пакет с версии: 1.1.1
Описание класса: Расширение для любого типа.
## Публичные свойства и константы класса
К публичным свойствам можно отнести следующие статичные функции: `DEFAULT_TO_ARRAY_ON_CLASS` и
`DEFAULT_FROM_ARRAY_ON_CLASS`. Они описывают методы обработки классов по умолчанию для методов `ToArray` и `FromArray`
соответственно.
### Метод `DEFAULT_TO_ARRAY_ON_CLASS`
Этот метод возвращает `Closure`, который можно использовать (и он используется при значении параметра `null`) во втором
параметре метода `ToArray`.
### Метод `DEFAULT_FROM_ARRAY_ON_CLASS`
Этот метод возвращает `Closure`, который можно использовать (и он используется при значении параметра `null`) во втором
параметре метода `FromArray`.
## Методы и функции
### Метод `ToArray`
Этот _статический_ метод переводит класс в массив. Он содержит **1 обязательный параметр**:
* `object $class` - класс, который нужно перевести в массив
и **1 необязательный параметр**:
* `?callable $onClass = null` - метод обработки классов. Если передаётся `null`, то используется
`DEFAULT_TO_ARRAY_ON_CLASS`. По умолчанию, `null`.
В качестве метода обработки классов `onClass` подойдет любое `Closure` вида
fn (object $class): array => <ДЕЙСТВИЕ>;
Метод возвращает `array` - массив публичных свойств.
Синтаксис:
public static function ToArray (object $class, ?callable $onClass = null): array
Пример,
// Создаём тестовый класс (см. TypeExtensionTest)
$class = new D (
'test_string',
12345,
true,
new A("test_string_A", 6789, false),
new B("test_string_B", 9876, "false"),
new C("test_string_C", 54321, true)
);
// Создаём метод обработки классов
// - воспользуемся тем, что класс C реализует интерфейс ISerialize
$c_closure = fn (C $class): array =>
[
"type_class" => C::class,
"type_value" => $class->Serialize()
];
// - зададим метод обработки
$closure = fn (object $class): array => $class instanceof C
? $c_closure($class)
: TypeExtension::ToArray($class);
// Преобразуем в массив
try {
$array = TypeExtension::ToArray($class, $closure);
}
catch (TypeException $e) {
// - если ошибка, то выводим её и завершаем работу
die($e->getMessage());
}
// Вывожу в файл
file_put_contents(__DIR__ . "/class.txt", json_encode($array, JSON_PRETTY_PRINT));
В результате содержимое файла:
{
"type_class": "goodboyalex\\php_components_pack\\tests\\data\\D",
"stringD": "test_string",
"intD": 12345,
"boolD": true,
"a": {
"type_class": "goodboyalex\\php_components_pack\\tests\\data\\A",
"a": "test_string_A",
"b": 6789,
"c": false
},
"b": {
"type_class": "goodboyalex\\php_components_pack\\tests\\data\\B",
"a": "test_string_B",
"b": 9876,
"d": "false"
},
"c": {
"type_class": "goodboyalex\\php_components_pack\\tests\\data\\C",
"type_value": "{\"string\":\"test_string_C\",\"int\":54321,\"bool\":true}"
}
}
#### Выбрасываемые исключения
Этот метод выбрасывает исключение типа `TypeException` в случае, если объект `$class` (обязательный параметр метода) не является классом.
### Метод `FromArray`
Этот _статический_ метод переводит массив в класс. Он содержит **1 обязательный параметр**:
* `array $array` - массив публичных свойств
и **1 необязательный параметр**:
* `?callable $onClass = null` - метод обработки классов. Если передаётся `null`, то используется
`DEFAULT_FROM_ARRAY_ON_CLASS`. По умолчанию, `null`.
В качестве метода обработки классов `onClass` подойдет любое `Closure` вида
fn (array $classArray): object => <ДЕЙСТВИЕ>;
Метод возвращает `object` - экземпляр класса.
Синтаксис:
public static function FromArray (array $array, ?callable $onClass = null): object
Пример,
// Считываем данные из файла и преобразуем в массив
$array = json_decode(file_get_contents(__DIR__ . "/class.txt"), true);
// Создаём метод обработки классов
// - воспользуемся тем, что класс C реализует интерфейс ISerialize
$c_closure = function (string $serializedC): C
{
$classC = new C();
$classC->UnSerialize($serializedC);
return $classC;
};
// - зададим метод обработки
$closure = fn (array $classArray): object =>
$classArray['type_class'] == C::class
? $c_closure($classArray["type_value"])
: TypeExtension::FromArray($classArray);
// Преобразуем в объект
try {
$class = TypeExtension::FromArray($array, D::CLOSURE_FROM_ARRAY());
} catch (TypeException $e) {
// - если ошибка, то выводим её и завершаем работу
die($e->getMessage());
}
// Вывожу тестовую строку
echo $class->c->stringC;
В результате на экране отобразится:
test_string_C
#### Выбрасываемые исключения
Этот метод выбрасывает исключение типа `TypeException` в случаях, если:
* массив `$array` не создан через метод `ToArray`;
* при попытке создать объект, он не создаётся;
* дата передана не корректного формата;
* пытается передать `null` не `nullable` типу.

View File

@@ -0,0 +1,235 @@
<?php
namespace goodboyalex\php_components_pack\extensions;
use Closure;
use DateMalformedStringException;
use DateTime;
use DateTimeImmutable;
use DateTimeInterface;
use Exception;
use goodboyalex\php_components_pack\exceptions\TypeException;
use UnitEnum;
/**
* Расширение для любого типа.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.1
*/
final class TypeExtension
{
/**
* Дефолтный метод обработки классов для ToArray.
*
* @return Closure Метод обработки классов для ToArray.
*/
public static function DEFAULT_TO_ARRAY_ON_CLASS (): Closure
{
return fn (object $class): array => self::ToArray($class);
}
/**
* Переводит объект в массив.
*
* @param object $class Объект.
* @param callable|null $onClass Метод обработки классов. Если передаётся null, то используется
* <code>DEFAULT_TO_ARRAY_ON_CLASS</code>. По умолчанию, null.
*
* @return array Массив свойств типа.
* @throws TypeException Исключение, если объект не является классом.
*/
public static function ToArray (object $class, ?callable $onClass = null): array
{
// Проверяю, что метод обработки классов не null и если null, то присваиваю дефолтный метод
$onClass ??= self::DEFAULT_TO_ARRAY_ON_CLASS();
// Создаю массив результата
$result = [];
// Сперва проверяю, что объект является классом
if (!is_object($class))
// - если нет, то выбрасываю исключение
throw new TypeException($class::class, "Object is not class / Объект не является классом.");
// Затем записываю имя класса
$result["type_class"] = $class::class;
// Получаю свойства класса
$properties = get_object_vars($class);
// Для каждого свойства класса
foreach ($properties as $key => $value) {
// - если значение является датой
if ($value instanceof DateTimeInterface) {
// -- добавляю в массив
$result[$key] = $value->getTimestamp();
// -- следующий элемент
continue;
}
// - если значение является перечислением
if ($value instanceof UnitEnum) {
// -- получаю перечисление
$result[$key] = $value->name;
// -- следующий элемент
continue;
}
// - если значение является NULL
if (is_null($value)) {
// -- присваиваю NULL
$result[$key] = "null";
// -- следующий элемент
continue;
}
// - если значение является классом
if (is_object($value)) {
// -- добавляю в массив через рекурсию
$result[$key] = $onClass($value);
// -- следующий элемент
continue;
}
// - присваиваю значение
$result[$key] = $value;
}
// Возвращаю результат
return $result;
}
/**
* Дефолтный метод обработки классов для FromArray.
*
* @return Closure Метод обработки классов для FromArray.
*/
public static function DEFAULT_FROM_ARRAY_ON_CLASS (): Closure
{
return fn (array $classArray): object => self::FromArray($classArray);
}
/**
* Переводит массив в объект.
*
* @param array $array Массив свойств.
* @param callable|null $onClass Метод обработки классов. Если передаётся null, то используется
* <code>DEFAULT_FROM_ARRAY_ON_CLASS</code>. По умолчанию, null.
*
* @return mixed Восстановленный объект.
* @throws TypeException Исключение, если массив не создан через ToArray, объект не создан, дата не корректного
* формата или пытается передать null не nullable типу.
*/
public static function FromArray (array $array, ?callable $onClass = null): object
{
// Проверяю, что массив является массивом, созданным через ToArray, то есть содержит ключ type_class
if (!array_key_exists("type_class", $array))
// - если нет, то выбрасываю исключение
throw new TypeException("array", "Array is not created by ToArray / Массив не создан через ToArray.");
// Получаю имя класса
$className = $array["type_class"];
// Создаем объект
$instance = new $className();
// Проверяем, что объект создан
if (!is_object($instance) && $instance instanceof $className)
// - если нет, то выбрасываю исключение
throw new TypeException($className, "Object is not created / Объект не создан.");
// Получаю свойства класса
$properties = get_object_vars($instance);
// Для каждого свойства класса
foreach ($properties as $key => $value) {
// - проверяю, есть ли свойство в массиве
if (!array_key_exists($key, $array))
// -- если нет, то пропускаю
continue;
// - получаю значение из массива
$value = $array[$key];
// - если значение является датой DateTime
if ($instance->$key instanceof DateTime && is_int($value)) {
// -- присваиваю значение
try {
$instance->$key = new DateTime ('@' . $value);
}
catch (DateMalformedStringException) {
throw new TypeException($className . "->{$key}::DateTime",
"Date is not correct format / Дата не корректного формата.");
}
// -- следующий элемент
continue;
}
// - если значение является датой DateTimeImmutable
if ($instance->$key instanceof DateTimeImmutable && is_int($value)) {
// -- присваиваю значение
try {
$instance->$key = new DateTimeImmutable('@' . $value);
}
catch (DateMalformedStringException) {
throw new TypeException($className . "->{$key}::DateTimeImmutable",
"Date is not correct format / Дата не корректного формата.");
}
// -- следующий элемент
continue;
}
// - если значение является перечислением
if ($instance->$key instanceof UnitEnum) {
// -- получаю все значения перечисления
foreach ($instance->$key::getCases() as $case)
// --- если значение совпадает
if ($case->name === $value)
// ---- присваиваю значение
$instance->$key = $case;
// -- следующий элемент
continue;
}
// - если значение является NULL
if (is_string($value) && $value == "null") {
// -- присваиваю NULL
try {
$instance->$key = null;
}
catch (Exception $exception) {
throw new TypeException($className . "->$key",
"Cannot assign null to non-nullable property. / Невозможно присвоить null не nullable типу: {$exception->getMessage()}.");
}
// -- следующий элемент
continue;
}
// - если значение является классом
if (is_object($instance->$key) && is_array($array[$key]) && array_key_exists("type_class", $array[$key])) {
// -- добавляю в массив через рекурсию
$instance->$key = $onClass($array[$key]);
// -- следующий элемент
continue;
}
// - присваиваю значение
$instance->$key = $value;
}
// Возвращаю объект
return $instance;
}
}

View File

@@ -0,0 +1,30 @@
<?php
namespace goodboyalex\php_components_pack\interfaces;
/**
* Интерфейс, указывающий, что класс может быть переведён в массив и обратно.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.2
*/
interface IArrayable
{
/**
* Переводит объект в массив.
*
* @return array Массив объекта.
*/
public function ToArray (): array;
/**
* Переводит массив в объект.
*
* @param array $array Массив.
*
* @return void
*/
public function FromArray (array $array): void;
}

View File

@@ -0,0 +1,43 @@
<?php
namespace goodboyalex\php_components_pack\interfaces;
/**
* Интерфейс, указывающий, что класс можно сравнивать.
*
* @author Александр Бабаев
* @package freecms
* @version 0.1
* @since 1.2
*/
interface IComparable
{
/**
* Сравнивает объекты текущего класса с другим, переданным в <code>$other</code>.
*
* @param mixed $other Второй класс для сравнения.
*
* @return int Возвращает результат сравнения. <code>0</code>, если GUID равны, <code>-1</code>, если текущий GUID
* меньше, чем второй и <code>1</code>, если текущий GUID больше другого.
*/
public function CompareTo (mixed $other): int;
/**
* Сравнивает на равенство текущий класс с другим, переданным в <code>$other</code>.
*
* @param mixed $other Второй класс для сравнения.
*
* @return bool Результат сравнения: <code>true</code>, если оба класса равны и <code>false</code>, если нет.
*/
public function IsEqualsTo (mixed $other): bool;
/**
* Сравнение объектов по указанному свойству.
*
* @param string $propertyName Название свойства для сравнения.
* @param mixed $other Объект для сравнения.
*
* @return int Результат сравнения: <code>-1</code>, <code>0</code> или <code>1</code>.
*/
public function CompareByProperty (string $propertyName, mixed $other): int;
}

View File

@@ -0,0 +1,21 @@
<?php
namespace goodboyalex\php_components_pack\interfaces;
/**
* Интерфейс, указывающий, что у класса можно получить хэш.
*
* @author Александр Бабаев
* @package freecms
* @version 0.1
* @since 1.2
*/
interface IHashable
{
/**
* Возвращает хеш-значение класса.
*
* @return string Хеш-значение класса.
*/
public function Hash (): string;
}

View File

@@ -0,0 +1,37 @@
<?php
namespace goodboyalex\php_components_pack\interfaces;
/**
* Интерфейс, указывающий, что класс можно сортировать.
*
* @author Александр Бабаев
* @package freecms
* @version 0.1
* @since 1.2
*/
interface ISortable extends IHashable
{
/**
* Сортирует элементы класса.
*
* @param string $property Название свойства, по которому нужно отсортировать. Если пусто, то сортировка должна
* происходить по хешу. По умолчанию - пустая строка.
* @param bool $descending Направление сортировки: <code>true</code> - по убыванию, <code>false</code> - по
* возрастанию. По умолчанию - по возрастанию.
*
* @return void
*/
public function Sort (string $property = '', bool $descending = false): void;
/**
* Сортирует элементы класса по заданной функции.
*
* @param callable $propertyFunction Функция, возвращающая значение свойства для сортировки.
* @param bool $descending Направление сортировки: <code>true</code> - по убыванию, <code>false</code> - по
* возрастанию. По умолчанию - по возрастанию.
*
* @return void
*/
public function SortCallback (callable $propertyFunction, bool $descending = false): void;
}

View File

@@ -1,32 +0,0 @@
<?php
namespace goodboyalex\php_components_pack\interfaces;
/**
* Интерфейс поддержки моделей и классов, реализующих хранение свойств в SQL базе данных.
*
* @author Александр Бабаев
* @package freecms
* @version 0.1
* @since 0.1
*/
interface IStoredAtSQL
{
/**
* Вывод параметров добавления/обновления данных в базу данных.
*
* @param bool $withId Нужно ли добавлять Id в массив
*
* @return array Массив параметров
*/
public function ToSQL (bool $withId = true): array;
/**
* Преобразование данных из базы данных в модель, класс.
*
* @param array $sqlData Данные из базы данных
*
* @return self Класс модели с заполненными данными из базы данных
*/
public function FromSQL (array $sqlData): self;
}

View File

@@ -6,14 +6,14 @@ use goodboyalex\php_components_pack\enums\MessageType;
use goodboyalex\php_components_pack\interfaces\ISerializable; use goodboyalex\php_components_pack\interfaces\ISerializable;
/** /**
* Класс сообщения состояния. * Модель сообщения о состоянии.
* *
* @author Александр Бабаев * @author Александр Бабаев
* @package php_components_pack * @package php_components_pack
* @version 1.0 * @version 1.1
* @since 1.0 * @since 1.0
*/ */
final class ActionStateMessageModel implements ISerializable final class ActionStateMessage implements ISerializable
{ {
/** /**
* @var MessageType $MessageType Тип сообщения * @var MessageType $MessageType Тип сообщения

View File

@@ -0,0 +1,52 @@
<?php
namespace goodboyalex\php_components_pack\models;
use Closure;
use goodboyalex\php_components_pack\enums\ObjectArraySerializeMethod;
/**
* Модель настроек сериализации для класса ObjectArray.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.1
*/
final class ObjectArraySerializeOptions
{
/**
* @var ObjectArraySerializeMethod $SerializeMethod Метод сериализации/десериализации.
*/
public ObjectArraySerializeMethod $SerializeMethod;
/**
* @var Closure|null $OnClassTo Функция обратного вызова для сериализации объекта методом JsonEncodeWithToArray.
* Она передается в качестве параметра в функцию ToArray и служит для правильного преобразования типа в массив.
*/
public ?Closure $OnClassTo;
/**
* @var Closure|null $OnClassFrom Функция обратного вызова для десериализации объекта методом
* JsonEncodeWithToArray. Она передается в качестве параметра в функцию FromArray и служит для правильного
* преобразования массива в тип.
*/
public ?Closure $OnClassFrom;
/**
* Конструктор.
*
* @param ObjectArraySerializeMethod $serializeMethod Метод сериализации/десериализации.
* @param callable|null $onClassTo Функция обратного вызова для сериализации объекта методом JsonEncodeWithToArray
* (для ToArray).
* @param callable|null $onClassFrom Функция обратного вызова для десериализации объекта методом
* JsonEncodeWithToArray (для FromArray).
*/
public function __construct (ObjectArraySerializeMethod $serializeMethod = ObjectArraySerializeMethod::Serialize,
?callable $onClassTo = null, ?callable $onClassFrom = null)
{
$this->SerializeMethod = $serializeMethod;
$this->OnClassTo = $onClassTo;
$this->OnClassFrom = $onClassFrom;
}
}

View File

@@ -5,7 +5,7 @@ namespace goodboyalex\php_components_pack\traits\ActionState;
use goodboyalex\php_components_pack\classes\ActionState; use goodboyalex\php_components_pack\classes\ActionState;
use goodboyalex\php_components_pack\classes\ObjectArray; use goodboyalex\php_components_pack\classes\ObjectArray;
use goodboyalex\php_components_pack\enums\MessageType; use goodboyalex\php_components_pack\enums\MessageType;
use goodboyalex\php_components_pack\models\ActionStateMessageModel; use goodboyalex\php_components_pack\models\ActionStateMessage;
/** /**
* Часть кода класса ActionState, отвечающая за методы добавления сообщений. * Часть кода класса ActionState, отвечающая за методы добавления сообщений.
@@ -30,7 +30,7 @@ trait ActionStateAddTrait
// Если нужно очистить список сообщений // Если нужно очистить список сообщений
if ($clearAllBefore) if ($clearAllBefore)
// - то очищаю список сообщений // - то очищаю список сообщений
$this->Clear(fn (ActionStateMessageModel $message) => true); $this->Clear(fn (ActionStateMessage $message) => true);
// Добавляю сообщения из другого состояния // Добавляю сообщения из другого состояния
$this->AddRange($state->GetMessages(ActionState::GET_STRING_ALL())); $this->AddRange($state->GetMessages(ActionState::GET_STRING_ALL()));
@@ -61,17 +61,17 @@ trait ActionStateAddTrait
*/ */
public function AddCritical (string $message): void public function AddCritical (string $message): void
{ {
$this->Add(new ActionStateMessageModel(MessageType::Error, true, $message)); $this->Add(new ActionStateMessage(MessageType::Error, true, $message));
} }
/** /**
* Добавление сообщения. * Добавление сообщения.
* *
* @param ActionStateMessageModel $message Сообщение * @param ActionStateMessage $message Сообщение
* *
* @return void * @return void
*/ */
public function Add (ActionStateMessageModel $message): void public function Add (ActionStateMessage $message): void
{ {
$this->Messages->Add($message); $this->Messages->Add($message);
} }
@@ -85,7 +85,7 @@ trait ActionStateAddTrait
*/ */
public function AddError (string $message): void public function AddError (string $message): void
{ {
$this->Add(new ActionStateMessageModel(MessageType::Error, false, $message)); $this->Add(new ActionStateMessage(MessageType::Error, false, $message));
} }
/** /**
@@ -97,7 +97,7 @@ trait ActionStateAddTrait
*/ */
public function AddWarning (string $message): void public function AddWarning (string $message): void
{ {
$this->Add(new ActionStateMessageModel(MessageType::Warning, false, $message)); $this->Add(new ActionStateMessage(MessageType::Warning, false, $message));
} }
/** /**
@@ -109,6 +109,6 @@ trait ActionStateAddTrait
*/ */
public function AddInfo (string $message): void public function AddInfo (string $message): void
{ {
$this->Add(new ActionStateMessageModel(MessageType::Info, false, $message)); $this->Add(new ActionStateMessage(MessageType::Info, false, $message));
} }
} }

View File

@@ -3,7 +3,7 @@
namespace goodboyalex\php_components_pack\traits\ActionState; namespace goodboyalex\php_components_pack\traits\ActionState;
use goodboyalex\php_components_pack\enums\MessageType; use goodboyalex\php_components_pack\enums\MessageType;
use goodboyalex\php_components_pack\models\ActionStateMessageModel; use goodboyalex\php_components_pack\models\ActionStateMessage;
/** /**
* Часть кода класса ActionState, отвечающая за методы проверки на наличие сообщений. * Часть кода класса ActionState, отвечающая за методы проверки на наличие сообщений.
@@ -22,7 +22,7 @@ trait ActionStateHasTrait
*/ */
public function HasInfos (): bool public function HasInfos (): bool
{ {
return $this->Messages->IsExist(fn (ActionStateMessageModel $message) return $this->Messages->IsExist(fn (ActionStateMessage $message)
=> $message->MessageType => $message->MessageType
== MessageType::Info); == MessageType::Info);
} }
@@ -48,7 +48,7 @@ trait ActionStateHasTrait
*/ */
public function HasErrors (bool $onlyCritical = false): bool public function HasErrors (bool $onlyCritical = false): bool
{ {
return $this->Messages->IsExist(fn (ActionStateMessageModel $message): bool return $this->Messages->IsExist(fn (ActionStateMessage $message): bool
=> $onlyCritical => $onlyCritical
? $message->MessageType == MessageType::Error && $message->IsCritical ? $message->MessageType == MessageType::Error && $message->IsCritical
: $message->MessageType == MessageType::Error); : $message->MessageType == MessageType::Error);
@@ -61,7 +61,7 @@ trait ActionStateHasTrait
*/ */
public function HasWarnings (): bool public function HasWarnings (): bool
{ {
return $this->Messages->IsExist(fn (ActionStateMessageModel $message) return $this->Messages->IsExist(fn (ActionStateMessage $message)
=> $message->MessageType => $message->MessageType
== MessageType::Warning); == MessageType::Warning);
} }

View File

@@ -4,7 +4,7 @@ namespace goodboyalex\php_components_pack\traits\ActionState;
use Closure; use Closure;
use goodboyalex\php_components_pack\enums\MessageType; use goodboyalex\php_components_pack\enums\MessageType;
use goodboyalex\php_components_pack\models\ActionStateMessageModel; use goodboyalex\php_components_pack\models\ActionStateMessage;
/** /**
* Часть кода класса ActionState, отвечающая за статичные методы и константы. * Часть кода класса ActionState, отвечающая за статичные методы и константы.
@@ -23,7 +23,7 @@ trait ActionStateStaticTrait
*/ */
public static function GET_STRING_ERROR_ONLY (): Closure public static function GET_STRING_ERROR_ONLY (): Closure
{ {
return fn (ActionStateMessageModel $message) return fn (ActionStateMessage $message)
=> $message->MessageType === MessageType::Error; => $message->MessageType === MessageType::Error;
} }
@@ -34,7 +34,7 @@ trait ActionStateStaticTrait
*/ */
public static function GET_STRING_ERROR_AND_WARNING (): Closure public static function GET_STRING_ERROR_AND_WARNING (): Closure
{ {
return fn (ActionStateMessageModel $message) return fn (ActionStateMessage $message)
=> $message->MessageType === MessageType::Error => $message->MessageType === MessageType::Error
|| $message->MessageType === MessageType::Warning; || $message->MessageType === MessageType::Warning;
} }
@@ -46,6 +46,6 @@ trait ActionStateStaticTrait
*/ */
public static function GET_STRING_ALL (): Closure public static function GET_STRING_ALL (): Closure
{ {
return fn (ActionStateMessageModel $message) => true; return fn (ActionStateMessage $message) => true;
} }
} }

View File

@@ -77,7 +77,11 @@ trait ArrayBasicTrait
*/ */
public function Serialize (): string public function Serialize (): string
{ {
return json_encode($this->Container); /**
* ВНИМАНИЕ! Не используйте json_encode для сериализации объектов данного класса, так как он НЕ СОХРАНЯЕТ классы объектов!
* Корректное восстановление объектов невозможно (восстанавливает только как ассоциативный массив).
*/
return serialize($this->Container);
} }
/** /**
@@ -85,6 +89,10 @@ trait ArrayBasicTrait
*/ */
public function UnSerialize (string $serialized): void public function UnSerialize (string $serialized): void
{ {
$this->Container = json_decode($serialized, true); /**
* ВНИМАНИЕ! Не используйте json_decode для десериализации объектов данного класса, так как он НЕ ВОССТАНОВЛЯЕТ
* классы объектов! Корректное восстановление объектов невозможно (восстанавливается только как ассоциативный массив).
*/
$this->Container = unserialize($serialized);
} }
} }

View File

@@ -0,0 +1,43 @@
<?php
namespace goodboyalex\php_components_pack\traits\GUID;
use goodboyalex\php_components_pack\exceptions\TypeException;
use goodboyalex\php_components_pack\types\GUID;
/**
* Часть кода класса GUID, отвечающая за реализацию интерфейса IArrayable.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.2
*/
trait GUIDArrayableTrait
{
/**
* @inheritDoc
*/
public function ToArray (): array
{
return [
"type_class" => GUID::class,
"value" => $this->Value
];
}
/**
* @inheritDoc
* @throws TypeException Если тип не соответствует.
*/
public function FromArray (array $array): void
{
// Проверка типа
if (!isset($array["type_class"]) || $array["type_class"] != GUID::class)
// - если тип не соответствует, выбрасываем исключение
throw new TypeException($array["type_class"] ?? "", 'Неверный тип данных / Wrong data type.');
// Получаем значение GUID
$this->Value = $array["value"];
}
}

View File

@@ -0,0 +1,56 @@
<?php
namespace goodboyalex\php_components_pack\traits\GUID;
use Deprecated;
/**
* Часть кода класса GUID, отвечающая за реализацию интерфейса IComparable.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.2
*/
trait GUIDComparableTrait
{
/**
* @inheritDoc
*/
public function IsEqualsTo (mixed $other): bool
{
return $this->Value === $other->ToString();
}
/**
* @inheritDoc
*/
public function CompareTo (mixed $other): int
{
// Сравниваем строковые значения GUID
$compareResult = strcmp($this->Value, $other->ToString());
// Возвращаем результат сравнения
// - если текущий GUID меньше, чем второй
if ($compareResult < 0)
// - возвращаем -1
return -1;
// - если текущий GUID больше, чем второй
else if ($compareResult > 0)
// - возвращаем 1
return 1;
else
// - иначе если GUID равны, то возвращаем 0
return 0;
}
/**
* @inheritDoc
*/
#[Deprecated('Этот класс не имеет свойств. Данные методы не будут работать корректно. / This class has no properties. These methods will not work correctly.', '1.2')]
public function CompareByProperty (string $propertyName, mixed $other): int
{
// Этот класс не имеет свойств, поэтому возвращаем 0
return 0;
}
}

View File

@@ -0,0 +1,24 @@
<?php
namespace goodboyalex\php_components_pack\traits\GUID;
use goodboyalex\php_components_pack\types\GUID;
/**
* Часть кода класса GUID, отвечающая за реализацию интерфейса IDuplicated.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.2
*/
trait GUIDDuplicatedTrait
{
/**
* @inheritDoc
*/
public function Duplicate (): object
{
return GUID::Parse($this->Value);
}
}

View File

@@ -0,0 +1,22 @@
<?php
namespace goodboyalex\php_components_pack\traits\GUID;
/**
* Часть кода класса GUID, отвечающая за реализацию интерфейса IHashable.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.2
*/
trait GUIDHashableTrait
{
/**
* @inheritDoc
*/
public function Hash (): string
{
return md5($this->Value);
}
}

View File

@@ -0,0 +1,22 @@
<?php
namespace goodboyalex\php_components_pack\traits\GUID;
/**
* Часть кода класса GUID, отвечающая за реализацию интерфейса JsonSerializable.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.2
*/
trait GUIDJsonSerializableTrait
{
/**
* @inheritDoc
*/
public function jsonSerialize (): string
{
return $this->Value;
}
}

View File

@@ -0,0 +1,41 @@
<?php
namespace goodboyalex\php_components_pack\traits\GUID;
use goodboyalex\php_components_pack\exceptions\TypeException;
/**
* Часть кода класса GUID, отвечающая за реализацию интерфейса ISerializable.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.2
*/
trait GUIDSerializeTrait
{
/**
* @inheritDoc
*/
public function Serialize (): string
{
// Получаем массив
$array = $this->ToArray();
// Преобразуем в JSON
return json_encode($array, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
}
/**
* @inheritDoc
* @throws TypeException Если тип не соответствует.
*/
public function UnSerialize (string $serialized): void
{
// Преобразуем в массив
$array = json_decode($serialized, true, flags: JSON_UNESCAPED_UNICODE);
// Получаем значение
$this->FromArray($array);
}
}

View File

@@ -0,0 +1,69 @@
<?php
namespace goodboyalex\php_components_pack\traits\JsonReWriter;
/**
* Часть кода класса JsonReWriter, отвечающая за методы удаления ключей JSON.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.0
*/
trait JsonReWriterDeleteTrait
{
/**
* Очистка данных JSON.
*
* @return void
*/
public function Clear (): void
{
// Очистка данных
unset($this->JsonData);
// Создание пустого массива
$this->JsonData = [];
}
/**
* Удаление ключа JSON.
*
* @param string $key Требуемый ключ JSON для удаления.
*
* @return bool Результат удаления ключа: <code>true</code> - удаление прошло успешно, <code>false</code> -
* произошла ошибка при удалении.
*/
public function DeleteKey (string $key): bool
{
// Очищаем ключ
$preparedKey = $this->PrepareKey($key);
// Проверка ключа
if (!$this->IsKeyExists($preparedKey))
// - ключ не существует
return false;
// Разбиваем ключ на части
$keys = $this->ParseKey($preparedKey);
// Получаем текущий массив данных
$current = &$this->JsonData;
// Если ключ не является корневым
if (count($keys) > 0)
// - переходим к вложенному массиву
for ($i = 0; $i < count($keys) - 1; $i++)
// -- и добавляем массив данных
$current = &$current[$keys[$i]];
// Получаем удаляемый ключ
$deleteKey = $keys[count($keys) - 1];
// Удаляем ключ
unset($current[$deleteKey]);
// Проверяем удаление
return $this->IsKeyExists($key);
}
}

View File

@@ -0,0 +1,129 @@
<?php
namespace goodboyalex\php_components_pack\traits\JsonReWriter;
use goodboyalex\php_components_pack\extensions\StringExtension;
/**
* Часть кода класса JsonReWriter, отвечающая за методы работы с ключами JSON.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.0
*/
trait JsonReWriterKeyTrait
{
/**
* Проверяем наличие ключа в JSON.
*
* @param string $key Ключ.
*
* @return bool true если ключ найден, false если нет.
*/
public function IsKeyExists (string $key): bool
{
// Получаем массив ключей по вложенности
$keys = $this->ParseKey($key);
// Получаем текущий массив данных
$current = $this->JsonData;
// Для каждого ключа
foreach ($keys as $key) {
// - проверяем наличие ключа в текущем массиве
if (!array_key_exists($key, $current))
// - нет? Возвращаем false
return false;
// Переходим ко вложенному массиву
$current = $current[$key];
}
// Возвращаем true, если все ключи найдены
return true;
}
/**
* Получение ключей по вложенности. Т.е., ключи вида <code>"key1/key2/key3" => ["key1", "key2", "key3"]</code>.
*
* @param string $key Ключ.
*
* @return array Ключи по вложенности.
*/
private function ParseKey (string $key): array
{
// Очищаем ключ
$key = $this->PrepareKey($key);
// Разбиваем ключ на части
return explode('/', $key);
}
/**
* Подготавливает ключ к использованию внутри методов.
*
* @param string $key Неочищенный ключ.
*
* @return string Очищенный ключ.
*/
private function PrepareKey (string $key): string
{
return trim($key, "/ ");
}
/**
* Получение списка ключей.
*
* @param string $parentKey Ключ родителя (или "" (установлено по умолчанию) для всех).
* @param bool $includeChildren Нужно ли включать дочерние ключи (по умолчанию, да).
*
* @return array Список ключей.
*/
public function GetKeys (string $parentKey = "", bool $includeChildren = true): array
{
// Очищаем ключ
$parentKey = $this->PrepareKey($parentKey);
// Разбиваем ключ на части
$keys = StringExtension::IsNullOrWhitespace($parentKey) ? [] : $this->ParseKey($parentKey);
// Получаем текущий массив данных
$current = $this->JsonData;
// Если ключ не является корневым
if (count($keys) > 0)
// - переходим к вложенному массиву
for ($i = 0; $i < count($keys); $i++)
// -- и добавляем массив данных
$current = $current[$keys[$i]];
// Получаем список ключей родителя
$parentKeysList = array_keys($current);
// Если не нужно включать дочерние ключи
if (!$includeChildren)
// - возвращаем список родительских ключей
return $parentKeysList;
// Создаем результирующий массив
$result = [];
// Для каждого ключа
foreach ($parentKeysList as $key) {
// - очищаем текущий ключ
$currentKey = $this->PrepareKey($parentKey . "/" . $key);
// - добавляем его в результирующий массив
$result[] = $currentKey;
// - если у текущего ключа есть дочерние ключи
if (is_array($current[$key]))
// -- добавляем их в результирующий массив
$result = array_merge($result, $this->GetKeys($currentKey));
}
// Возвращаем результирующий массив
return $result;
}
}

View File

@@ -0,0 +1,56 @@
<?php
namespace goodboyalex\php_components_pack\traits\JsonReWriter;
/**
* Часть кода класса JsonReWriter, отвечающая за методы загрузки и сохранения JSON.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.0
*/
trait JsonReWriterLoadSaveTrait
{
/**
* Сохраняем JSON в файл.
*
* @param string $fileName Имя файла.
*
* @return bool Сохранены ли данные в файл: <code>true</code> - да, <code>false</code> - нет.
*/
public function SaveToFile (string $fileName): bool
{
// Запись данных в файл
return file_put_contents($fileName, $this->JsonString) !== false;
}
/**
* Загрузка данных из JSON-файла.
*
* @param string $fileName Имя файла.
*
* @return bool Загрузились ли данные из файла: <code>true</code> - да, <code>false</code> - нет.
*/
public function LoadFromFile (string $fileName): bool
{
// Проверка существования файла
if (!is_file($fileName))
// - если нет, возвращаем false
return false;
// Чтение содержимого файла
$result = file_get_contents($fileName);
// Проверка на ошибки
if ($result === false)
// - если есть ошибки, возвращаем false
return false;
// Записываем результат
$this->JsonString = $result;
// Возвращаем true, если все хорошо
return true;
}
}

View File

@@ -0,0 +1,173 @@
<?php
namespace goodboyalex\php_components_pack\traits\JsonReWriter;
use goodboyalex\php_components_pack\enums\JsonErrorCode;
use goodboyalex\php_components_pack\exceptions\JsonException;
use goodboyalex\php_components_pack\interfaces\ISerializable;
/**
* Часть кода класса JsonReWriter, отвечающая за методы чтения ключей и значений JSON.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.0
*/
trait JsonReWriterReadTrait
{
/**
* Читает значение ключа JSON как целое число.
*
* @param string $key Ключ JSON.
* @param int $default Значение по умолчанию.
*
* @return int Значение ключа JSON или значение по умолчанию.
*/
public function ReadInt (string $key, int $default = 0): int
{
return (int)$this->Read($key, $default);
}
/**
* Читает значение ключа JSON.
*
* @param string $key Ключ JSON.
* @param mixed $default Значение по умолчанию.
*
* @return mixed Значение ключа JSON или значение по умолчанию.
*/
public function Read (string $key, mixed $default = null): mixed
{
// Подготавливаем ключ
$key = $this->PrepareKey($key);
// Проверяем, существует ли ключ
if (!$this->IsKeyExists($key))
// - если нет, то возвращаем значение по умолчанию
return $default;
// Разбиваем ключ на массив ключей
$keys = $this->ParseKey($key);
// Получаем текущий массив данных
$current = $this->JsonData;
// Для каждого ключа до предпоследнего
for ($i = 0; $i < count($keys) - 1; $i++)
// - переходим ко вложенному массиву
$current = $current[$keys[$i]];
// Возвращаем значение последнего ключа и если его нет, то возвращаем значение по умолчанию
return $current[$keys[count($keys) - 1]] ?? $default;
}
/**
* Читает значение ключа JSON как вещественное число.
*
* @param string $key Ключ JSON.
* @param float $default Значение по умолчанию.
*
* @return float Значение ключа JSON или значение по умолчанию.
*/
public function ReadFloat (string $key, float $default = 0.0): float
{
return (float)$this->Read($key, $default);
}
/**
* Читает значение ключа JSON как логическое значение.
*
* @param string $key Ключ JSON.
* @param bool $default Значение по умолчанию.
*
* @return bool Значение ключа JSON или значение по умолчанию.
*/
public function ReadBool (string $key, bool $default = false): bool
{
return (bool)$this->Read($key, $default);
}
/**
* Читает значение ключа JSON как массив.
*
* @param string $key Ключ JSON.
* @param array $default Значение по умолчанию.
*
* @return array Значение ключа JSON или значение по умолчанию.
*/
public function ReadArray (string $key, array $default = []): array
{
// Получаем значение ключа JSON
$serializedDef = json_encode($default);
// Читаем значение ключа JSON
$value = $this->ReadString($key, $serializedDef);
// Десериализуем значение ключа JSON
return json_decode($value, true);
}
/**
* Читает значение ключа JSON как строку.
*
* @param string $key Ключ JSON.
* @param string $default Значение по умолчанию.
*
* @return string Значение ключа JSON или значение по умолчанию.
*/
public function ReadString (string $key, string $default = ""): string
{
return (string)$this->Read($key, $default);
}
/**
* Читает значение ключа JSON как объект.
*
* @param string $key Ключ JSON.
* @param object $default Значение по умолчанию.
*
* @return object Значение ключа JSON или значение по умолчанию.
*/
public function ReadObject (string $key, object $default): object
{
// Получаем значение ключа JSON
$serializedDef = json_encode($default);
// Читаем значение ключа JSON
$value = $this->ReadString($key, $serializedDef);
// Десериализуем значение ключа JSON
return json_decode($value);
}
/**
* Читает значение ключа JSON как объект, реализующий интерфейс ISerializable.
*
* @param string $key Ключ JSON.
* @param string $serializableClassName Имя класса, реализующего интерфейс ISerializable, с namespace.
*
* @return ISerializable Инициализированный объект
* @throws JsonException Если класс не реализует интерфейс ISerializable
*/
public function ReadSerializable (string $key, string $serializableClassName): ISerializable
{
// Создаем объект
$instance = new $serializableClassName();
// Проверяем, что он реализует интерфейс ISerializable
if (!$instance instanceof ISerializable)
// - если нет, то выбрасываем исключение
throw new JsonException(errorCode: JsonErrorCode::NotISerializable,
errorMessage: "Class $serializableClassName is not implements ISerializable interface / Класс $serializableClassName не реализует интерфейс ISerializable");
// Получаем строку JSON из ключа
$json = $this->ReadString($key, $instance->Serialize());
// Десериализуем строку JSON в объект
$instance->UnSerialize($json);
// Возвращаем объект
return $instance;
}
}

View File

@@ -0,0 +1,109 @@
<?php
namespace goodboyalex\php_components_pack\traits\JsonReWriter;
use goodboyalex\php_components_pack\enums\JsonErrorCode;
use goodboyalex\php_components_pack\exceptions\JsonException;
use goodboyalex\php_components_pack\interfaces\ISerializable;
/**
* Часть кода класса JsonReWriter, отвечающая за методы записи ключей и значений JSON.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.0
*/
trait JsonReWriterWriteTrait
{
/**
* Записывает объект в ключ JSON.
*
* @param string $key Ключ JSON.
* @param object $value Записываемое значение.
*
* @return void
* @throws JsonException Ключ не содержит вложений, хотя от него требуется обратное.
*/
public function WriteObject (string $key, object $value): void
{
$this->Write($key, json_encode($value));
}
/**
* Записывает значение в ключ JSON.
*
* @param string $key Ключ JSON.
* @param mixed $value Записываемое значение.
*
* @return void
* @throws JsonException Ключ не содержит вложений, хотя от него требуется обратное.
*/
public function Write (string $key, mixed $value): void
{
// Подготавливаем ключ
$key = $this->PrepareKey($key);
// Получаем массив ключей по вложенности
$keys = $this->ParseKey($key);
// Получаем текущий массив данных
$current = &$this->JsonData;
// Для каждого ключа до предпоследнего
for ($i = 0; $i < count($keys) - 1; $i++) {
// - проверяем наличие ключа в текущем массиве
if (!isset($current[$keys[$i]]))
// - нет? Создаем ключ (массив)
$current[$keys[$i]] = [];
// - проверяем, что ключ является массивом
if (!is_array($current[$keys[$i]]))
// - нет? Выбрасываем исключение
throw new JsonException(errorCode: JsonErrorCode::KeyIsNotArray,
errorMessage: "The key does not contain attachments, although it is required to do the opposite / Ключ не содержит вложений, хотя от него требуется обратное!");
// - переходим ко вложенному массиву
$current = &$current[$keys[$i]];
}
// Создаем ключ (значение)
$current[$keys[count($keys) - 1]] = $value;
}
/**
* Записывает объект, реализующий интерфейс ISerializable, в ключ JSON.
*
* @param string $key Ключ JSON.
* @param ISerializable $serializableValue Записываемый объект, реализующий интерфейс ISerializable.
*
* @return void
* @throws JsonException Ключ не содержит вложений, хотя от него требуется обратное.
*/
public function WriteSerializable (string $key, ISerializable $serializableValue): void
{
// Сериализуем объект
$serialized = $serializableValue->Serialize();
// Записываем в ключ
$this->Write($key, $serialized);
}
/**
* Записывает массив в ключ JSON.
*
* @param string $key Ключ JSON.
* @param array $array Массив для записи.
*
* @return void
* @throws JsonException Ключ не содержит вложений, хотя от него требуется обратное.
*/
public function WriteArray (string $key, array $array): void
{
// Сериализуем массив
$serialized = json_encode($array);
// Записываем в ключ
$this->Write($key, $serialized);
}
}

View File

@@ -0,0 +1,89 @@
<?php
namespace goodboyalex\php_components_pack\traits\ObjectArray;
/**
* Часть кода класса ObjectArray, отвечающая за реализацию интерфейса IComparable.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.2
*/
trait ObjectArrayComparableTrait
{
/**
* @inheritDoc
*/
public function CompareTo (mixed $other): int
{
// Сравниваем на равенство
if ($this->IsEqualsTo($other))
// - если равны, то возвращаем 0
return 0;
// Возвращаем результат сравнения количества элементов
return $this->Count() > $other->Count() ? 1 : -1;
}
/**
* @inheritDoc
*/
public function IsEqualsTo (mixed $other): bool
{
// Получаем хэши
// - этого объекта
$thisHash = $this->Hash();
// - переданного объекта
$otherHash = $other->Hash();
// Сравниваем хэши и возвращаем результат
return $thisHash == $otherHash;
}
/**
* @inheritDoc
*/
public function CompareByProperty (string $propertyName, mixed $other): int
{
// Получаем значения свойств
// - этого объекта
$thisProperty = $this->GetColumn($propertyName);
// - переданного объекта
$otherProperty = $other->GetColumn($propertyName);
// Сравниваем их по количеству
if (count($thisProperty) !== count($otherProperty))
// - если количество элементов не совпадает, то возвращаем результат
return count($thisProperty) > count($otherProperty) ? 1 : -1;
// Переменная для хранения результата
$delta = 0;
// Проходимся по массивам
for ($i = 0; $i < count($thisProperty); $i++) {
// - получаем значения
// -- текущего массива
$thisValue = $thisProperty[$i];
// -- переданного массива
$otherValue = $otherProperty[$i];
// - если значения равны
if ($thisValue === $otherValue)
// - то пропускаем элемент
continue;
// - иначе сравниваем
if ($thisValue > $otherValue)
// - если текущее значение больше, то увеличиваем счетчик
$delta++;
else
// - иначе уменьшаем счетчик
$delta--;
}
// Возвращаем результат
return $delta === 0 ? 0 : ($delta > 0 ? 1 : -1);
}
}

View File

@@ -0,0 +1,66 @@
<?php
namespace goodboyalex\php_components_pack\traits\ObjectArray;
use goodboyalex\php_components_pack\interfaces\IArrayable;
use goodboyalex\php_components_pack\interfaces\IHashable;
use goodboyalex\php_components_pack\interfaces\ISerializable;
/**
* Часть кода класса ObjectArray, отвечающая за реализацию интерфейса IHashable.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.2
*/
trait ObjectArrayHashableTrait
{
/**
* @inheritDoc
*/
public function Hash (): string
{
// Создаю массив хешей всех объектов
$toHash = [];
// Перебираю все объекты в массиве
foreach ($this->Container as $object) {
// - если объект реализует интерфейс IHashable
if ($object instanceof IHashable) {
// -- то хэширую его и добавляю в массив
$toHash[] = $object->Hash();
// -- переходим к следующему элементу
continue;
}
// - если объект реализует интерфейс ISerializable
if ($object instanceof ISerializable) {
// -- то сериализую его и добавляю в массив
$toHash[] = $object->Serialize();
// -- переходим к следующему элементу
continue;
}
// - если объект реализует интерфейс IArrayable
if ($object instanceof IArrayable) {
// -- то преобразую его в массив
$array = $object->ToArray();
// -- сериализую его и добавляю в массив
$toHash[] = json_encode($array, JSON_UNESCAPED_UNICODE);
// -- переходим к следующему элементу
continue;
}
// - иначе просто сериализую объект
$toHash[] = serialize($object);
}
// Возвращаю хеш массива
return md5(json_encode($toHash, JSON_UNESCAPED_UNICODE));
}
}

View File

@@ -63,12 +63,12 @@ trait ObjectArraySearchAndSortTrait
/** /**
* Сортирует массив объектов, по значению свойства объекта. * Сортирует массив объектов, по значению свойства объекта.
* *
* @param string $objectProperty Имя свойства объекта * @param string $property Имя свойства объекта
* @param bool $descending Направление сортировки * @param bool $descending Направление сортировки
* *
* @return void * @return void
*/ */
public function Sort (string $objectProperty, bool $descending = false): void public function Sort (string $property = '', bool $descending = false): void
{ {
// Создаём результирующий массив // Создаём результирующий массив
$result = array_merge($this->Container, []); $result = array_merge($this->Container, []);
@@ -77,8 +77,8 @@ trait ObjectArraySearchAndSortTrait
usort($result, usort($result,
fn ($a, $b) fn ($a, $b)
=> !$descending => !$descending
? $a->$objectProperty <=> $b->$objectProperty ? $a->$property <=> $b->$property
: $b->$objectProperty <=> $a->$objectProperty); : $b->$property <=> $a->$property);
// Присваиваем результат // Присваиваем результат
$this->Container = $result; $this->Container = $result;

View File

@@ -0,0 +1,176 @@
<?php
namespace goodboyalex\php_components_pack\traits\ObjectArray;
use goodboyalex\php_components_pack\classes\ObjectArray;
use goodboyalex\php_components_pack\enums\ObjectArraySerializeMethod;
use goodboyalex\php_components_pack\exceptions\TypeException;
use goodboyalex\php_components_pack\extensions\TypeExtension;
use goodboyalex\php_components_pack\models\ObjectArraySerializeOptions;
/**
* Часть кода класса ObjectArray, отвечающая за расширенный функции сериализации.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.1
*/
trait ObjectArraySerializeExTrait
{
/**
* Десериализует массив объектов.
*
* @param string $serialized Сериализованный массив.
* @param ObjectArraySerializeOptions|null $options Настройки сериализации. По умолчанию используется настройка по
* умолчанию.
*
* @return ObjectArray Массив объектов.
*/
public static function UnSerializeEx (string $serialized, ?ObjectArraySerializeOptions $options = null): ObjectArray
{
// По умолчанию используем настройки по умолчанию
$options ??= new ObjectArraySerializeOptions();
// Десериализуем массив объектов
return match ($options->SerializeMethod) {
// - стандартный метод UnSerialize
ObjectArraySerializeMethod::Serialize => self::UnSerializeBySerialize($serialized),
// - метод JsonEncode
ObjectArraySerializeMethod::JsonEncode => self::UnSerializeByJsonEncode($serialized),
// - метод JsonEncodeWithToArray
ObjectArraySerializeMethod::JsonEncodeWithToArray => self::UnSerializeByJsonEncodeWithToArray($serialized,
$options->OnClassFrom)
};
}
/**
* Десериализует массив объектов с помощью стандартного метода UnSerialize.
*
* @param string $serialized Сериализованный массив.
*
* @return ObjectArray Массив объектов.
*/
private static function UnSerializeBySerialize (string $serialized): ObjectArray
{
// Создаем новый объект
$result = new ObjectArray();
// Десериализуем массив объектов с помощью стандартного метода
$result->UnSerialize($serialized);
// Возвращаем результат
return $result;
}
/**
* Десериализует массив объектов с помощью метода JsonEncode.
*
* @param string $serialized Сериализованный массив.
*
* @return ObjectArray Массив объектов.
*/
private static function UnSerializeByJsonEncode (string $serialized): ObjectArray
{
// Десериализуем массив
$container = json_decode($serialized, false, flags: JSON_UNESCAPED_UNICODE);
// Создаем новый объект
return new ObjectArray($container);
}
/**
* Десериализует массив объектов с помощью метода JsonEncodeWithToArray.
*
* @param string $serialized Сериализованный массив.
* @param callable|null $onClass Функция обратного вызова для десериализации объекта методом JsonEncodeWithToArray.
* Она передается в качестве параметра в функцию FromArray и служит для правильного преобразования массива в
* тип.
*
* @return ObjectArray Массив объектов.
*/
private static function UnSerializeByJsonEncodeWithToArray (string $serialized, ?callable $onClass): ObjectArray
{
// Десериализуем массив
$container = json_decode($serialized, true, flags: JSON_UNESCAPED_UNICODE);
// Создаем новый объект, в который будем помещать объекты
$result = new ObjectArray();
// Переберем все объекты в контейнере
foreach ($container as $item)
try {
// - пробуем преобразовать массив в объект, если это возможно
$result[] = TypeExtension::FromArray($item, $onClass);
}
catch (TypeException) {
// - если не получилось, то просто добавляем объект в массив
$result[] = $item;
}
// Возвращаем результат
return $result;
}
/**
* Сериализует массив объектов.
*
* @param ObjectArraySerializeOptions|null $options Настройки сериализации. По умолчанию используется настройка по
* умолчанию.
*
* @return string Сериализованный массив.
*/
public function SerializeEx (?ObjectArraySerializeOptions $options = null): string
{
// По умолчанию используем настройки по умолчанию
$options ??= new ObjectArraySerializeOptions();
// Сериализуем массив
return match ($options->SerializeMethod) {
// - стандартный метод Serialize
ObjectArraySerializeMethod::Serialize => $this->Serialize(),
// - метод JsonEncode
ObjectArraySerializeMethod::JsonEncode => $this->SerializeByJsonEncode(),
// - метод JsonEncodeWithToArray
ObjectArraySerializeMethod::JsonEncodeWithToArray => $this->SerializeByJsonEncodeWithToArray($options->OnClassTo)
};
}
/**
* Сериализует массив методом JsonEncode.
*
* @return string Сериализованный массив.
*/
private function SerializeByJsonEncode (): string
{
return json_encode($this->Container, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
}
/**
* Сериализует массив методом JsonEncodeWithToArray.
*
* @param callable|null $onClass Функция обратного вызова для сериализации объекта методом JsonEncodeWithToArray.
* Она передается в качестве параметра в функцию ToArray и служит для правильного преобразования типа в массив.
*
* @return string Сериализованный массив.
*/
private function SerializeByJsonEncodeWithToArray (?callable $onClass): string
{
// Создадим массив, в который будем помещать объекты
$container = [];
// Переберем все объекты в контейнере
foreach ($this->Container as $item)
try {
// - пробуем преобразовать объект в массив, если это возможно
$container[] = TypeExtension::ToArray($item, $onClass);
}
catch (TypeException) {
// - если не получилось, то просто добавляем объект в массив
$container[] = $item;
}
// Возвращаем сериализованный массив
return json_encode($container, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
}
}

View File

@@ -51,7 +51,7 @@ trait ObjectArraySpecialTrait
public function AddRange (ObjectArray|array $objects): void public function AddRange (ObjectArray|array $objects): void
{ {
// Если передан массив, то не изменяем его, а если передан объект класса ObjectArray, то конвертируем его в массив объектов // Если передан массив, то не изменяем его, а если передан объект класса ObjectArray, то конвертируем его в массив объектов
$objectsToAdd = is_array($objects) ? $objects : $objects->ToArray(); $objectsToAdd = is_array($objects) ? $objects : $objects->AsArray();
// Добавляем массив объектов // Добавляем массив объектов
$this->Merge($objectsToAdd); $this->Merge($objectsToAdd);
@@ -62,7 +62,7 @@ trait ObjectArraySpecialTrait
* *
* @return array Массив объектов, хранящихся в данном классе. * @return array Массив объектов, хранящихся в данном классе.
*/ */
public function ToArray (): array public function AsArray (): array
{ {
return $this->Container; return $this->Container;
} }

View File

@@ -0,0 +1,104 @@
<?php
namespace goodboyalex\php_components_pack\traits\ObjectArray;
use goodboyalex\php_components_pack\classes\ObjectArray;
use goodboyalex\php_components_pack\exceptions\TypeException;
use goodboyalex\php_components_pack\extensions\TypeExtension;
use goodboyalex\php_components_pack\interfaces\IArrayable;
/**
* Часть кода класса ObjectArray, отвечающая за реализацию интерфейса Arrayable.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.1.3
*/
trait ObjectArrayToArrayTrait
{
/**
* @inheritDoc
* @throws TypeException Если в массиве есть объекты, которые невозможно преобразовать в массив (происходит ошибка
* метода ToArray из класса TypeExtension).
*/
public function ToArray (): array
{
// Создаю массив
$result = [
"type_class" => ObjectArray::class
];
// Перебираю все элементы
foreach ($this->Container as $item) {
// - если элемент реализует интерфейс IArrayable
if ($item instanceof IArrayable)
// -- то вызываю метод ToArray и добавляю в массив его результат
$result[] = $item->ToArray();
else
// -- иначе вызываю метод ToArray из класса TypeExtension и добавляю в массив его результат
$result[] = TypeExtension::ToArray($item);
}
// Возвращаю массив
return $result;
}
/**
* @inheritDoc
* @throws TypeException Если в массиве есть объекты, которые невозможно преобразовать в массив (происходит ошибка
* метода FromArray из класса TypeExtension) или класс не существует.
*/
public function FromArray (array $array): void
{
// Очищаю массив
$this->Clear();
// Перебираю все элементы массива
foreach ($array as $key => $value) {
// - пропускаю специальные элементы, которые не являются объектами
if ($key == "type_class")
continue;
// - если элемент реализует интерфейс IArrayable
if ($this->IsArrayable($value)) {
// -- то получаю имя класса
$className = $array["type_class"];
// -- создаю объект
$instance = new $className();
// -- вызываю метод FromArray
$instance->FromArray($value);
// -- и добавляю в массив
$this->Container[] = $instance;
}
else
// -- иначе вызываю метод FromArray из класса TypeExtension
$this->Container[] = TypeExtension::FromArray($value, TypeExtension::DEFAULT_FROM_ARRAY_ON_CLASS());
}
}
/**
* Проверяет, реализует ли класс интерфейс IArrayable.
*
* @param array $array Массив.
*
* @return bool Возвращает <code>true</code>, если класс реализует интерфейс <code>IArrayable</code>, иначе
* <code>false</code>.
* @throws TypeException Если класс не существует.
*/
private function IsArrayable (array $array): bool
{
// Получаю имя класса
$className = $array["type_class"];
// Проверяем, существует ли класс вообще
if (!class_exists($className))
throw new TypeException($className, "Class $className is not exists / Класс $className не существует");
// Получаем список всех интерфейсов, реализуемых данным классом
$interfaces = class_implements($className);
// Проверка, присутствует ли IArrayable среди списка реализованных интерфейсов и возвращаем результат
return in_array('IArrayable', $interfaces);
}
}

338
sources/types/GUID.md Normal file
View File

@@ -0,0 +1,338 @@
# Описание класса GUID
## Информация о версии
Версия класса: 1.0
Впервые введено в пакет с версии: 1.2
Описание класса: Класс GUID предназначен для работы с уникальными идентификаторами формата UUID/GUID.
## Реализуемые интерфейсы
Класс реализует следующие интерфейсы:
* `IArrayable`,
* `IDuplicated`,
* `ISerializable`,
* `IComparable`,
* `IHashable`,
* `JsonSerializable`.
## Методы и функции
### Конструктор и деструктор.
Конструктор принимает **1 необязательный параметр**:
* `string $value` - строка GUID (по умолчанию, эквивалент `EMPTY`).
В результате создаётся новый класс `GUID`.
**Пример:**
// Контсуктор
$guid = new GUID ('00000000-0000-0000-0000-000000000000');
// Деструктор
unset($guid);
Создаст и уничтожит класс `GUID`.
### Перевод в строку.
За перевод в строку отвечают 3 метода: «магический метод» `__toString`, `ToString` и `Segment`.
#### «Магический метод» `__toString`
Этот метод переводит GUID в строку. Он не содержит параметров.
Метод возвращает `string` - строковое представление GUID.
Синтаксис:
public function __toString (): string
**Пример:**
// Создаю пустой GUID
$guid = new GUID ('00000000-0000-0000-0000-000000000000');
// Вывожу его
echo $guid;
В результате, на экране появится:
00000000-0000-0000-0000-000000000000
#### Метод `ToString`
Этот метод полностью аналогичен методу `__toString`.
Синтаксис:
public function ToString (): string
**Пример:**
// Создаю пустой GUID
$guid = new GUID ('00000000-0000-0000-0000-000000000000');
// Вывожу его
echo $guid->ToString();
В результате, на экране появится:
00000000-0000-0000-0000-000000000000
#### Метод `Segment`
Этот метод возвращает сегмент GUID по его номеру. Он имеет **1 обязательный параметр** - номер сегмента
`int $segmentNumber`.
Метод возвращает `string` - строковое представление сегмента GUID.
**ВАЖНО:** значение `$segmentNumber` должно быть от 1 до 5 включительно. В противном случае выбросится исключение
`OutOfRangeException`.
Синтаксис:
public function Segment (int $segmentNumber): string
**Пример:**
// Создаю пустой GUID
$guid = new GUID ('00000000-0000-0000-0000-000000000000');
// Вывожу его 1 сегмент
echo $guid->Segment(1);
// С новой строки
echo '<br>';
// Ошибка
try {
echo $guid->Segment(0);
} catch (OutOfRangeException $e) {
echo $e->getMessage();
}
В результате, на экране появится:
00000000
Номер сегмента должен быть между 1 и 5 / Segment number must be between 1 and 5.
### Перевод из строки.
За перевод из строки отвечают 2 метода: конструктор и `Parse`.
#### Метод `Parse`
Этот статический метод переводит строку в GUID. Он принимает только **1 обязательный параметр** - строковое
представление
GUID `string $guidString` и **1 необязательный параметр** - действие при некорректном GUID `bool $emptyIfNotValid`:
`true` - вернётся пустой GUID, `false` - выбросится исключение типа `InvalidArgumentException`, который по умолчанию
выбрасывает исключение.
Метод возвращает объект класса `GUID`, полученный из строкового представления.
**ВАЖНО:** может выбрасываться исключение `InvalidArgumentException` при некорректном GUID и отключённом параметре
`$emptyIfNotValid`.
Синтаксис:
public static function Parse (string $guidString, bool $emptyIfNotValid = false): GUID
**Пример:**
// Создаю пустой GUID
$guid1 = GUID::Parse ('00000000-0000-0000-0000-000000000000', true);
// Вывожу его
echo "guid1 = $guid1";
// Разделитель
echo '<br>';
try {
// Создаю из ошибочного GUID
$guid2 = GUID::Parse('ЭТО ОШИБКА!!!')
} catch (InvalidArgumentException $e) {
echo $e->getMessage();
}
В результате, на экране появится:
00000000-0000-0000-0000-000000000000
Предан неверный GUID / Wrong GUID.
### Работа с массивом байтов
Для преобразования GUID в массив байтов и обратно используется 2 метода: `ToBytes` и `FromBytes`.
#### Метод `ToBytes`
Это метод переводит GUID в массив байтов. Он не имеет никаких параметров.
Этот метод возвращает `array`: массив байтов, полученный из GUID.
Синтаксис:
public function ToBytes (): array
**Пример,**
// Создаю пустой GUID
$guid = new GUID ('00000000-0000-0000-0000-000000000000');
// Вывожу его значение в строку
$r = var_export($guid->ToBytes());
// И вывожу их
echo $r;
В результате, на экране появится:
array(16) {
[1] => int(0)
[2] => int(0)
[3] => int(0)
[4] => int(0)
[5] => int(0)
[6] => int(0)
[7] => int(0)
[8] => int(0)
[9] => int(0)
[10] => int(0)
[11] => int(0)
[12] => int(0)
[13] => int(0)
[14] => int(0)
[15] => int(0)
[16] => int(0)
}
#### Метод `FromBytes`
Это статический метод, который переводит массив байтов, заданный в параметре `array $bytes` в класс GUID.
Этот метод возвращает экземпляр класса `GUID`: значение массива байт в GUID.
Синтаксис:
public static function FromBytes (array $bytes): GUID
**Пример,**
// Создаю массив
$array = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
// Конвертирую
$guid = GUID::FromBytes($array);
// И вывожу его
echo $guid;
В результате, на экране появится:
00000000-0000-0000-0000-000000000000
### Генерация GUID
За генерацию GUID отвечает статический метод `Generate`. Это метод не имеет параметров и возвращает сгенерированный
GUID.
Синтаксис:
public static function Generate (): GUID
**Пример,**
// Создаю GUID
$guid = GUID::Generate ();
// Выводим
echo $guid;
В результате, например, на экране появится:
5c0e5f0e-d033-44b1-a0b6-d0e2e369bdd1
### Валидация GUID
Для валидации GUID используется 2 метода: `Validate` и `isInvalidOrEmpty`.
#### Метод `Validate`
Это статичный метод проверяет корректность GUID. Он имеет только **1 параметр** - объект GUID или его строковое представление для проверки `GUID|null|string $guid`.
Этот метод возвращает `bool`: результат проверки.
Синтаксис:
public static function Validate (string|GUID|null $guid): bool
**Пример,**
// Валидация класса GUID
echo GUID::Validate(new GUID ('00000000-0000-0000-0000-000000000000')) ? 'GUID верен' : 'GUID ошибочен';
// Разделитель
echo '<br>';
// Валидация строки
echo GUID::Validate('5c0e5f0e-d033-44b1-a0b6-d0e2e369bdd1') ? 'GUID верен' : 'GUID ошибочен';
// Разделитель
echo '<br>';
// Валидация ошибки
echo GUID::Validate('НЕ GUID') ? 'GUID верен' : 'GUID ошибочен';
В результате, на экране появится:
GUID верен
GUID верен
GUID ошибочен
#### Метод `isInvalidOrEmpty`
Это статический метод, который проверяет объекты GUID на корректность и на «пустое» значение. Он имеет только **1 параметр** - объект GUID или `null` для проверки `?GUID $guid`.
Этот метод возвращает `bool`: результат проверки GUID.
Синтаксис:
public static function isInvalidOrEmpty (?GUID $guid): bool
**Пример,**
// Валидация класса GUID
echo GUID::isInvalidOrEmpty(new GUID ('5c0e5f0e-d033-44b1-a0b6-d0e2e369bdd1')) ? 'GUID верен' : 'GUID ошибочен';
// Разделитель
echo '<br>';
// Валидация пустого GUID
echo GUID::isInvalidOrEmpty('00000000-0000-0000-0000-000000000000') ? 'GUID верен' : 'GUID ошибочен';
// Разделитель
echo '<br>';
// Валидация null
echo GUID::isInvalidOrEmpty(null) ? 'GUID верен' : 'GUID ошибочен';
В результате, на экране появится:
GUID верен
GUID ошибочен
GUID ошибочен
### Пустой GUID
За получение пустого GUID отвечает статический метод `Empty`. Это метод не имеет параметров и возвращает пустой GUID (`00000000-0000-0000-0000-000000000000`)
Синтаксис:
public static function Empty (): GUID
**Пример,**
// Выводим
echo GUID::Empty();
В результате, на экране появится:
00000000-0000-0000-0000-000000000000

276
sources/types/GUID.php Normal file
View File

@@ -0,0 +1,276 @@
<?php
namespace goodboyalex\php_components_pack\types;
use goodboyalex\php_components_pack\extensions\StringExtension;
use goodboyalex\php_components_pack\interfaces\IArrayable;
use goodboyalex\php_components_pack\interfaces\IComparable;
use goodboyalex\php_components_pack\interfaces\IDuplicated;
use goodboyalex\php_components_pack\interfaces\IHashable;
use goodboyalex\php_components_pack\interfaces\ISerializable;
use goodboyalex\php_components_pack\traits\GUID\GUIDArrayableTrait;
use goodboyalex\php_components_pack\traits\GUID\GUIDComparableTrait;
use goodboyalex\php_components_pack\traits\GUID\GUIDDuplicatedTrait;
use goodboyalex\php_components_pack\traits\GUID\GUIDHashableTrait;
use goodboyalex\php_components_pack\traits\GUID\GUIDJsonSerializableTrait;
use goodboyalex\php_components_pack\traits\GUID\GUIDSerializeTrait;
use InvalidArgumentException;
use JsonSerializable;
use LengthException;
use OutOfRangeException;
use Throwable;
/**
* Определение константы для пустого GUID как строки.
*/
if (!defined('GUID_EMPTY'))
define('GUID_EMPTY', '00000000-0000-0000-0000-000000000000');
/**
* Класс GUID предназначен для работы с уникальными идентификаторами формата UUID/GUID.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0.1
* @since 1.2
*/
final class GUID implements IArrayable, IDuplicated, ISerializable, IComparable, IHashable, JsonSerializable
{
/**
* @var string $Value Внутреннее свойство для хранения значения GUID.
*/
private string $Value {
get => StringExtension::IsNullOrWhitespace($this->Value) ? GUID_EMPTY : $this->Value;
set {
if (!self::Validate($value))
throw new InvalidArgumentException('Неверный идентификатор (GUID) / Wrong GUID identifier.');
$this->Value = $value;
}
}
/**
* Конструктор GUID-класса.
*
* @param string $value Значение GUID. По умолчанию, пустой GUID.
*
* @see GUID_EMPTY
*/
public function __construct (string $value = GUID_EMPTY)
{
$this->Value = $value;
}
/**
* Генерация нового случайного GUID.
*
* @return GUID Новый уникальный GUID.
*/
public static function Generate (): GUID
{
try {
// Генерация случайных значений для GUID
$randomParts = [
// - 32-разрядная часть поля time_low
random_int(0, 0xffff),
// - продолжение time_low
random_int(0, 0xffff),
// - 16-разрядная часть поля time_mid
random_int(0, 0xffff),
// - версии бит в time_hi_and_version
random_int(0, 0x0fff) | 0x4000,
// - различные биты в clk_seq_hi_res и clk_seq_low
random_int(0, 0x3fff) | 0x8000,
// - первые 16 бит node_id
random_int(0, 0xffff),
// - продолжение node_id (вторые 16 бит)
random_int(0, 0xffff),
// - последние 16 бит node_id
random_int(0, 0xffff)
];
// Формирование GUID из случайных значений
$guid = vsprintf('%04x%04x-%04x-%04x-%04x-%04x%04x%04x', $randomParts);
}
catch (Throwable) {
// Если возникла ошибка при генерации GUID, возвращаем пустой GUID
$guid = GUID_EMPTY;
}
// Создание экземпляра GUID со сгенерированным значением и возврат его
return new self($guid);
}
// Подключаем трейт реализующий интерфейс ISerializable
use GUIDSerializeTrait;
// Подключаем трейт реализующий интерфейс IArrayable
use GUIDArrayableTrait;
// Подключаем трейт реализующий интерфейс IDuplicated
use GUIDDuplicatedTrait;
// Подключаем трейт реализующий интерфейс JsonSerializable
use GUIDJsonSerializableTrait;
// Подключаем трейт реализующий интерфейс IHashable
use GUIDHashableTrait;
// Подключаем трейт реализующий интерфейс IComparable
use GUIDComparableTrait;
/**
* Проверяет, является ли GUID пустым или недействительным.
*
* @param GUID|null $guid Экземпляр GUID или null.
*
* @return bool True, если GUID недействителен или равен пустому значению.
*/
public static function IsInvalidOrEmpty (?GUID $guid): bool
{
return !self::Validate($guid) || $guid->IsEqualsTo(self::Empty());
}
/**
* Валидирует строку GUID.
*
* @param string|GUID|null $guid Объект GUID или его строковое представление для проверки.
*
* @return bool Результат проверки.
*/
public static function Validate (string|GUID|null $guid): bool
{
// Проверка на пустое значение
if (empty($guid))
// - если пустое, то возвращаем false
return false;
// Проверка на тип GUID
if ($guid instanceof GUID)
// - если GUID, то переводим его в строку
$guid = $guid->Value;
// Проверка на соответствие формату GUID
return preg_match('/^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$/', $guid) > 0;
}
/**
* Возвращает пустой GUID.
*
* @return GUID Пустой GUID.
*/
public static function Empty (): GUID
{
return new GUID();
}
/**
* Создает экземпляр GUID из массива байтов.
*
* @param array $bytes Массив байтов GUID.
*
* @return GUID Класс GUID
*/
public static function FromBytes (array $bytes): GUID
{
// Проверка на корректность массива байтов
if (count($bytes) != 16)
// - если массив байтов не содержит 16 байтов, выбрасываем исключение
throw new LengthException('Массив байтов должен содержать 16 байтов / Bytes array must contain 16 bytes.');
// Преобразование массива байтов в строку
$hex = bin2hex(pack('C*', ...$bytes));
// Создание GUID из преобразованной строки
$guid =
new GUID(substr($hex, 0, 8) . '-' . substr($hex, 8, 4) . '-' . substr($hex, 12, 4) . '-' . substr($hex, 16,
4) . '-' . substr($hex, 20, 12));
// Возврат экземпляра GUID
return new GUID($guid);
}
/**
* Создает экземпляр GUID из строки GUID.
*
* @param string $guidString Строковое представление GUID.
* @param bool $emptyIfNotValid Если GUID недействителен, возвращать пустой GUID или выбрасывать исключение. По
* умолчанию: выбрасывать исключение.
*
* @return GUID Экземпляр GUID.
*/
public static function Parse (string $guidString, bool $emptyIfNotValid = false): GUID
{
// Проверка на валидность GUID
if (self::Validate($guidString))
// - если GUID действителен, возвращаем экземпляр GUID
return new GUID($guidString);
// Если же GUID недействителен и запрещено выбрасывать исключение
if ($emptyIfNotValid)
// -- то возвращаем пустой GUID
return self::Empty();
else
// -- иначе выбрасываем исключение
throw new InvalidArgumentException('Предан неверный GUID / Wrong GUID.');
}
/**
* Возвращает сегмент GUID по его номеру.
*
* @param int $segmentNumber Номер сегмента: 1 - time_low, 2 - time_mid, 3 - time_hi_and_version, 4 -
* clk_seq_hi_res и clk_seq_low, 5 - node_id. В случае, если номер сегмента некорректен, выбрасывается
* исключение <code>OutOfRangeException</code>.
*
* @return string Сегмент GUID.
* @throws OutOfRangeException Если номер сегмента некорректен.
*/
public function Segment (int $segmentNumber): string
{
// Проверка на корректность номера сегмента
if ($segmentNumber < 1 || $segmentNumber > 5)
// - если номер сегмента некорректен, выбрасываем исключение
throw new OutOfRangeException('Номер сегмента должен быть между 1 и 5 / Segment number must be between 1 and 5.');
// Разделение GUID на сегменты по дефисам
$segments = explode('-', $this->Value);
// Возврат нужного сегмента
return $segments[$segmentNumber - 1];
}
/**
* Возвращает массив байтов GUID.
*
* @return array Массив байтов GUID.
*/
public function ToBytes (): array
{
// Разделение GUID на части
[$data1, $data2, $data3, $data4_1, $data4_2, $data5] =
sscanf($this->Value, "%08s-%04s-%04s-%04s-%04s%012s");
// Преобразование в массив байтов
return unpack('C*', hex2bin($data1 . $data2 . $data3 . $data4_1 . $data4_2 . $data5));
}
/**
* Возвращает строковое представление GUID.
*
* @return string Строковое представление GUID.
*/
public function ToString (): string
{
return $this->__toString();
}
/**
* Преобразует объект GUID в строку.
*
* @return string Строковое представление GUID.
*/
public function __toString (): string
{
return $this->Value;
}
}

View File

@@ -4,7 +4,7 @@ namespace goodboyalex\php_components_pack\tests\classes;
use goodboyalex\php_components_pack\classes\ActionState; use goodboyalex\php_components_pack\classes\ActionState;
use goodboyalex\php_components_pack\enums\MessageType; use goodboyalex\php_components_pack\enums\MessageType;
use goodboyalex\php_components_pack\models\ActionStateMessageModel; use goodboyalex\php_components_pack\models\ActionStateMessage;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
class ActionStateTest extends TestCase class ActionStateTest extends TestCase
@@ -29,7 +29,7 @@ class ActionStateTest extends TestCase
$this->assertEquals(2, $messages->Count()); $this->assertEquals(2, $messages->Count());
$this->assertEquals("Non critical error", $this->assertEquals("Non critical error",
$actionState->GetStringMessages(fn (ActionStateMessageModel $message) $actionState->GetStringMessages(fn (ActionStateMessage $message)
=> $message->MessageType => $message->MessageType
== MessageType::Error == MessageType::Error
&& !$message->IsCritical)); && !$message->IsCritical));
@@ -51,4 +51,4 @@ class ActionStateTest extends TestCase
require_once __DIR__ . '/../../sources/traits/ActionState/ActionStateStaticTrait.php'; require_once __DIR__ . '/../../sources/traits/ActionState/ActionStateStaticTrait.php';
require_once __DIR__ . '/../../sources/enums/MessageType.php'; require_once __DIR__ . '/../../sources/enums/MessageType.php';
} }
} }

View File

@@ -27,6 +27,7 @@ class ClassMapperTest extends TestCase
{ {
require_once __DIR__ . '/../data/A.php'; require_once __DIR__ . '/../data/A.php';
require_once __DIR__ . '/../data/B.php'; require_once __DIR__ . '/../data/B.php';
require_once __DIR__ . '/../../sources/attributes/GetOnly.php';
require_once __DIR__ . '/../../sources/classes/classMapper.php'; require_once __DIR__ . '/../../sources/classes/classMapper.php';
} }
} }

View File

@@ -31,18 +31,6 @@ class DictionaryTest extends TestCase
require_once __DIR__ . '/../../sources/classes/Dictionary.php'; require_once __DIR__ . '/../../sources/classes/Dictionary.php';
} }
public function testSerialize ()
{
$this->PrepareForTest();
$dict = new Dictionary();
$dict->Add('1', 1);
$dict->Add('2', '2');
$dict->Add('3', true);
$this->assertEquals("{\"1\":1,\"2\":\"2\",\"3\":true}", $dict->Serialize());
}
public function testGet () public function testGet ()
{ {
$this->PrepareForTest(); $this->PrepareForTest();
@@ -99,4 +87,68 @@ class DictionaryTest extends TestCase
$this->assertTrue($dict->Has('3')); $this->assertTrue($dict->Has('3'));
$this->assertFalse($dict->Has('4')); $this->assertFalse($dict->Has('4'));
} }
public function testKeys ()
{
$this->PrepareForTest();
$dict = new Dictionary();
$dict->Add('1', 1);
$dict->Add('3', true);
$dict->Add('2', '2');
$array = ['1', '3', '2'];
$this->assertArrayIsEqualToArrayIgnoringListOfKeys($array, $dict->Keys(), []);
}
public function testSort ()
{
$this->PrepareForTest();
$dict = new Dictionary();
$dict->Add('1', 1);
$dict->Add('3', true);
$dict->Add('2', '2');
$array = ['1', '2', '3'];
$dict->Sort();
$this->assertArrayIsEqualToArrayIgnoringListOfKeys($array, $dict->Keys(), []);
}
public function testAddRange ()
{
$this->PrepareForTest();
$dict = new Dictionary();
$dict->Add('1', 1);
$array = ['2' => '2', '3' => true, '4' => false];
$dict->AddRange($array);
$this->assertEquals(1, $dict->Get('1'));
$this->assertTrue($dict->Get('3'));
$this->assertEquals(4, $dict->count());
$this->assertFalse($dict->Get("4"));
}
public function testToArray ()
{
$this->PrepareForTest();
$dict = new Dictionary();
$dict->Add('1', 1);
$dict->Add('3', true);
$dict->Add('2', '2');
$array = $dict->ToArray();
$this->assertIsArray($array);
$this->assertEquals(1, $array['1']);
$this->assertTrue($array['3']);
$this->assertCount(3, $array);
}
} }

View File

@@ -0,0 +1,94 @@
<?php
namespace goodboyalex\php_components_pack\tests\classes;
use goodboyalex\php_components_pack\classes\File;
use PHPUnit\Framework\TestCase;
class FileTest extends TestCase
{
public function testExtractFileName ()
{
$this->PrepareForTest();
$this->assertEquals("test.txt", File::ExtractFileName("c:\\tmp\\test.txt"));
$this->assertEquals("test.txt", File::ExtractFileName("c:/tmp/test.txt"));
$this->assertEquals("test.txt", File::ExtractFileName("\\tmp\\test.txt"));
}
private function PrepareForTest (): void
{
require_once __DIR__ . '/../../sources/classes/File.php';
}
public function testFindFiles ()
{
$this->PrepareForTest();
$result = File::FindFiles(__DIR__);
$this->assertIsArray($result);
$this->assertCount(8, $result);
}
public function testGetRelativePath ()
{
$this->PrepareForTest();
$fullPath = "c:\\source\\tmp\\test.txt";
$basePath = "c:\\source\\";
$this->assertEquals("tmp\\test.txt", File::GetRelativePath($fullPath, $basePath));
}
public function testExtractFileExtension ()
{
$this->PrepareForTest();
$this->assertEquals("txt", File::ExtractFileExtension("c:\\tmp\\test.txt"));
$this->assertEquals("txt", File::ExtractFileExtension("c:/tmp/test.txt"));
$this->assertEquals("txt", File::ExtractFileExtension("\\tmp\\test.txt"));
}
public function testExtractFileNameWithoutExtension ()
{
$this->PrepareForTest();
$this->assertEquals("test", File::ExtractFileNameWithoutExtension("c:\\tmp\\test.txt"));
$this->assertEquals("test", File::ExtractFileNameWithoutExtension("c:/tmp/test.txt"));
$this->assertEquals("test", File::ExtractFileNameWithoutExtension("\\tmp\\test.txt"));
}
public function testRemoveDir ()
{
/**
* ВАЖНО! Перед запуском теста необходимо создать директорию D:\TestDelete и наполнить её ненужными файлами
*/
$this->PrepareForTest();
$result = File::RemoveDir("D:/TestDelete");
$this->assertTrue($result->Value);
$this->assertFalse(File::DirectoryExists("D:\\TestDelete"));
}
public function testFileSize ()
{
$this->PrepareForTest();
$size = File::FileSize("C:\\Windows/explorer.exe");
$this->assertEquals(2774080, $size->Value);
}
public function testFileSizeString ()
{
$this->PrepareForTest();
$size = File::FileSizeToString(2774080);
$this->assertEquals("2,65 МБ", $size);
}
}

View File

@@ -0,0 +1,319 @@
<?php
namespace goodboyalex\php_components_pack\tests\classes;
use goodboyalex\php_components_pack\classes\File;
use goodboyalex\php_components_pack\classes\BoolEx;
use goodboyalex\php_components_pack\exceptions\JsonException;
use goodboyalex\php_components_pack\tests\data\A;
use goodboyalex\php_components_pack\tests\data\C;
use PHPUnit\Framework\TestCase;
class JsonReWriterTest extends TestCase
{
public function testIsKeyExists ()
{
$this->PrepareForTest();
$json = new BoolEx();
try {
$json->Write("test/subtest/AAA", "123");
}
catch (JsonException $e) {
echo $e->getMessage();
}
$this->assertTrue($json->IsKeyExists("test/subtest/AAA"));
}
private function PrepareForTest (): void
{
require_once __DIR__ . '/../../sources/exceptions/JsonException.php';
require_once __DIR__ . '/../../sources/traits/JsonReWriter/JsonReWriterDeleteTrait.php';
require_once __DIR__ . '/../../sources/traits/JsonReWriter/JsonReWriterKeyTrait.php';
require_once __DIR__ . '/../../sources/traits/JsonReWriter/JsonReWriterLoadSaveTrait.php';
require_once __DIR__ . '/../../sources/traits/JsonReWriter/JsonReWriterReadTrait.php';
require_once __DIR__ . '/../../sources/traits/JsonReWriter/JsonReWriterWriteTrait.php';
require_once __DIR__ . '/../../sources/classes/JsonReWriter.php';
require_once __DIR__ . '/../data/A.php';
require_once __DIR__ . '/../data/C.php';
}
public function testReadWriteInt ()
{
$this->PrepareForTest();
$json = new BoolEx();
try {
$json->Write("test/test", 123);
}
catch (JsonException $e) {
echo $e->getMessage();
}
$this->assertEquals(123, $json->ReadInt("test/test"));
}
public function testReadWriteBool ()
{
$this->PrepareForTest();
$json = new BoolEx();
try {
$json->Write("test/test1", false);
$json->Write("test/test2", true);
}
catch (JsonException $e) {
echo $e->getMessage();
}
$this->assertTrue($json->ReadBool("test/test2"));
$this->assertFalse($json->ReadBool("test/test1"));
}
public function testReadWriteString ()
{
$this->PrepareForTest();
$json = new BoolEx();
try {
$json->Write("test/test", "test string");
}
catch (JsonException $e) {
echo $e->getMessage();
}
$this->assertEquals("test string", $json->ReadString("test/test", "test this"));
}
public function testSaveToFile ()
{
$this->PrepareForTest();
$fileName = __DIR__ . "/test.json";
if (file_exists($fileName))
unlink($fileName);
$json = new BoolEx();
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->WriteArray("test3/test/res", [1, 2, 3]);
}
catch (JsonException $e) {
echo $e->getMessage();
}
$json->SaveToFile($fileName);
$this->assertFileExists($fileName);
$size = File::FileSize($fileName)->Value;
$this->assertEquals(268, $size);
unlink($fileName);
}
public function testReadWriteArray ()
{
$this->PrepareForTest();
$json = new BoolEx();
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->WriteArray("test3/test/res", [1, 2, 3]);
}
catch (JsonException $e) {
echo $e->getMessage();
}
$this->assertArrayIsEqualToArrayIgnoringListOfKeys([1, 2, 3], $json->ReadArray("test3/test/res"), []);
}
public function testClear ()
{
$this->PrepareForTest();
$json = new BoolEx();
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->WriteArray("test3/test/res", [1, 2, 3]);
}
catch (JsonException $e) {
echo $e->getMessage();
}
$json->Clear();
$this->assertCount(0, $json->GetKeys());
}
public function testReadWriteObject ()
{
$this->PrepareForTest();
$json = new BoolEx();
$class = new A("test", 123, true);
try {
$json->WriteObject("test", $class);
}
catch (JsonException $e) {
echo $e->getMessage();
}
$this->assertEquals("test", $json->ReadObject("test", new A())->a);
}
public function testLoadFromFile ()
{
$this->PrepareForTest();
$fileName = __DIR__ . "/test.json";
if (file_exists($fileName))
unlink($fileName);
$json = new BoolEx();
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->WriteArray("test3/test/res", [1, 2, 3]);
}
catch (JsonException $e) {
echo $e->getMessage();
}
$json->SaveToFile($fileName);
unset($json);
$json = new BoolEx();
$json->LoadFromFile($fileName);
unlink($fileName);
$this->assertEquals(123, $json->ReadInt("test1/test"));
}
public function testDeleteKey ()
{
$this->PrepareForTest();
$json = new BoolEx();
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->WriteArray("test3/test/res", [1, 2, 3]);
}
catch (JsonException $e) {
echo $e->getMessage();
}
$json->DeleteKey("test3/test/res");
$this->assertFalse($json->IsKeyExists("test3/test/res"));
}
public function testReadWrite ()
{
$this->PrepareForTest();
$json = new BoolEx();
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->Write("test3/test/res", json_encode([1, 2, 3]));
}
catch (JsonException $e) {
echo $e->getMessage();
}
$this->assertTrue($json->IsKeyExists("test/subtest/AAA"));
$this->assertTrue($json->IsKeyExists("test1/test"));
$this->assertEquals(1.23, (float)$json->Read("test/subtest/BBB"));
}
public function testGetKeys ()
{
$this->PrepareForTest();
$json = new BoolEx();
try {
$json->Write("test/subtest/AAA", "123");
$json->Write("test/subtest/BBB", 1.23);
$json->Write("test1/test", 123);
$json->Write("test2/test", true);
$json->WriteArray("test3/test/res", [1, 2, 3]);
}
catch (JsonException $e) {
echo $e->getMessage();
}
$this->assertCount(11, $json->GetKeys());
$this->assertCount(2, $json->GetKeys("test/subtest"));
}
public function testReadWriteSerializable ()
{
$this->PrepareForTest();
$serializableClass = new C("test", 123, true);
$json = new BoolEx();
try {
$json->WriteSerializable("test", $serializableClass);
/**
* @var C $unSerializableClass Получаем объект из файла
*/
$unSerializableClass = $json->ReadSerializable("test", "goodboyalex\\php_components_pack\\tests\\data\\C");
}
catch (JsonException $e) {
echo $e->getMessage();
return;
}
$this->assertEquals($serializableClass->stringC, $unSerializableClass->stringC);
$this->assertEquals($serializableClass->intC, $unSerializableClass->intC);
$this->assertEquals($serializableClass->boolC, $unSerializableClass->boolC);
}
public function testReadWriteFloat ()
{
$this->PrepareForTest();
$json = new BoolEx();
try {
$json->Write("test", 1.23);
}
catch (JsonException $e) {
echo $e->getMessage();
}
$this->assertEquals(1.23, $json->ReadFloat("test", 0.2));
}
}

View File

@@ -3,8 +3,14 @@
namespace goodboyalex\php_components_pack\tests\classes; namespace goodboyalex\php_components_pack\tests\classes;
use goodboyalex\php_components_pack\classes\ObjectArray; use goodboyalex\php_components_pack\classes\ObjectArray;
use goodboyalex\php_components_pack\enums\ObjectArraySerializeMethod;
use goodboyalex\php_components_pack\models\ObjectArraySerializeOptions;
use goodboyalex\php_components_pack\tests\data\A; use goodboyalex\php_components_pack\tests\data\A;
use goodboyalex\php_components_pack\tests\data\B;
use goodboyalex\php_components_pack\tests\data\C;
use goodboyalex\php_components_pack\tests\data\D;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
use stdClass;
class ObjectArrayTest extends TestCase class ObjectArrayTest extends TestCase
{ {
@@ -38,6 +44,8 @@ class ObjectArrayTest extends TestCase
{ {
require_once __DIR__ . '/../data/A.php'; require_once __DIR__ . '/../data/A.php';
require_once __DIR__ . '/../data/B.php'; require_once __DIR__ . '/../data/B.php';
require_once __DIR__ . '/../data/C.php';
require_once __DIR__ . '/../data/D.php';
require_once __DIR__ . '/../../sources/interfaces/ISerializable.php'; require_once __DIR__ . '/../../sources/interfaces/ISerializable.php';
require_once __DIR__ . '/../../sources/traits/ArrayBasicTrait.php'; require_once __DIR__ . '/../../sources/traits/ArrayBasicTrait.php';
require_once __DIR__ . '/../../sources/traits/ObjectArray/ObjectArrayConstantsTrait.php'; require_once __DIR__ . '/../../sources/traits/ObjectArray/ObjectArrayConstantsTrait.php';
@@ -220,7 +228,7 @@ class ObjectArrayTest extends TestCase
$this->assertSame(['c', 'b'], $sr); $this->assertSame(['c', 'b'], $sr);
} }
public function testToArray () public function testAsArray ()
{ {
$this->PrepareForTest(); $this->PrepareForTest();
@@ -232,7 +240,7 @@ class ObjectArrayTest extends TestCase
$a_Array = new ObjectArray($array); $a_Array = new ObjectArray($array);
$sr = $a_Array->ToArray(); $sr = $a_Array->AsArray();
$this->assertIsArray($sr); $this->assertIsArray($sr);
$this->assertSame($array, $sr); $this->assertSame($array, $sr);
@@ -480,4 +488,117 @@ class ObjectArrayTest extends TestCase
$this->assertEquals(12, $a_Array->Count()); $this->assertEquals(12, $a_Array->Count());
} }
public function testSerializeEx ()
{
$this->PrepareForTest();
// Создаём тестовые классы
$class1 = new D ('test_string1', 12345, true, new A("test_string_A1", 6789, false),
new B("test_string_B1", 9876, "false"), new C("test_string_C1", 54321, true));
$class2 = new D ('test_string2', 123456, false, new A("test_string_A1", 678910, true),
new B("test_string_B2", 98765, "true"), new C("test_string_C2", 543210, false));
$class = new D ('test_string3', 123450, true, new A("test_string_A2", 67890, false),
new B("test_string_B3", 90876, "false"), new C("test_string_C3", 543201, true));
// Создаём массив объектов
$objectArray = new ObjectArray([$class1, $class2, $class]);
// Сериализуем
$serialized1 =
$objectArray->SerializeEx(new ObjectArraySerializeOptions(ObjectArraySerializeMethod::Serialize));
$serialized2 =
$objectArray->SerializeEx(new ObjectArraySerializeOptions(ObjectArraySerializeMethod::JsonEncode));
$serialized3 =
$objectArray->SerializeEx(new ObjectArraySerializeOptions(ObjectArraySerializeMethod::JsonEncodeWithToArray,
D::CLOSURE_TO_ARRAY()));
// Сохраняем в файл
file_put_contents(__DIR__ . 'serialized1.txt', $serialized1);
file_put_contents(__DIR__ . 'serialized2.txt', $serialized2);
file_put_contents(__DIR__ . 'serialized3.txt', $serialized3);
// Проверяем, что всё хорошо
$this->assertNotEmpty($serialized1);
$this->assertNotEmpty($serialized2);
$this->assertNotEmpty($serialized3);
}
public function testUnSerializeEx ()
{
$this->PrepareForTest();
// Загружаем данные
$serialized1 = file_get_contents(__DIR__ . 'serialized1.txt');
$serialized2 = file_get_contents(__DIR__ . 'serialized2.txt');
$serialized3 = file_get_contents(__DIR__ . 'serialized3.txt');
// Десериализуем
$objectArray1 = ObjectArray::UnSerializeEx($serialized1,
new ObjectArraySerializeOptions(ObjectArraySerializeMethod::Serialize));
$objectArray2 = ObjectArray::UnSerializeEx($serialized2,
new ObjectArraySerializeOptions(ObjectArraySerializeMethod::JsonEncode));
$objectArray3 = ObjectArray::UnSerializeEx($serialized3,
new ObjectArraySerializeOptions(ObjectArraySerializeMethod::JsonEncodeWithToArray,
onClassFrom: D::CLOSURE_FROM_ARRAY()));
// Проверяем, что всё хорошо
$this->assertEquals('test_string_A1',
$objectArray1->GetRow(fn (D $value) => $value->stringD == 'test_string1')->a->a);
$this->assertEquals('test_string_B2',
$objectArray2->GetRow(fn (stdClass $value) => $value->stringD == 'test_string2')->b->a);
$this->assertEquals('test_string_C3',
$objectArray3->GetRow(fn (D $value) => $value->stringD == 'test_string3')->c->stringC);
}
public function testToArray ()
{
$this->PrepareForTest();
// Создаём тестовые классы
$class1 = new D ('test_string1', 12345, true, new A("test_string_A1", 6789, false),
new B("test_string_B1", 9876, "false"), new C("test_string_C1", 54321, true));
$class2 = new D ('test_string2', 123456, false, new A("test_string_A1", 678910, true),
new B("test_string_B2", 98765, "true"), new C("test_string_C2", 543210, false));
$class = new D ('test_string3', 123450, true, new A("test_string_A2", 67890, false),
new B("test_string_B3", 90876, "false"), new C("test_string_C3", 543201, true));
// Создаём массив объектов
$objectArray = new ObjectArray([$class1, $class2, $class]);
// Сериализуем
$asArray = $objectArray->ToArray();
// Сохраняем в файл
file_put_contents(__DIR__ . 'serialized4.txt',
json_encode($asArray, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));
// Проверяем, что всё хорошо
$this->assertNotEmpty($asArray);
}
public function testFromArray ()
{
$this->PrepareForTest();
// Загружаем данные
$serialized = file_get_contents(__DIR__ . 'serialized4.txt');
// Десериализуем
$array = json_decode($serialized, true, flags: JSON_UNESCAPED_UNICODE);
// Создаём массив объектов
$objectArray = new ObjectArray();
// Получаем из массива
$objectArray->FromArray($array);
// Проверяем, что всё хорошо
$this->assertEquals('test_string_A1',
$objectArray->GetRow(fn (D $value) => $value->stringD == 'test_string1')->a->a);
$this->assertEquals('test_string_B2',
$objectArray->GetRow(fn (D $value) => $value->stringD == 'test_string2')->b->a);
$this->assertEquals('test_string_C3',
$objectArray->GetRow(fn (D $value) => $value->stringD == 'test_string3')->c->stringC);
}
} }

View File

@@ -0,0 +1,37 @@
<?php
namespace goodboyalex\php_components_pack\tests\classes;
use Exception;
use goodboyalex\php_components_pack\classes\Tuple;
use PHPUnit\Framework\TestCase;
class TupleTest extends TestCase
{
public function testTuple ()
{
$this->PrepareForTest();
$tuple = new Tuple(1, 'string', ['array1', 'array2', 'array3']);
// Проверка на то, что возвращает значение кортежа при запросе значения по индексу
$this->assertEquals(1, $tuple->Get(0));
$this->assertEquals('string', $tuple->Get(1));
$this->assertEquals(['array1', 'array2', 'array3'], $tuple->Get(2));
// Проверка на то, что возвращает переменные
[$firstElement, $secondElement, $thirdElement] = $tuple;
$this->assertEquals(1, $firstElement);
$this->assertEquals('string', $secondElement);
$this->assertEquals(['array1', 'array2', 'array3'], $thirdElement);
// Проверка на то, что выбрасывает исключение при попытке задать данные в кортеж после его создания
$this->expectException(Exception::class);
$tuple[] = 'New data';
}
private function PrepareForTest (): void
{
require_once __DIR__ . '/../../sources/classes/Tuple.php';
}
}

View File

@@ -0,0 +1,134 @@
<?php
namespace goodboyalex\php_components_pack\tests\classes;
use goodboyalex\php_components_pack\classes\ObjectArray;
use goodboyalex\php_components_pack\classes\VersionInfo;
use goodboyalex\php_components_pack\enums\VersionInfoStage;
use PHPUnit\Framework\TestCase;
class VersionInfoTest extends TestCase
{
public function testCompareWith ()
{
$this->PrepareForTest();
$versionInfo1 = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
$versionInfo2 = new VersionInfo(1, 1, 3, 4, VersionInfoStage::Alpha, 2);
$this->assertEquals(1, $versionInfo1->CompareWith($versionInfo2));
}
private function PrepareForTest (): void
{
require_once __DIR__ . '/../../sources/enums/VersionInfoStage.php';
require_once __DIR__ . '/../../sources/classes/VersionInfo.php';
}
public function test__toString ()
{
$this->PrepareForTest();
$versionInfo = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
$this->assertEquals('1.2.3.4 Beta 1', $versionInfo->__toString());
}
public function testToString ()
{
$this->PrepareForTest();
$versionInfo = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
$template = "Это #{Stage} #{StageNumber} версии #{Major}.#{Minor}.#{Release}.#{Build}";
$stageNames = [
VersionInfoStage::PreAlpha->value => 'рано',
VersionInfoStage::Alpha->value => 'начало',
VersionInfoStage::Beta->value => 'середнячок',
VersionInfoStage::ReleaseCandidate->value => 'почти',
VersionInfoStage::Stable->value => 'это релиз, детка!'
];
$this->assertEquals('Это середнячок 1 версии 1.2.3.4', $versionInfo->ToString($template, $stageNames));
}
public function testParse ()
{
$this->PrepareForTest();
$stageNames = [
VersionInfoStage::PreAlpha->value => 'pre',
VersionInfoStage::Alpha->value => 'alpha',
VersionInfoStage::Beta->value => 'beta',
VersionInfoStage::ReleaseCandidate->value => 'rc',
VersionInfoStage::Stable->value => 'stable'
];
$version = VersionInfo::Parse('1.2.3.4 beta 1', $stageNames);
$this->assertEquals(1, $version->Major);
$this->assertEquals(2, $version->Minor);
$this->assertEquals(3, $version->Release);
$this->assertEquals(4, $version->Build);
$this->assertEquals(VersionInfoStage::Beta, $version->Stage);
$this->assertEquals(1, $version->StageNumber);
}
public function test__construct ()
{
$this->PrepareForTest();
$version = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
$this->assertEquals(2, $version->Minor);
}
public function testCompare ()
{
$this->PrepareForTest();
$versionInfo1 = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
$versionInfo2 = new VersionInfo(1, 1, 3, 4, VersionInfoStage::Alpha, 2);
$this->assertEquals(1, VersionInfo::Compare($versionInfo1, $versionInfo2));
}
public function testCompareWithRange ()
{
$this->PrepareForTest();
$versionInfo1 = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
$versionInfo2 = new VersionInfo(1, 1, 3, 4, VersionInfoStage::Alpha, 2);
$versionInfo3 = new VersionInfo(1, 1, 1, 1, VersionInfoStage::Alpha, 2);
$versionInfo4 = new VersionInfo(5, 5, 5, 5, VersionInfoStage::Stable);
$optionNotBorder = new ObjectArray();
// Для начала простое сравнение
$this->assertEquals(0, $versionInfo1->CompareWithRange($versionInfo3, $versionInfo4));
$this->assertEquals(-1, $versionInfo2->CompareWithRange($versionInfo1, $versionInfo4));
$this->assertEquals(1, $versionInfo4->CompareWithRange($versionInfo2, $versionInfo1));
// Немного перепутаем границы =)
$this->assertEquals(1, $versionInfo4->CompareWithRange($versionInfo1, $versionInfo2));
// А теперь с границами
// - значение равно левой границе
$this->assertEquals(0, $versionInfo2->CompareWithRange($versionInfo2, $versionInfo1));
// - значение равно правой границе
$this->assertEquals(0, $versionInfo1->CompareWithRange($versionInfo2, $versionInfo1));
// - а теперь с выключением границ
// -- для левой
$this->assertEquals(-1, $versionInfo2->CompareWithRange($versionInfo2, $versionInfo1, $optionNotBorder));
// -- для правой
$this->assertEquals(1, $versionInfo1->CompareWithRange($versionInfo2, $versionInfo1, $optionNotBorder));
// А что если границы равны и значение равно
// - для включённых границ
$this->assertEquals(0, $versionInfo1->CompareWithRange($versionInfo1, $versionInfo1));
// - для выключённых границ
$this->assertEquals(-1, $versionInfo1->CompareWithRange($versionInfo1, $versionInfo1, $optionNotBorder));
}
}

36
tests/data/C.php Normal file
View File

@@ -0,0 +1,36 @@
<?php
namespace goodboyalex\php_components_pack\tests\data;
use goodboyalex\php_components_pack\interfaces\ISerializable;
class C implements ISerializable
{
public string $stringC;
public int $intC;
public bool $boolC;
public function __construct (string $string = "", int $int = 0, bool $bool = false)
{
$this->stringC = $string;
$this->intC = $int;
$this->boolC = $bool;
}
public function Serialize (): string
{
$array = [];
$array["string"] = $this->stringC;
$array["int"] = $this->intC;
$array["bool"] = $this->boolC;
return json_encode($array);
}
public function UnSerialize (string $serialized): void
{
$array = json_decode($serialized, true);
$this->stringC = $array["string"];
$this->intC = $array["int"];
$this->boolC = $array["bool"];
}
}

56
tests/data/D.php Normal file
View File

@@ -0,0 +1,56 @@
<?php
namespace goodboyalex\php_components_pack\tests\data;
use Closure;
use goodboyalex\php_components_pack\extensions\TypeExtension;
class D
{
public string $stringD;
public int $intD;
public bool $boolD;
public A $a;
public B $b;
public C $c;
public function __construct (string $string = "", int $int = 0, bool $bool = false, ?A $a = null, ?B $b = null,
?C $c = null)
{
$this->stringD = $string;
$this->intD = $int;
$this->boolD = $bool;
$this->a = $a ?? new A();
$this->b = $b ?? new B();
$this->c = $c ?? new C();
}
public static function CLOSURE_FROM_ARRAY (): Closure
{
return fn (array $classArray): object
=> $classArray['type_class'] == C::class
? self::CLOSURE_FROM_FOR_C($classArray["type_value"]) : TypeExtension::FromArray($classArray);
}
private static function CLOSURE_FROM_FOR_C (string $serializedC): object
{
$classC = new C();
$classC->UnSerialize($serializedC);
return $classC;
}
public static function CLOSURE_TO_ARRAY (): Closure
{
return fn (object $class): array => $class instanceof C ? self::CLOSURE_TO_FOR_C($class)
: TypeExtension::ToArray($class);
}
private static function CLOSURE_TO_FOR_C (C $class): array
{
return [
"type_class" => C::class,
"type_value" => $class->Serialize()
];
}
}

View File

@@ -2,7 +2,7 @@
namespace goodboyalex\php_components_pack\tests\extensions; namespace goodboyalex\php_components_pack\tests\extensions;
use Exception; use goodboyalex\php_components_pack\enums\VarNotBoolAction;
use goodboyalex\php_components_pack\extensions\BoolExtensions; use goodboyalex\php_components_pack\extensions\BoolExtensions;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
@@ -30,6 +30,7 @@ class BoolExtensionsTest extends TestCase
private function PrepareForTest (): void private function PrepareForTest (): void
{ {
require_once __DIR__ . '/../../sources/enums/VarNotBoolAction.php';
require_once __DIR__ . '/../../sources/extensions/BoolExtensions.php'; require_once __DIR__ . '/../../sources/extensions/BoolExtensions.php';
} }
@@ -46,23 +47,19 @@ class BoolExtensionsTest extends TestCase
$this->assertEquals(14, $this->assertEquals(14,
BoolExtensions::TrueCount($array)); BoolExtensions::TrueCount($array));
$this->expectException(Exception::class);
$array[] = "ПРЕДАТЕЛЬ!"; $array[] = "ПРЕДАТЕЛЬ!";
BoolExtensions::TrueCount($array); $this->assertEquals(14, BoolExtensions::TrueCount($array));
$this->assertEquals(14, BoolExtensions::TrueCount($array, VarNotBoolAction::ConsiderItFalse));
$this->assertEquals(15, BoolExtensions::TrueCount($array, VarNotBoolAction::ConsiderItTrue));
} }
public function testExportToString () public function testExportToString ()
{ {
$this->PrepareForTest(); $this->PrepareForTest();
$b = true; $this->assertEquals('О, да!', BoolExtensions::ExportToString(true, 'О, да!', 'О, нет!'));
$this->assertEquals('О, да!', BoolExtensions::ExportToString($b, 'О, да!', 'О, нет!')); $this->assertEquals('О, нет!', BoolExtensions::ExportToString(false, 'О, да!', 'О, нет!'));
$b = false;
$this->assertEquals('О, нет!', BoolExtensions::ExportToString($b, 'О, да!', 'О, нет!'));
} }
} }

View File

@@ -0,0 +1,91 @@
<?php
namespace goodboyalex\php_components_pack\tests\extensions;
use goodboyalex\php_components_pack\exceptions\TypeException;
use goodboyalex\php_components_pack\extensions\TypeExtension;
use goodboyalex\php_components_pack\tests\data\A;
use goodboyalex\php_components_pack\tests\data\B;
use goodboyalex\php_components_pack\tests\data\C;
use goodboyalex\php_components_pack\tests\data\D;
use PHPUnit\Framework\TestCase;
class TypeExtensionTest extends TestCase
{
public function testFromArray ()
{
// Подготавливаем данные к тестированию
$this->PrepareForTest();
// Зададим имя файла
$fileName = __DIR__ . "/class.txt";
// Если файл не найден
if (!file_exists($fileName))
// - то завершаем работу
die("The test data file could not be found or has not yet passed the ToArray test! / Файл с данными для тестирования не найден или не пройдено ещё тестирование ToArray!");
// Считываем данные из файла и преобразуем в массив
$array = json_decode(file_get_contents($fileName), true);
// Преобразуем в объект
try {
$class = TypeExtension::FromArray($array, D::CLOSURE_FROM_ARRAY());
}
catch (TypeException $e) {
// - если ошибка, то выводим её и завершаем работу
die($e->getMessage());
}
// Проверяем
$this->assertEquals(D::class, $class::class);
$this->assertEquals(A::class, $class->a::class);
$this->assertEquals(B::class, $class->b::class);
$this->assertEquals(9876, $class->b->b);
$this->assertEquals(C::class, $class->c::class);
$this->assertEquals(54321, $class->c->intC);
$this->assertEquals('test_string', $class->stringD);
}
private function PrepareForTest (): void
{
require_once __DIR__ . '/../../sources/exceptions/TypeException.php';
require_once __DIR__ . '/../../sources/extensions/TypeExtension.php';
require_once __DIR__ . '/../data/A.php';
require_once __DIR__ . '/../data/B.php';
require_once __DIR__ . '/../data/C.php';
require_once __DIR__ . '/../data/D.php';
}
public function testToArray ()
{
// Подготавливаем данные к тестированию
$this->PrepareForTest();
// Создаём тестовый класс
$class = new D ('test_string', 12345, true, new A("test_string_A", 6789, false),
new B("test_string_B", 9876, "false"), new C("test_string_C", 54321, true));
// Преобразуем в массив
try {
$array = TypeExtension::ToArray($class, D::CLOSURE_TO_ARRAY());
}
catch (TypeException $e) {
// - если ошибка, то выводим её и завершаем работу
die($e->getMessage());
}
// Сохраняем массив в файл (для тестирования FromArray)
file_put_contents(__DIR__ . "/class.txt", json_encode($array, JSON_PRETTY_PRINT));
// Проверяем
$this->assertEquals(D::class, $array['type_class']);
$this->assertEquals(A::class, $array['a']['type_class']);
$this->assertEquals(B::class, $array['b']['type_class']);
$this->assertEquals(9876, $array['b']['b']);
$this->assertEquals(C::class, $array['c']['type_class']);
$this->assertEquals('test_string', $array['stringD']);
$this->assertEquals(12345, $array['intD']);
$this->assertTrue($array['boolD']);
}
}

145
tests/types/GUIDTest.php Normal file
View File

@@ -0,0 +1,145 @@
<?php
namespace goodboyalex\php_components_pack\tests\types;
use goodboyalex\php_components_pack\types\GUID;
use InvalidArgumentException;
use OutOfRangeException;
use PHPUnit\Framework\TestCase;
class GUIDTest extends TestCase
{
public function test__construct ()
{
$this->PrepareForTest();
$guid = new GUID();
$this->assertEquals(GUID::Empty(), $guid->ToString());
}
private function PrepareForTest (): void
{
require_once __DIR__ . '/../../sources/interfaces/ISerializable.php';
require_once __DIR__ . '/../../sources/interfaces/IArrayable.php';
require_once __DIR__ . '/../../sources/interfaces/IComparable.php';
require_once __DIR__ . '/../../sources/interfaces/IHashable.php';
require_once __DIR__ . '/../../sources/interfaces/IDuplicated.php';
require_once __DIR__ . '/../../sources/types/GUID.php';
}
public function testSegment ()
{
$this->PrepareForTest();
$guid = new GUID ('00000000-0000-0000-0000-000000000000');
$this->assertEquals('00000000', $guid->Segment(1));
$this->expectException(OutOfRangeException::class);
$guid->Segment(0);
}
public function testToString ()
{
$this->PrepareForTest();
$guid = new GUID ('5c0e5f0e-d033-44b1-a0b6-d0e2e369bdd1');
$this->assertEquals('5c0e5f0e-d033-44b1-a0b6-d0e2e369bdd1', $guid->ToString());
}
public function testIsInvalidOrEmpty ()
{
$this->PrepareForTest();
$this->assertFalse(GUID::IsInvalidOrEmpty(new GUID ('5c0e5f0e-d033-44b1-a0b6-d0e2e369bdd1')));
$this->assertTrue(GUID::IsInvalidOrEmpty(new GUID ('00000000-0000-0000-0000-000000000000')));
$this->assertTrue(GUID::IsInvalidOrEmpty(null));
}
public function testParse ()
{
$this->PrepareForTest();
$guid = new GUID ('5c0e5f0e-d033-44b1-a0b6-d0e2e369bdd1');
$parsed = GUID::Parse('5c0e5f0e-d033-44b1-a0b6-d0e2e369bdd1', true);
$this->assertTrue($guid->IsEqualsTo($parsed));
$this->expectException(InvalidArgumentException::class);
GUID::Parse('НЕ GUID');
}
public function test__toString ()
{
$this->PrepareForTest();
$guid = new GUID ('5c0e5f0e-d033-44b1-a0b6-d0e2e369bdd1');
$str = "$guid";
$this->assertEquals('5c0e5f0e-d033-44b1-a0b6-d0e2e369bdd1', $str);
}
public function testToBytes ()
{
$this->PrepareForTest();
$guid = new GUID ('00000000-0000-0000-0000-000000000000');
$bytes = $guid->ToBytes();
$this->assertCount(16, $bytes);
$this->assertEquals(0, $bytes[0]);
$this->assertEquals(0, $bytes[1]);
$this->assertEquals(0, $bytes[2]);
$this->assertEquals(0, $bytes[3]);
$this->assertEquals(0, $bytes[4]);
$this->assertEquals(0, $bytes[5]);
$this->assertEquals(0, $bytes[6]);
$this->assertEquals(0, $bytes[7]);
$this->assertEquals(0, $bytes[8]);
$this->assertEquals(0, $bytes[9]);
$this->assertEquals(0, $bytes[10]);
$this->assertEquals(0, $bytes[11]);
$this->assertEquals(0, $bytes[12]);
$this->assertEquals(0, $bytes[13]);
$this->assertEquals(0, $bytes[14]);
$this->assertEquals(0, $bytes[15]);
}
public function testGenerate ()
{
$this->PrepareForTest();
$guid = GUID::Generate();
self::assertFalse(GUID::IsInvalidOrEmpty($guid));
}
public function testFromBytes ()
{
$this->PrepareForTest();
// Создаю массив
$array = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
// Конвертирую
$guid = GUID::FromBytes($array);
// И вывожу его
self::assertEquals('00000000-0000-0000-0000-000000000000', $guid->ToString());
}
public function testValidate ()
{
$this->PrepareForTest();
$this->assertTrue(GUID::Validate(new GUID ('00000000-0000-0000-0000-000000000000')));
$this->assertTrue(GUID::Validate('5c0e5f0e-d033-44b1-a0b6-d0e2e369bdd1'));
$this->assertFalse(GUID::Validate('НЕ GUID'));
}
}