10 Commits

Author SHA1 Message Date
7e57e5cb56 20250713 1.1.1 fix 2025-07-13 12:33:09 +03:00
62762374e0 20250713 1.1.1 2025-07-13 12:23:08 +03:00
117deab9d8 20250712 1.1.1 Beta 4 2025-07-12 16:27:53 +03:00
3fbb7dc81c 20250711 1.1.1 Beta 3 2025-07-11 19:40:30 +03:00
83a76dc8e2 20250709 1.1.1 Beta 2 2025-07-10 07:37:11 +03:00
6e831e2650 20250707
Бета 1.1.1
2025-07-07 18:02:04 +03:00
52de613b0f 20250629 1.1 Stable 2025-06-29 20:29:52 +03:00
58b3b74d99 20250628 1.1 Beta 2 2025-06-28 23:22:37 +03:00
f5420ce2c0 20250628
Бета 1.1
2025-06-28 18:15:18 +03:00
e9118609b6 20250626
В класс VersionInfo добавлены статические методы MinVersion и MaxVersion.

Метод CompareWithRange обновлён с учётом новых методов
2025-06-26 21:39:26 +03:00
32 changed files with 2961 additions and 87 deletions

4
.gitignore vendored
View File

@@ -79,3 +79,7 @@ fabric.properties
.idea/
vendor/
/tests/extensions/class.txt
/tests/classesserialized1.txt
/tests/classesserialized2.txt
/tests/classesserialized3.txt

View File

@@ -20,7 +20,7 @@
"ext-mbstring": "*"
},
"require-dev": {
"phpunit/phpunit": "^12.2.1"
"phpunit/phpunit": "^12.2.7"
},
"autoload": {
"psr-4": {

28
composer.lock generated
View File

@@ -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.3",
"version": "12.2.7",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/phpunit.git",
"reference": "60a8ea2d8b2f070000051b56778009e11576e7d1"
"reference": "8b1348b254e5959acaf1539c6bd790515fb49414"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/60a8ea2d8b2f070000051b56778009e11576e7d1",
"reference": "60a8ea2d8b2f070000051b56778009e11576e7d1",
"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.3"
"source": "https://github.com/sebastianbergmann/phpunit/tree/12.2.7"
},
"funding": [
{
@@ -680,7 +680,7 @@
"type": "tidelift"
}
],
"time": "2025-06-20T11:33:06+00:00"
"time": "2025-07-11T04:11:13+00:00"
},
{
"name": "sebastian/cli-parser",

View File

@@ -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);
// - добавляю в список

View File

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

View File

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

View File

@@ -9,6 +9,7 @@ use goodboyalex\php_components_pack\traits\ArrayBasicTrait;
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayConstantsTrait;
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 IteratorAggregate;
@@ -17,7 +18,7 @@ use IteratorAggregate;
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0.5
* @version 1.0.6
* @since 1.0
*/
final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, ISerializable
@@ -42,6 +43,9 @@ final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, IS
// Специальные методы
use ObjectArraySpecialTrait;
// Расширенные методы для сериализации
use ObjectArraySerializeExTrait;
/**
* Конструктор класса.
*

View File

@@ -2,7 +2,7 @@
## Информация о версии
Версия класса: 1.1
Версия класса: 1.2
Впервые введено в пакет с версии: 1.0.24
Последнее обновление в версии: 1.0.27
@@ -371,3 +371,49 @@
В результате на экране появится:
false|true|false
#### Метод `MinVersion`
Введено в версии `1.0.28`.
Этот **статический** метод **без параметров** возвращает минимальную версию (объект класса `VersionInfo`).
Синтаксис:
public static function MinVersion (): VersionInfo
Пример,
// Создаю объекты
$version = VersionInfo::MinVersion();
// Вывожу
echo $version;
В результате на экране появится:
0.0.0.0 PreAlpha 0
#### Метод `MaxVersion`
Введено в версии `1.0.28`.
Этот **статический** метод **без параметров** возвращает максимальную версию (объект класса `VersionInfo`).
Синтаксис:
public static function MaxVersion (): VersionInfo
Пример,
// Создаю объекты
$version = VersionInfo::MaxVersion();
// В этом примере считается, что константа PHP_INT_MAX равна 9223372036854775807
// Вывожу
echo $version;
В результате на экране появится:
9223372036854775807.9223372036854775807.9223372036854775807.9223372036854775807

View File

@@ -11,7 +11,7 @@ use goodboyalex\php_components_pack\extensions\StringExtension;
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.1
* @version 1.2
* @since 1.0.24
*/
final class VersionInfo
@@ -306,6 +306,7 @@ final class VersionInfo
* @return int Возвращает 1, если текущая версия старше интервала, 0, если находится в интервале, -1, если текущая
* версия младше интервала.
*
* @version 1.1
* @since 1.0.27
*/
public function CompareWithRange (?VersionInfo $left = null, ?VersionInfo $right = null,
@@ -317,17 +318,11 @@ final class VersionInfo
VersionCompareRangeOption::RightBorderIncluded
]);
// Минимальная версия (случай, когда левая граница не указана)
$minVersion = new VersionInfo(0, 0, 0, 0, VersionInfoStage::PreAlpha, 0);
// Максимальная версия (случай, когда правая граница не указана)
$maxVersion = new VersionInfo(PHP_INT_MAX, PHP_INT_MAX, PHP_INT_MAX, PHP_INT_MAX, VersionInfoStage::Stable);
// Устанавливаем левую границу
$leftBorder = $left ?? $minVersion;
$leftBorder = $left ?? self::MinVersion();
// Устанавливаем правую границу
$rightBorder = $right ?? $maxVersion;
$rightBorder = $right ?? self::MaxVersion();
// Проверяем, что границы не перепутаны
if ($leftBorder->CompareWith($rightBorder) == 0)
@@ -369,4 +364,28 @@ final class VersionInfo
// -- в противном случае, версия старше правой границы (или равна ей при не включении границы)
return 1;
}
/**
* Возвращает минимальную версию.
*
* @return VersionInfo Минимальная версия.
*
* @since 1.0.28
*/
public static function MinVersion (): VersionInfo
{
return new VersionInfo(0, 0, 0, 0, VersionInfoStage::PreAlpha, 0);
}
/**
* Возвращает максимальную версию.
*
* @return VersionInfo Максимальная версия.
*
* @since 1.0.28
*/
public static function MaxVersion (): VersionInfo
{
return new VersionInfo(PHP_INT_MAX, PHP_INT_MAX, PHP_INT_MAX, PHP_INT_MAX, VersionInfoStage::Stable);
}
}

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -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 Тип сообщения

View File

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

View File

@@ -5,7 +5,7 @@ namespace goodboyalex\php_components_pack\traits\ActionState;
use goodboyalex\php_components_pack\classes\ActionState;
use goodboyalex\php_components_pack\classes\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));
}
}

View File

@@ -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);
}

View File

@@ -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;
}
}

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -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));

View File

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

View File

@@ -3,8 +3,14 @@
namespace goodboyalex\php_components_pack\tests\classes;
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';
@@ -480,4 +488,66 @@ 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);
}
}

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

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

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

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

View File

@@ -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']);
}
}