Compare commits
12 Commits
Author | SHA1 | Date | |
---|---|---|---|
d217322a35 | |||
24bf2a009f | |||
f8f14244d0 | |||
04f6849ff4 | |||
2c3ea12fc1 | |||
e342c7f41f | |||
7e57e5cb56 | |||
62762374e0 | |||
117deab9d8 | |||
3fbb7dc81c | |||
83a76dc8e2 | |||
6e831e2650 |
7
.gitignore
vendored
7
.gitignore
vendored
@@ -78,4 +78,9 @@ fabric.properties
|
||||
.idea/caches/build_file_checksums.ser
|
||||
|
||||
.idea/
|
||||
vendor/
|
||||
vendor/
|
||||
/tests/extensions/class.txt
|
||||
/tests/classesserialized1.txt
|
||||
/tests/classesserialized2.txt
|
||||
/tests/classesserialized3.txt
|
||||
/tests/classesserialized4.txt
|
||||
|
@@ -20,7 +20,7 @@
|
||||
"ext-mbstring": "*"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^12.2.1"
|
||||
"phpunit/phpunit": "^12.2.7"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
|
30
composer.lock
generated
30
composer.lock
generated
@@ -4,21 +4,21 @@
|
||||
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
|
||||
"This file is @generated automatically"
|
||||
],
|
||||
"content-hash": "f5bf0ec4042cb12fb3a702cad65f099d",
|
||||
"content-hash": "45c3c2e33a7aa403660825318375a599",
|
||||
"packages": [],
|
||||
"packages-dev": [
|
||||
{
|
||||
"name": "myclabs/deep-copy",
|
||||
"version": "1.13.1",
|
||||
"version": "1.13.3",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/myclabs/DeepCopy.git",
|
||||
"reference": "1720ddd719e16cf0db4eb1c6eca108031636d46c"
|
||||
"reference": "faed855a7b5f4d4637717c2b3863e277116beb36"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/1720ddd719e16cf0db4eb1c6eca108031636d46c",
|
||||
"reference": "1720ddd719e16cf0db4eb1c6eca108031636d46c",
|
||||
"url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/faed855a7b5f4d4637717c2b3863e277116beb36",
|
||||
"reference": "faed855a7b5f4d4637717c2b3863e277116beb36",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
@@ -57,7 +57,7 @@
|
||||
],
|
||||
"support": {
|
||||
"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": [
|
||||
{
|
||||
@@ -65,7 +65,7 @@
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2025-04-29T12:36:36+00:00"
|
||||
"time": "2025-07-05T12:25:42+00:00"
|
||||
},
|
||||
{
|
||||
"name": "nikic/php-parser",
|
||||
@@ -579,16 +579,16 @@
|
||||
},
|
||||
{
|
||||
"name": "phpunit/phpunit",
|
||||
"version": "12.2.5",
|
||||
"version": "12.2.7",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/sebastianbergmann/phpunit.git",
|
||||
"reference": "b71849b29f7a8d7574e4401873cb8b539896613f"
|
||||
"reference": "8b1348b254e5959acaf1539c6bd790515fb49414"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/b71849b29f7a8d7574e4401873cb8b539896613f",
|
||||
"reference": "b71849b29f7a8d7574e4401873cb8b539896613f",
|
||||
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/8b1348b254e5959acaf1539c6bd790515fb49414",
|
||||
"reference": "8b1348b254e5959acaf1539c6bd790515fb49414",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
@@ -598,7 +598,7 @@
|
||||
"ext-mbstring": "*",
|
||||
"ext-xml": "*",
|
||||
"ext-xmlwriter": "*",
|
||||
"myclabs/deep-copy": "^1.13.1",
|
||||
"myclabs/deep-copy": "^1.13.3",
|
||||
"phar-io/manifest": "^2.0.4",
|
||||
"phar-io/version": "^3.2.1",
|
||||
"php": ">=8.3",
|
||||
@@ -656,7 +656,7 @@
|
||||
"support": {
|
||||
"issues": "https://github.com/sebastianbergmann/phpunit/issues",
|
||||
"security": "https://github.com/sebastianbergmann/phpunit/security/policy",
|
||||
"source": "https://github.com/sebastianbergmann/phpunit/tree/12.2.5"
|
||||
"source": "https://github.com/sebastianbergmann/phpunit/tree/12.2.7"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
@@ -680,7 +680,7 @@
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2025-06-27T04:37:55+00:00"
|
||||
"time": "2025-07-11T04:11:13+00:00"
|
||||
},
|
||||
{
|
||||
"name": "sebastian/cli-parser",
|
||||
@@ -1633,4 +1633,4 @@
|
||||
},
|
||||
"platform-dev": {},
|
||||
"plugin-api-version": "2.6.0"
|
||||
}
|
||||
}
|
@@ -8,7 +8,7 @@
|
||||
namespace goodboyalex\php_components_pack\classes;
|
||||
|
||||
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\ActionStateGetTrait;
|
||||
use goodboyalex\php_components_pack\traits\ActionState\ActionStateHasTrait;
|
||||
@@ -103,7 +103,7 @@ final class ActionState implements ISerializable
|
||||
// Для каждого сообщения
|
||||
foreach ($list as $messageSerialized) {
|
||||
// - создаю новое сообщение
|
||||
$message = new ActionStateMessageModel();
|
||||
$message = new ActionStateMessage();
|
||||
// - десериализую его
|
||||
$message->UnSerialize($messageSerialized);
|
||||
// - добавляю в список
|
||||
|
@@ -6,6 +6,7 @@ use DateTimeImmutable;
|
||||
use DateTimeInterface;
|
||||
use Exception;
|
||||
use goodboyalex\php_components_pack\attributes\GetOnly;
|
||||
use goodboyalex\php_components_pack\types\GUID;
|
||||
use ReflectionClass;
|
||||
use ReflectionException;
|
||||
use ReflectionProperty;
|
||||
@@ -341,6 +342,11 @@ final class ClassMapper
|
||||
*/
|
||||
$property->setAccessible(true);
|
||||
|
||||
// Если значение string, а требуется GUID
|
||||
if (is_string($value) && $property->getType()->getName() === GUID::class)
|
||||
// - то присваиваю значение GUID
|
||||
$value = GUID::Parse($value, true);
|
||||
|
||||
// Если значение null
|
||||
if (!is_bool($value) && ($value == null || $value == "null"))
|
||||
// - то присваиваю значение по умолчанию
|
||||
|
@@ -4,8 +4,13 @@ namespace goodboyalex\php_components_pack\classes;
|
||||
|
||||
use ArrayAccess;
|
||||
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\ISortable;
|
||||
use goodboyalex\php_components_pack\traits\ArrayBasicTrait;
|
||||
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayComparableTrait;
|
||||
use IteratorAggregate;
|
||||
|
||||
/**
|
||||
@@ -16,7 +21,8 @@ use IteratorAggregate;
|
||||
* @version 1.0.3
|
||||
* @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 Контейнер.
|
||||
@@ -26,33 +32,8 @@ final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISe
|
||||
// Реализация наследуемых интерфейсов и классов
|
||||
use ArrayBasicTrait;
|
||||
|
||||
/**
|
||||
* Добавление элементов в словарь.
|
||||
*
|
||||
* @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;
|
||||
}
|
||||
// Реализация интерфейса IComparable
|
||||
use ObjectArrayComparableTrait;
|
||||
|
||||
/**
|
||||
* Получение значения по ключу.
|
||||
@@ -95,16 +76,6 @@ final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISe
|
||||
return isset($this->Container[$key]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Очистка всех элементов.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Clear (): void
|
||||
{
|
||||
$this->Container = [];
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
@@ -124,13 +95,77 @@ final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISe
|
||||
}
|
||||
|
||||
/**
|
||||
* Сортирует внутренние данные по ключам.
|
||||
*
|
||||
* @param bool $descending Сортировать ли данные в обратном порядке?
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function ToArray (): array
|
||||
{
|
||||
return $this->Container;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function FromArray (array $array): void
|
||||
{
|
||||
// Очищаем словарь
|
||||
$this->Clear();
|
||||
|
||||
// Добавляем элементы в словарь
|
||||
$this->AddRange($array);
|
||||
}
|
||||
|
||||
/**
|
||||
* Очистка всех элементов.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Sort (bool $descending = false): void
|
||||
public function Clear (): void
|
||||
{
|
||||
$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
|
||||
*/
|
||||
public function Hash (): string
|
||||
{
|
||||
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)
|
||||
@@ -142,12 +177,12 @@ final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISe
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает все элементы словаря в виде массива.
|
||||
* @inheritDoc
|
||||
*
|
||||
* @return array Массив, содержащий все элементы словаря.
|
||||
* @warning Свойство <code>$propertyFunction</code> не используется.
|
||||
*/
|
||||
public function ToArray (): array
|
||||
public function SortCallback (callable $propertyFunction, bool $descending = false): void
|
||||
{
|
||||
return $this->Container;
|
||||
$this->Sort(descending: $descending);
|
||||
}
|
||||
}
|
@@ -4,12 +4,20 @@ namespace goodboyalex\php_components_pack\classes;
|
||||
|
||||
use ArrayAccess;
|
||||
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\ISortable;
|
||||
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\ObjectArrayHashableTrait;
|
||||
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayLINQTrait;
|
||||
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\ObjectArrayToArrayTrait;
|
||||
use IteratorAggregate;
|
||||
|
||||
/**
|
||||
@@ -17,10 +25,11 @@ use IteratorAggregate;
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0.5
|
||||
* @version 1.1
|
||||
* @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 Массив объектов, хранящихся в данном классе.
|
||||
@@ -42,6 +51,18 @@ final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, IS
|
||||
// Специальные методы
|
||||
use ObjectArraySpecialTrait;
|
||||
|
||||
// Расширенные методы для сериализации
|
||||
use ObjectArraySerializeExTrait;
|
||||
|
||||
// Реализация методов интерфейса IArrayable
|
||||
use ObjectArrayToArrayTrait;
|
||||
|
||||
// Реализация методов интерфейса IHashable
|
||||
use ObjectArrayHashableTrait;
|
||||
|
||||
// Реализация методов интерфейса IComparable
|
||||
use ObjectArrayComparableTrait;
|
||||
|
||||
/**
|
||||
* Конструктор класса.
|
||||
*
|
||||
|
40
sources/enums/ObjectArraySerializeMethod.php
Normal file
40
sources/enums/ObjectArraySerializeMethod.php
Normal 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;
|
||||
}
|
36
sources/exceptions/TypeException.php
Normal file
36
sources/exceptions/TypeException.php
Normal 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;
|
||||
}
|
||||
}
|
@@ -2,6 +2,7 @@
|
||||
|
||||
namespace goodboyalex\php_components_pack\extensions;
|
||||
|
||||
use Deprecated;
|
||||
use Random\RandomException;
|
||||
|
||||
/**
|
||||
@@ -11,12 +12,15 @@ use Random\RandomException;
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.0
|
||||
* @deprecated 1.2
|
||||
*
|
||||
*/
|
||||
final class GUIDExtension
|
||||
{
|
||||
/**
|
||||
* Пустой Guid.
|
||||
*/
|
||||
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
|
||||
public const string GUIDEmpty = "00000000-0000-0000-0000-000000000000";
|
||||
|
||||
/**
|
||||
@@ -24,6 +28,7 @@ final class GUIDExtension
|
||||
*
|
||||
* @return string Сгенерированный Guid.
|
||||
*/
|
||||
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
|
||||
public static function Generate (): string
|
||||
{
|
||||
// Цикл создания Guid
|
||||
@@ -41,6 +46,7 @@ final class GUIDExtension
|
||||
*
|
||||
* @return string Сгенерированный Guid.
|
||||
*/
|
||||
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
|
||||
private static function DoGenerate (): string
|
||||
{
|
||||
try {
|
||||
@@ -80,6 +86,7 @@ final class GUIDExtension
|
||||
*
|
||||
* @return bool Корректен ли Guid.
|
||||
*/
|
||||
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
|
||||
public static function Validate (?string $str): bool
|
||||
{
|
||||
// Если Guid пустой
|
||||
@@ -140,6 +147,7 @@ final class GUIDExtension
|
||||
*
|
||||
* @return bool Пустой ли GUID
|
||||
*/
|
||||
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
|
||||
public static function IsNotValidOrEmpty (?string $str): bool
|
||||
{
|
||||
return !self::Validate($str) || $str == self::GUIDEmpty;
|
||||
|
179
sources/extensions/TypeExtension.md
Normal file
179
sources/extensions/TypeExtension.md
Normal 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` типу.
|
235
sources/extensions/TypeExtension.php
Normal file
235
sources/extensions/TypeExtension.php
Normal 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;
|
||||
}
|
||||
}
|
30
sources/interfaces/IArrayable.php
Normal file
30
sources/interfaces/IArrayable.php
Normal 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;
|
||||
}
|
43
sources/interfaces/IComparable.php
Normal file
43
sources/interfaces/IComparable.php
Normal 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;
|
||||
}
|
21
sources/interfaces/IHashable.php
Normal file
21
sources/interfaces/IHashable.php
Normal 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;
|
||||
}
|
37
sources/interfaces/ISortable.php
Normal file
37
sources/interfaces/ISortable.php
Normal 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;
|
||||
}
|
@@ -6,14 +6,14 @@ use goodboyalex\php_components_pack\enums\MessageType;
|
||||
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
||||
|
||||
/**
|
||||
* Класс сообщения состояния.
|
||||
* Модель сообщения о состоянии.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @version 1.1
|
||||
* @since 1.0
|
||||
*/
|
||||
final class ActionStateMessageModel implements ISerializable
|
||||
final class ActionStateMessage implements ISerializable
|
||||
{
|
||||
/**
|
||||
* @var MessageType $MessageType Тип сообщения
|
52
sources/models/ObjectArraySerializeOptions.php
Normal file
52
sources/models/ObjectArraySerializeOptions.php
Normal 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;
|
||||
}
|
||||
}
|
@@ -5,7 +5,7 @@ namespace goodboyalex\php_components_pack\traits\ActionState;
|
||||
use goodboyalex\php_components_pack\classes\ActionState;
|
||||
use goodboyalex\php_components_pack\classes\ObjectArray;
|
||||
use goodboyalex\php_components_pack\enums\MessageType;
|
||||
use goodboyalex\php_components_pack\models\ActionStateMessageModel;
|
||||
use goodboyalex\php_components_pack\models\ActionStateMessage;
|
||||
|
||||
/**
|
||||
* Часть кода класса ActionState, отвечающая за методы добавления сообщений.
|
||||
@@ -30,7 +30,7 @@ trait ActionStateAddTrait
|
||||
// Если нужно очистить список сообщений
|
||||
if ($clearAllBefore)
|
||||
// - то очищаю список сообщений
|
||||
$this->Clear(fn (ActionStateMessageModel $message) => true);
|
||||
$this->Clear(fn (ActionStateMessage $message) => true);
|
||||
|
||||
// Добавляю сообщения из другого состояния
|
||||
$this->AddRange($state->GetMessages(ActionState::GET_STRING_ALL()));
|
||||
@@ -61,17 +61,17 @@ trait ActionStateAddTrait
|
||||
*/
|
||||
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
|
||||
*/
|
||||
public function Add (ActionStateMessageModel $message): void
|
||||
public function Add (ActionStateMessage $message): void
|
||||
{
|
||||
$this->Messages->Add($message);
|
||||
}
|
||||
@@ -85,7 +85,7 @@ trait ActionStateAddTrait
|
||||
*/
|
||||
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
|
||||
{
|
||||
$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
|
||||
{
|
||||
$this->Add(new ActionStateMessageModel(MessageType::Info, false, $message));
|
||||
$this->Add(new ActionStateMessage(MessageType::Info, false, $message));
|
||||
}
|
||||
}
|
@@ -3,7 +3,7 @@
|
||||
namespace goodboyalex\php_components_pack\traits\ActionState;
|
||||
|
||||
use goodboyalex\php_components_pack\enums\MessageType;
|
||||
use goodboyalex\php_components_pack\models\ActionStateMessageModel;
|
||||
use goodboyalex\php_components_pack\models\ActionStateMessage;
|
||||
|
||||
/**
|
||||
* Часть кода класса ActionState, отвечающая за методы проверки на наличие сообщений.
|
||||
@@ -22,7 +22,7 @@ trait ActionStateHasTrait
|
||||
*/
|
||||
public function HasInfos (): bool
|
||||
{
|
||||
return $this->Messages->IsExist(fn (ActionStateMessageModel $message)
|
||||
return $this->Messages->IsExist(fn (ActionStateMessage $message)
|
||||
=> $message->MessageType
|
||||
== MessageType::Info);
|
||||
}
|
||||
@@ -48,7 +48,7 @@ trait ActionStateHasTrait
|
||||
*/
|
||||
public function HasErrors (bool $onlyCritical = false): bool
|
||||
{
|
||||
return $this->Messages->IsExist(fn (ActionStateMessageModel $message): bool
|
||||
return $this->Messages->IsExist(fn (ActionStateMessage $message): bool
|
||||
=> $onlyCritical
|
||||
? $message->MessageType == MessageType::Error && $message->IsCritical
|
||||
: $message->MessageType == MessageType::Error);
|
||||
@@ -61,7 +61,7 @@ trait ActionStateHasTrait
|
||||
*/
|
||||
public function HasWarnings (): bool
|
||||
{
|
||||
return $this->Messages->IsExist(fn (ActionStateMessageModel $message)
|
||||
return $this->Messages->IsExist(fn (ActionStateMessage $message)
|
||||
=> $message->MessageType
|
||||
== MessageType::Warning);
|
||||
}
|
||||
|
@@ -4,7 +4,7 @@ namespace goodboyalex\php_components_pack\traits\ActionState;
|
||||
|
||||
use Closure;
|
||||
use goodboyalex\php_components_pack\enums\MessageType;
|
||||
use goodboyalex\php_components_pack\models\ActionStateMessageModel;
|
||||
use goodboyalex\php_components_pack\models\ActionStateMessage;
|
||||
|
||||
/**
|
||||
* Часть кода класса ActionState, отвечающая за статичные методы и константы.
|
||||
@@ -23,7 +23,7 @@ trait ActionStateStaticTrait
|
||||
*/
|
||||
public static function GET_STRING_ERROR_ONLY (): Closure
|
||||
{
|
||||
return fn (ActionStateMessageModel $message)
|
||||
return fn (ActionStateMessage $message)
|
||||
=> $message->MessageType === MessageType::Error;
|
||||
}
|
||||
|
||||
@@ -34,7 +34,7 @@ trait ActionStateStaticTrait
|
||||
*/
|
||||
public static function GET_STRING_ERROR_AND_WARNING (): Closure
|
||||
{
|
||||
return fn (ActionStateMessageModel $message)
|
||||
return fn (ActionStateMessage $message)
|
||||
=> $message->MessageType === MessageType::Error
|
||||
|| $message->MessageType === MessageType::Warning;
|
||||
}
|
||||
@@ -46,6 +46,6 @@ trait ActionStateStaticTrait
|
||||
*/
|
||||
public static function GET_STRING_ALL (): Closure
|
||||
{
|
||||
return fn (ActionStateMessageModel $message) => true;
|
||||
return fn (ActionStateMessage $message) => true;
|
||||
}
|
||||
}
|
43
sources/traits/GUID/GUIDArrayableTrait.php
Normal file
43
sources/traits/GUID/GUIDArrayableTrait.php
Normal 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"];
|
||||
}
|
||||
}
|
56
sources/traits/GUID/GUIDComparableTrait.php
Normal file
56
sources/traits/GUID/GUIDComparableTrait.php
Normal 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;
|
||||
}
|
||||
}
|
24
sources/traits/GUID/GUIDDuplicatedTrait.php
Normal file
24
sources/traits/GUID/GUIDDuplicatedTrait.php
Normal 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);
|
||||
}
|
||||
}
|
22
sources/traits/GUID/GUIDHashableTrait.php
Normal file
22
sources/traits/GUID/GUIDHashableTrait.php
Normal 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);
|
||||
}
|
||||
}
|
22
sources/traits/GUID/GUIDJsonSerializableTrait.php
Normal file
22
sources/traits/GUID/GUIDJsonSerializableTrait.php
Normal 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;
|
||||
}
|
||||
}
|
41
sources/traits/GUID/GUIDSerializeTrait.php
Normal file
41
sources/traits/GUID/GUIDSerializeTrait.php
Normal 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);
|
||||
}
|
||||
}
|
89
sources/traits/ObjectArray/ObjectArrayComparableTrait.php
Normal file
89
sources/traits/ObjectArray/ObjectArrayComparableTrait.php
Normal 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);
|
||||
}
|
||||
}
|
66
sources/traits/ObjectArray/ObjectArrayHashableTrait.php
Normal file
66
sources/traits/ObjectArray/ObjectArrayHashableTrait.php
Normal 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));
|
||||
}
|
||||
}
|
@@ -63,12 +63,12 @@ trait ObjectArraySearchAndSortTrait
|
||||
/**
|
||||
* Сортирует массив объектов, по значению свойства объекта.
|
||||
*
|
||||
* @param string $objectProperty Имя свойства объекта
|
||||
* @param string $property Имя свойства объекта
|
||||
* @param bool $descending Направление сортировки
|
||||
*
|
||||
* @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, []);
|
||||
@@ -77,8 +77,8 @@ trait ObjectArraySearchAndSortTrait
|
||||
usort($result,
|
||||
fn ($a, $b)
|
||||
=> !$descending
|
||||
? $a->$objectProperty <=> $b->$objectProperty
|
||||
: $b->$objectProperty <=> $a->$objectProperty);
|
||||
? $a->$property <=> $b->$property
|
||||
: $b->$property <=> $a->$property);
|
||||
|
||||
// Присваиваем результат
|
||||
$this->Container = $result;
|
||||
|
176
sources/traits/ObjectArray/ObjectArraySerializeExTrait.php
Normal file
176
sources/traits/ObjectArray/ObjectArraySerializeExTrait.php
Normal 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);
|
||||
}
|
||||
}
|
@@ -51,7 +51,7 @@ trait ObjectArraySpecialTrait
|
||||
public function AddRange (ObjectArray|array $objects): void
|
||||
{
|
||||
// Если передан массив, то не изменяем его, а если передан объект класса ObjectArray, то конвертируем его в массив объектов
|
||||
$objectsToAdd = is_array($objects) ? $objects : $objects->ToArray();
|
||||
$objectsToAdd = is_array($objects) ? $objects : $objects->AsArray();
|
||||
|
||||
// Добавляем массив объектов
|
||||
$this->Merge($objectsToAdd);
|
||||
@@ -62,7 +62,7 @@ trait ObjectArraySpecialTrait
|
||||
*
|
||||
* @return array Массив объектов, хранящихся в данном классе.
|
||||
*/
|
||||
public function ToArray (): array
|
||||
public function AsArray (): array
|
||||
{
|
||||
return $this->Container;
|
||||
}
|
||||
|
104
sources/traits/ObjectArray/ObjectArrayToArrayTrait.php
Normal file
104
sources/traits/ObjectArray/ObjectArrayToArrayTrait.php
Normal 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
338
sources/types/GUID.md
Normal 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
276
sources/types/GUID.php
Normal 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;
|
||||
}
|
||||
}
|
@@ -4,7 +4,7 @@ namespace goodboyalex\php_components_pack\tests\classes;
|
||||
|
||||
use goodboyalex\php_components_pack\classes\ActionState;
|
||||
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;
|
||||
|
||||
class ActionStateTest extends TestCase
|
||||
@@ -29,7 +29,7 @@ class ActionStateTest extends TestCase
|
||||
$this->assertEquals(2, $messages->Count());
|
||||
|
||||
$this->assertEquals("Non critical error",
|
||||
$actionState->GetStringMessages(fn (ActionStateMessageModel $message)
|
||||
$actionState->GetStringMessages(fn (ActionStateMessage $message)
|
||||
=> $message->MessageType
|
||||
== MessageType::Error
|
||||
&& !$message->IsCritical));
|
||||
@@ -51,4 +51,4 @@ class ActionStateTest extends TestCase
|
||||
require_once __DIR__ . '/../../sources/traits/ActionState/ActionStateStaticTrait.php';
|
||||
require_once __DIR__ . '/../../sources/enums/MessageType.php';
|
||||
}
|
||||
}
|
||||
}
|
@@ -3,7 +3,7 @@
|
||||
namespace goodboyalex\php_components_pack\tests\classes;
|
||||
|
||||
use goodboyalex\php_components_pack\classes\File;
|
||||
use goodboyalex\php_components_pack\classes\JsonReWriter;
|
||||
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;
|
||||
@@ -15,7 +15,7 @@ class JsonReWriterTest extends TestCase
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
}
|
||||
@@ -43,7 +43,7 @@ class JsonReWriterTest extends TestCase
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test/test", 123);
|
||||
}
|
||||
@@ -58,7 +58,7 @@ class JsonReWriterTest extends TestCase
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test/test1", false);
|
||||
$json->Write("test/test2", true);
|
||||
@@ -75,7 +75,7 @@ class JsonReWriterTest extends TestCase
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test/test", "test string");
|
||||
}
|
||||
@@ -95,7 +95,7 @@ class JsonReWriterTest extends TestCase
|
||||
if (file_exists($fileName))
|
||||
unlink($fileName);
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
@@ -123,7 +123,7 @@ class JsonReWriterTest extends TestCase
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
@@ -143,7 +143,7 @@ class JsonReWriterTest extends TestCase
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
@@ -165,7 +165,7 @@ class JsonReWriterTest extends TestCase
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
|
||||
$class = new A("test", 123, true);
|
||||
|
||||
@@ -188,7 +188,7 @@ class JsonReWriterTest extends TestCase
|
||||
if (file_exists($fileName))
|
||||
unlink($fileName);
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
@@ -205,7 +205,7 @@ class JsonReWriterTest extends TestCase
|
||||
|
||||
unset($json);
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
|
||||
$json->LoadFromFile($fileName);
|
||||
|
||||
@@ -218,7 +218,7 @@ class JsonReWriterTest extends TestCase
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
@@ -240,7 +240,7 @@ class JsonReWriterTest extends TestCase
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
@@ -261,7 +261,7 @@ class JsonReWriterTest extends TestCase
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
@@ -283,7 +283,7 @@ class JsonReWriterTest extends TestCase
|
||||
|
||||
$serializableClass = new C("test", 123, true);
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->WriteSerializable("test", $serializableClass);
|
||||
|
||||
@@ -306,7 +306,7 @@ class JsonReWriterTest extends TestCase
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new JsonReWriter();
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test", 1.23);
|
||||
}
|
||||
|
@@ -3,8 +3,14 @@
|
||||
namespace goodboyalex\php_components_pack\tests\classes;
|
||||
|
||||
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\B;
|
||||
use goodboyalex\php_components_pack\tests\data\C;
|
||||
use goodboyalex\php_components_pack\tests\data\D;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use stdClass;
|
||||
|
||||
class ObjectArrayTest extends TestCase
|
||||
{
|
||||
@@ -38,6 +44,8 @@ class ObjectArrayTest extends TestCase
|
||||
{
|
||||
require_once __DIR__ . '/../data/A.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/traits/ArrayBasicTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/ObjectArray/ObjectArrayConstantsTrait.php';
|
||||
@@ -220,7 +228,7 @@ class ObjectArrayTest extends TestCase
|
||||
$this->assertSame(['c', 'b'], $sr);
|
||||
}
|
||||
|
||||
public function testToArray ()
|
||||
public function testAsArray ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
@@ -232,7 +240,7 @@ class ObjectArrayTest extends TestCase
|
||||
|
||||
$a_Array = new ObjectArray($array);
|
||||
|
||||
$sr = $a_Array->ToArray();
|
||||
$sr = $a_Array->AsArray();
|
||||
|
||||
$this->assertIsArray($sr);
|
||||
$this->assertSame($array, $sr);
|
||||
@@ -480,4 +488,117 @@ class ObjectArrayTest extends TestCase
|
||||
|
||||
$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);
|
||||
}
|
||||
}
|
56
tests/data/D.php
Normal file
56
tests/data/D.php
Normal 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()
|
||||
];
|
||||
}
|
||||
}
|
91
tests/extensions/TypeExtensionTest.php
Normal file
91
tests/extensions/TypeExtensionTest.php
Normal 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
145
tests/types/GUIDTest.php
Normal 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'));
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user