Compare commits
7 Commits
Author | SHA1 | Date | |
---|---|---|---|
f3db4e8041 | |||
d217322a35 | |||
24bf2a009f | |||
f8f14244d0 | |||
04f6849ff4 | |||
2c3ea12fc1 | |||
e342c7f41f |
1
.gitignore
vendored
1
.gitignore
vendored
@ -83,3 +83,4 @@ vendor/
|
|||||||
/tests/classesserialized1.txt
|
/tests/classesserialized1.txt
|
||||||
/tests/classesserialized2.txt
|
/tests/classesserialized2.txt
|
||||||
/tests/classesserialized3.txt
|
/tests/classesserialized3.txt
|
||||||
|
/tests/classesserialized4.txt
|
||||||
|
@ -17,7 +17,8 @@
|
|||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": "^8.4",
|
"php": "^8.4",
|
||||||
"ext-mbstring": "*"
|
"ext-mbstring": "*",
|
||||||
|
"ext-openssl": "*"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"phpunit/phpunit": "^12.2.7"
|
"phpunit/phpunit": "^12.2.7"
|
||||||
|
@ -6,6 +6,7 @@ use DateTimeImmutable;
|
|||||||
use DateTimeInterface;
|
use DateTimeInterface;
|
||||||
use Exception;
|
use Exception;
|
||||||
use goodboyalex\php_components_pack\attributes\GetOnly;
|
use goodboyalex\php_components_pack\attributes\GetOnly;
|
||||||
|
use goodboyalex\php_components_pack\types\GUID;
|
||||||
use ReflectionClass;
|
use ReflectionClass;
|
||||||
use ReflectionException;
|
use ReflectionException;
|
||||||
use ReflectionProperty;
|
use ReflectionProperty;
|
||||||
@ -341,6 +342,11 @@ final class ClassMapper
|
|||||||
*/
|
*/
|
||||||
$property->setAccessible(true);
|
$property->setAccessible(true);
|
||||||
|
|
||||||
|
// Если значение string, а требуется GUID
|
||||||
|
if (is_string($value) && $property->getType()->getName() === GUID::class)
|
||||||
|
// - то присваиваю значение GUID
|
||||||
|
$value = GUID::Parse($value, true);
|
||||||
|
|
||||||
// Если значение null
|
// Если значение null
|
||||||
if (!is_bool($value) && ($value == null || $value == "null"))
|
if (!is_bool($value) && ($value == null || $value == "null"))
|
||||||
// - то присваиваю значение по умолчанию
|
// - то присваиваю значение по умолчанию
|
||||||
|
@ -4,8 +4,13 @@ namespace goodboyalex\php_components_pack\classes;
|
|||||||
|
|
||||||
use ArrayAccess;
|
use ArrayAccess;
|
||||||
use Countable;
|
use Countable;
|
||||||
|
use goodboyalex\php_components_pack\interfaces\IArrayable;
|
||||||
|
use goodboyalex\php_components_pack\interfaces\IComparable;
|
||||||
|
use goodboyalex\php_components_pack\interfaces\IHashable;
|
||||||
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
||||||
|
use goodboyalex\php_components_pack\interfaces\ISortable;
|
||||||
use goodboyalex\php_components_pack\traits\ArrayBasicTrait;
|
use goodboyalex\php_components_pack\traits\ArrayBasicTrait;
|
||||||
|
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayComparableTrait;
|
||||||
use IteratorAggregate;
|
use IteratorAggregate;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -16,7 +21,8 @@ use IteratorAggregate;
|
|||||||
* @version 1.0.3
|
* @version 1.0.3
|
||||||
* @since 1.0.14
|
* @since 1.0.14
|
||||||
*/
|
*/
|
||||||
final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISerializable
|
final class Dictionary
|
||||||
|
implements ArrayAccess, IteratorAggregate, Countable, ISerializable, IArrayable, IHashable, ISortable, IComparable
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @var array $Container Контейнер.
|
* @var array $Container Контейнер.
|
||||||
@ -26,33 +32,8 @@ final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISe
|
|||||||
// Реализация наследуемых интерфейсов и классов
|
// Реализация наследуемых интерфейсов и классов
|
||||||
use ArrayBasicTrait;
|
use ArrayBasicTrait;
|
||||||
|
|
||||||
/**
|
// Реализация интерфейса IComparable
|
||||||
* Добавление элементов в словарь.
|
use ObjectArrayComparableTrait;
|
||||||
*
|
|
||||||
* @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;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Получение значения по ключу.
|
* Получение значения по ключу.
|
||||||
@ -95,16 +76,6 @@ final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISe
|
|||||||
return isset($this->Container[$key]);
|
return isset($this->Container[$key]);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Очистка всех элементов.
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function Clear (): void
|
|
||||||
{
|
|
||||||
$this->Container = [];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* @inheritDoc
|
||||||
*/
|
*/
|
||||||
@ -124,13 +95,77 @@ final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISe
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Сортирует внутренние данные по ключам.
|
* @inheritDoc
|
||||||
*
|
*/
|
||||||
* @param bool $descending Сортировать ли данные в обратном порядке?
|
public function ToArray (): array
|
||||||
|
{
|
||||||
|
return $this->Container;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @inheritDoc
|
||||||
|
*/
|
||||||
|
public function FromArray (array $array): void
|
||||||
|
{
|
||||||
|
// Очищаем словарь
|
||||||
|
$this->Clear();
|
||||||
|
|
||||||
|
// Добавляем элементы в словарь
|
||||||
|
$this->AddRange($array);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Очистка всех элементов.
|
||||||
*
|
*
|
||||||
* @return void
|
* @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)
|
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);
|
||||||
}
|
}
|
||||||
}
|
}
|
60
sources/classes/Encryptor.php
Normal file
60
sources/classes/Encryptor.php
Normal file
@ -0,0 +1,60 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace goodboyalex\php_components_pack\classes;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Класс криптографической защиты.
|
||||||
|
*
|
||||||
|
* @author Александр Бабаев
|
||||||
|
* @package php_components_pack
|
||||||
|
* @version 1.0
|
||||||
|
* @since 1.2.2
|
||||||
|
*/
|
||||||
|
final class Encryptor
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Шифрует данные.
|
||||||
|
*
|
||||||
|
* @param string $string Данные для шифрования.
|
||||||
|
* @param string $key Ключ шифрования.
|
||||||
|
*
|
||||||
|
* @return string|false Шифрованные данные или false в случае ошибки.
|
||||||
|
*/
|
||||||
|
public static function Encrypt (string $string, string $key): string|false
|
||||||
|
{
|
||||||
|
// Метод шифрования
|
||||||
|
$cipher = 'aes-256-cbc';
|
||||||
|
|
||||||
|
// Длинна ненулевого вектора инициализации
|
||||||
|
$ivLen = openssl_cipher_iv_length($cipher);
|
||||||
|
|
||||||
|
// Ненулевой вектор инициализации
|
||||||
|
$iv = openssl_random_pseudo_bytes($ivLen);
|
||||||
|
|
||||||
|
// Шифрую и вывожу
|
||||||
|
return openssl_encrypt($string, $cipher, $key, iv: $iv) . ":" . base64_encode($iv);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Дешифрует данные.
|
||||||
|
*
|
||||||
|
* @param string $string Данные для дешифрования.
|
||||||
|
* @param string $key Ключ шифрования.
|
||||||
|
*
|
||||||
|
* @return string|false Дешифрованные данные или false в случае ошибки.
|
||||||
|
*/
|
||||||
|
public static function Decrypt (string $string, string $key): false|string
|
||||||
|
{
|
||||||
|
// Метод шифрования
|
||||||
|
$cipher = 'aes-256-cbc';
|
||||||
|
|
||||||
|
// Разделённый массив с шифрованными данными и вектором инициализации
|
||||||
|
$cryptArray = explode(':', $string);
|
||||||
|
|
||||||
|
// Ненулевой вектор инициализации
|
||||||
|
$iv = base64_decode($cryptArray[1]);
|
||||||
|
|
||||||
|
// Дешифрую и вывожу
|
||||||
|
return openssl_decrypt($cryptArray[0], $cipher, $key, iv: $iv);
|
||||||
|
}
|
||||||
|
}
|
@ -4,13 +4,20 @@ namespace goodboyalex\php_components_pack\classes;
|
|||||||
|
|
||||||
use ArrayAccess;
|
use ArrayAccess;
|
||||||
use Countable;
|
use Countable;
|
||||||
|
use goodboyalex\php_components_pack\interfaces\IArrayable;
|
||||||
|
use goodboyalex\php_components_pack\interfaces\IComparable;
|
||||||
|
use goodboyalex\php_components_pack\interfaces\IHashable;
|
||||||
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
||||||
|
use goodboyalex\php_components_pack\interfaces\ISortable;
|
||||||
use goodboyalex\php_components_pack\traits\ArrayBasicTrait;
|
use goodboyalex\php_components_pack\traits\ArrayBasicTrait;
|
||||||
|
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayComparableTrait;
|
||||||
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayConstantsTrait;
|
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayConstantsTrait;
|
||||||
|
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayHashableTrait;
|
||||||
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayLINQTrait;
|
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayLINQTrait;
|
||||||
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySearchAndSortTrait;
|
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySearchAndSortTrait;
|
||||||
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySerializeExTrait;
|
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySerializeExTrait;
|
||||||
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySpecialTrait;
|
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySpecialTrait;
|
||||||
|
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayToArrayTrait;
|
||||||
use IteratorAggregate;
|
use IteratorAggregate;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -18,10 +25,11 @@ use IteratorAggregate;
|
|||||||
*
|
*
|
||||||
* @author Александр Бабаев
|
* @author Александр Бабаев
|
||||||
* @package php_components_pack
|
* @package php_components_pack
|
||||||
* @version 1.0.6
|
* @version 1.1
|
||||||
* @since 1.0
|
* @since 1.0
|
||||||
*/
|
*/
|
||||||
final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, ISerializable
|
final class ObjectArray
|
||||||
|
implements ArrayAccess, IteratorAggregate, Countable, ISerializable, IArrayable, IHashable, ISortable, IComparable
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @var array $Container Массив объектов, хранящихся в данном классе.
|
* @var array $Container Массив объектов, хранящихся в данном классе.
|
||||||
@ -46,6 +54,15 @@ final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, IS
|
|||||||
// Расширенные методы для сериализации
|
// Расширенные методы для сериализации
|
||||||
use ObjectArraySerializeExTrait;
|
use ObjectArraySerializeExTrait;
|
||||||
|
|
||||||
|
// Реализация методов интерфейса IArrayable
|
||||||
|
use ObjectArrayToArrayTrait;
|
||||||
|
|
||||||
|
// Реализация методов интерфейса IHashable
|
||||||
|
use ObjectArrayHashableTrait;
|
||||||
|
|
||||||
|
// Реализация методов интерфейса IComparable
|
||||||
|
use ObjectArrayComparableTrait;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Конструктор класса.
|
* Конструктор класса.
|
||||||
*
|
*
|
||||||
|
@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
namespace goodboyalex\php_components_pack\extensions;
|
namespace goodboyalex\php_components_pack\extensions;
|
||||||
|
|
||||||
|
use Deprecated;
|
||||||
use Random\RandomException;
|
use Random\RandomException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -11,12 +12,15 @@ use Random\RandomException;
|
|||||||
* @package php_components_pack
|
* @package php_components_pack
|
||||||
* @version 1.0
|
* @version 1.0
|
||||||
* @since 1.0
|
* @since 1.0
|
||||||
|
* @deprecated 1.2
|
||||||
|
*
|
||||||
*/
|
*/
|
||||||
final class GUIDExtension
|
final class GUIDExtension
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Пустой Guid.
|
* Пустой Guid.
|
||||||
*/
|
*/
|
||||||
|
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
|
||||||
public const string GUIDEmpty = "00000000-0000-0000-0000-000000000000";
|
public const string GUIDEmpty = "00000000-0000-0000-0000-000000000000";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -24,6 +28,7 @@ final class GUIDExtension
|
|||||||
*
|
*
|
||||||
* @return string Сгенерированный Guid.
|
* @return string Сгенерированный Guid.
|
||||||
*/
|
*/
|
||||||
|
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
|
||||||
public static function Generate (): string
|
public static function Generate (): string
|
||||||
{
|
{
|
||||||
// Цикл создания Guid
|
// Цикл создания Guid
|
||||||
@ -41,6 +46,7 @@ final class GUIDExtension
|
|||||||
*
|
*
|
||||||
* @return string Сгенерированный Guid.
|
* @return string Сгенерированный Guid.
|
||||||
*/
|
*/
|
||||||
|
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
|
||||||
private static function DoGenerate (): string
|
private static function DoGenerate (): string
|
||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
@ -80,6 +86,7 @@ final class GUIDExtension
|
|||||||
*
|
*
|
||||||
* @return bool Корректен ли Guid.
|
* @return bool Корректен ли Guid.
|
||||||
*/
|
*/
|
||||||
|
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
|
||||||
public static function Validate (?string $str): bool
|
public static function Validate (?string $str): bool
|
||||||
{
|
{
|
||||||
// Если Guid пустой
|
// Если Guid пустой
|
||||||
@ -140,6 +147,7 @@ final class GUIDExtension
|
|||||||
*
|
*
|
||||||
* @return bool Пустой ли GUID
|
* @return bool Пустой ли GUID
|
||||||
*/
|
*/
|
||||||
|
#[Deprecated('GUIDExtension устарел, пожалуйста используйте класс GUID / GUIDExtension is deprecated, please use class GUID / GUIDExtension', '1.2')]
|
||||||
public static function IsNotValidOrEmpty (?string $str): bool
|
public static function IsNotValidOrEmpty (?string $str): bool
|
||||||
{
|
{
|
||||||
return !self::Validate($str) || $str == self::GUIDEmpty;
|
return !self::Validate($str) || $str == self::GUIDEmpty;
|
||||||
|
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;
|
||||||
|
}
|
@ -1,32 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace goodboyalex\php_components_pack\interfaces;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Интерфейс поддержки моделей и классов, реализующих хранение свойств в SQL базе данных.
|
|
||||||
*
|
|
||||||
* @author Александр Бабаев
|
|
||||||
* @package freecms
|
|
||||||
* @version 0.1
|
|
||||||
* @since 0.1
|
|
||||||
*/
|
|
||||||
interface IStoredAtSQL
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* Вывод параметров добавления/обновления данных в базу данных.
|
|
||||||
*
|
|
||||||
* @param bool $withId Нужно ли добавлять Id в массив
|
|
||||||
*
|
|
||||||
* @return array Массив параметров
|
|
||||||
*/
|
|
||||||
public function ToSQL (bool $withId = true): array;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Преобразование данных из базы данных в модель, класс.
|
|
||||||
*
|
|
||||||
* @param array $sqlData Данные из базы данных
|
|
||||||
*
|
|
||||||
* @return self Класс модели с заполненными данными из базы данных
|
|
||||||
*/
|
|
||||||
public function FromSQL (array $sqlData): self;
|
|
||||||
}
|
|
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 Направление сортировки
|
* @param bool $descending Направление сортировки
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function Sort (string $objectProperty, bool $descending = false): void
|
public function Sort (string $property = '', bool $descending = false): void
|
||||||
{
|
{
|
||||||
// Создаём результирующий массив
|
// Создаём результирующий массив
|
||||||
$result = array_merge($this->Container, []);
|
$result = array_merge($this->Container, []);
|
||||||
@ -77,8 +77,8 @@ trait ObjectArraySearchAndSortTrait
|
|||||||
usort($result,
|
usort($result,
|
||||||
fn ($a, $b)
|
fn ($a, $b)
|
||||||
=> !$descending
|
=> !$descending
|
||||||
? $a->$objectProperty <=> $b->$objectProperty
|
? $a->$property <=> $b->$property
|
||||||
: $b->$objectProperty <=> $a->$objectProperty);
|
: $b->$property <=> $a->$property);
|
||||||
|
|
||||||
// Присваиваем результат
|
// Присваиваем результат
|
||||||
$this->Container = $result;
|
$this->Container = $result;
|
||||||
|
@ -51,7 +51,7 @@ trait ObjectArraySpecialTrait
|
|||||||
public function AddRange (ObjectArray|array $objects): void
|
public function AddRange (ObjectArray|array $objects): void
|
||||||
{
|
{
|
||||||
// Если передан массив, то не изменяем его, а если передан объект класса ObjectArray, то конвертируем его в массив объектов
|
// Если передан массив, то не изменяем его, а если передан объект класса ObjectArray, то конвертируем его в массив объектов
|
||||||
$objectsToAdd = is_array($objects) ? $objects : $objects->ToArray();
|
$objectsToAdd = is_array($objects) ? $objects : $objects->AsArray();
|
||||||
|
|
||||||
// Добавляем массив объектов
|
// Добавляем массив объектов
|
||||||
$this->Merge($objectsToAdd);
|
$this->Merge($objectsToAdd);
|
||||||
@ -62,7 +62,7 @@ trait ObjectArraySpecialTrait
|
|||||||
*
|
*
|
||||||
* @return array Массив объектов, хранящихся в данном классе.
|
* @return array Массив объектов, хранящихся в данном классе.
|
||||||
*/
|
*/
|
||||||
public function ToArray (): array
|
public function AsArray (): array
|
||||||
{
|
{
|
||||||
return $this->Container;
|
return $this->Container;
|
||||||
}
|
}
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
}
|
@ -228,7 +228,7 @@ class ObjectArrayTest extends TestCase
|
|||||||
$this->assertSame(['c', 'b'], $sr);
|
$this->assertSame(['c', 'b'], $sr);
|
||||||
}
|
}
|
||||||
|
|
||||||
public function testToArray ()
|
public function testAsArray ()
|
||||||
{
|
{
|
||||||
$this->PrepareForTest();
|
$this->PrepareForTest();
|
||||||
|
|
||||||
@ -240,7 +240,7 @@ class ObjectArrayTest extends TestCase
|
|||||||
|
|
||||||
$a_Array = new ObjectArray($array);
|
$a_Array = new ObjectArray($array);
|
||||||
|
|
||||||
$sr = $a_Array->ToArray();
|
$sr = $a_Array->AsArray();
|
||||||
|
|
||||||
$this->assertIsArray($sr);
|
$this->assertIsArray($sr);
|
||||||
$this->assertSame($array, $sr);
|
$this->assertSame($array, $sr);
|
||||||
@ -550,4 +550,55 @@ class ObjectArrayTest extends TestCase
|
|||||||
$this->assertEquals('test_string_C3',
|
$this->assertEquals('test_string_C3',
|
||||||
$objectArray3->GetRow(fn (D $value) => $value->stringD == 'test_string3')->c->stringC);
|
$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);
|
||||||
|
}
|
||||||
}
|
}
|
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'));
|
||||||
|
}
|
||||||
|
}
|
Loading…
x
Reference in New Issue
Block a user