4 Commits

Author SHA1 Message Date
ebfd42a88e 20250222
[О] [ClassMapper::GetDefaults]: Улучшено определение типа. Теперь проверка integer не вызовет ошибку, что ожидается int.

[О] [ClassMapper::MapClass]: Теперь идёт проверка свойства на доступность get и set. Свойства с только get и только set пропускаются.
2025-02-22 13:09:54 +03:00
054e6a7cdc 20250221 2025-02-21 18:33:23 +03:00
64c1f386eb 20250217
[Д] [BoolExtensions]: Добавлен новый статический класс, расширяющий возможности типа bool.
2025-02-17 17:34:14 +03:00
3aefbd7f27 20250214-1
[Д] [HashGetType]: Добавлен параметр ByHash (для получения класса хеша путём передачи ему уже вычисленного хэша).

[О] [FileHash]: __construct - $hashBy по умолчанию теперь HashGetType::ByHash.

[Д] [FileHash]: Добавлены функции сериализации и десериализации (теперь класс реализует интерфейс ISerializable).

[Д] [FileHash]: Добавлена функции валидации хэша Validate.
2025-02-14 19:07:21 +03:00
10 changed files with 564 additions and 391 deletions

View File

@@ -16,11 +16,11 @@
} }
], ],
"require": { "require": {
"php": ">=8.4", "php": "^8.4",
"ext-mbstring": "*" "ext-mbstring": "*"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": ">=11.5.6" "phpunit/phpunit": "^12.0.4"
}, },
"autoload": { "autoload": {
"psr-4": { "psr-4": {

538
composer.lock generated

File diff suppressed because it is too large Load Diff

View File

@@ -4,10 +4,12 @@ namespace goodboyalex\php_components_pack\classes;
use DateTimeImmutable; use DateTimeImmutable;
use DateTimeInterface; use DateTimeInterface;
use Error;
use Exception; use Exception;
use ReflectionClass; use ReflectionClass;
use ReflectionException; use ReflectionException;
use stdClass; use stdClass;
use Throwable;
use UnitEnum; use UnitEnum;
/** /**
@@ -49,21 +51,79 @@ final class ClassMapper
// ---- то исключаю его из массива разрешенных // ---- то исключаю его из массива разрешенных
unset($options['allowed'][array_search($ignoredProperty, $options['allowed'])]); unset($options['allowed'][array_search($ignoredProperty, $options['allowed'])]);
// Получаю массив свойств // Задаю массив свойств
$properties = get_class_vars(get_class($from)); $properties = [];
// Получаю имя исходного класса
$className = get_class($from);
// Получение всех свойств класса
try {
$reflection = new ReflectionClass($className);
}
catch (ReflectionException) {
return;
}
// Получение всех свойств класса
$props = $reflection->getProperties();
// Создаю экземпляр класса
$instance = new $className();
// Для каждого свойства
foreach ($props as $prop) {
// - получаю имя свойства
$propName = $prop->getName();
// - получаю значение свойства
$value = $from->$propName;
try {
// - получаю тип свойства
$typeOf = gettype($from->$propName);
// - получаю значение свойства по типу и по умолчанию
$writeValue = self::GetDefaults($typeOf);
try {
// - проверяем, можно ли записать и прочитать значение
// -- пытаюсь установить значение
$instance->$propName = $writeValue;
// -- пытаюсь прочитать установленное значение
$readValue = $instance->$propName;
// -- и проверяю, что значение совпадают
/** @noinspection PhpConditionAlreadyCheckedInspection */
if ($readValue !== $writeValue)
continue;
}
catch (Throwable) {
// - в случае ошибки, понимаем, что свойство доступно или только для чтения, или
// только для записи и оно нам не подходит. Поэтому пропускаем его.
continue;
}
// - если свойство игнорируется
if (in_array($propName, $options['ignored']))
// -- пропускаю
continue;
// - если свойство не разрешено
if (count($options['allowed']) > 0 && !in_array($propName, $options['allowed']))
// -- пропускаю
continue;
// Если не было ошибки, значит свойство имеет и геттер, и сеттер
$properties[$propName] = $value;
}
catch (Error) {
// - в случае ошибки, понимаем, что свойство нам не подходит. Поэтому пропускаю его.
continue;
}
}
// Для каждого элемента массива // Для каждого элемента массива
foreach ($properties as $name => $value) { foreach ($properties as $name => $value) {
// - если свойство игнорируется
if (in_array($name, $options['ignored']))
// -- пропускаю
continue;
// - если свойство не разрешено
if (count($options['allowed']) > 0 && !in_array($name, $options['allowed']))
// -- пропускаю
continue;
// - если свойство есть в объекте // - если свойство есть в объекте
if (property_exists($to, $name)) if (property_exists($to, $name))
// -- то присваиваю значение // -- то присваиваю значение
@@ -71,6 +131,26 @@ final class ClassMapper
} }
} }
/**
* Возвращает значение по умолчанию для типа $typeName.
*
* @param string $typeName Тип
*
* @return mixed Значение по умолчанию
*/
public static function GetDefaults (string $typeName): mixed
{
return match (strtolower($typeName)) {
'int', 'integer' => 0,
'float', 'double' => 0.0,
'bool', 'boolean' => false,
'string' => '',
'array' => [],
'object' => new stdClass(),
default => null,
};
}
/** /**
* Подготавливает значения свойств класса. * Подготавливает значения свойств класса.
* *
@@ -80,7 +160,8 @@ final class ClassMapper
* *
* @return array Массив данных класса. * @return array Массив данных класса.
*/ */
public static function PrepareClassProperties (array $params, ReflectionClass $classReflector, public
static function PrepareClassProperties (array $params, ReflectionClass $classReflector,
array $options = self::DefaultOptions): array array $options = self::DefaultOptions): array
{ {
// Создаю массив данных класса // Создаю массив данных класса
@@ -140,7 +221,8 @@ final class ClassMapper
* *
* @return void * @return void
*/ */
public static function GetClassParametersArrayParser (array &$source, array $parametersKeys, mixed $value, public
static function GetClassParametersArrayParser (array &$source, array $parametersKeys, mixed $value,
array $options = self::DefaultOptions): void array $options = self::DefaultOptions): void
{ {
// Если массив имен свойств пустой // Если массив имен свойств пустой
@@ -189,7 +271,8 @@ final class ClassMapper
* @return mixed Объект класса * @return mixed Объект класса
* @throws Exception * @throws Exception
*/ */
public static function MapToClassProperty (string $className, array $properties): mixed public
static function MapToClassProperty (string $className, array $properties): mixed
{ {
// Создаю // Создаю
try { try {
@@ -285,7 +368,8 @@ final class ClassMapper
* *
* @throws Exception * @throws Exception
*/ */
public static function SetParameterToClass (ReflectionClass $classReflector, string $propertyName, public
static function SetParameterToClass (ReflectionClass $classReflector, string $propertyName,
mixed $classObj, mixed $value): void mixed $classObj, mixed $value): void
{ {
try { try {
@@ -312,24 +396,4 @@ final class ClassMapper
throw new Exception($exception->getMessage()); throw new Exception($exception->getMessage());
} }
} }
/**
* Получает значение по умолчанию для разных типов данных.
*
* @param string $typeName Имя типа данных.
*
* @return mixed|null Результат.
*/
public static function GetDefaults (string $typeName): mixed
{
return match ($typeName) {
'int' => 0,
'float' => 0.0,
'bool' => false,
'string' => '',
'array' => [],
'object' => new stdClass(),
default => null,
};
}
} }

View File

@@ -4,39 +4,35 @@ namespace goodboyalex\php_components_pack\classes;
use goodboyalex\php_components_pack\enums\HashGetType; use goodboyalex\php_components_pack\enums\HashGetType;
use goodboyalex\php_components_pack\extensions\StringExtension; use goodboyalex\php_components_pack\extensions\StringExtension;
use goodboyalex\php_components_pack\interfaces\ISerializable;
/** /**
* Класс для работы с хэшем файла или строки. * Класс для работы с хэшем файла или строки.
* *
* @author Александр Бабаев * @author Александр Бабаев
* @package php_components_pack * @package php_components_pack
* @version 1.0 * @version 1.0.1
* @since 1.0.5 * @since 1.0.5
*/ */
final class FileHash final class FileHash implements ISerializable
{ {
/** /**
* @var string $Hash Хэш файла. * @var string $Hash Хэш файла.
*/ */
private(set) string $Hash; private(set) string $Hash;
/**
* @var HashGetType Тип получения хэша.
*/
public HashGetType $HashBy;
/** /**
* Конструктор. * Конструктор.
* *
* @param string $str Строка или имя файла. * @param string $str Хэщ, строка или имя файла.
* @param HashGetType $HashBy Тип получения хэша. * @param HashGetType $hashBy Тип получения хэша.
*/ */
public function __construct (string $str = "", HashGetType $HashBy = HashGetType::ByString) public function __construct (string $str = "", HashGetType $hashBy = HashGetType::ByHash)
{ {
$this->HashBy = $HashBy; $this->Hash = match ($hashBy) {
$this->Hash = match ($HashBy) {
HashGetType::ByString => $this->pGetHash($str), HashGetType::ByString => $this->pGetHash($str),
HashGetType::ByFile => $this->pGetFileHash($str) HashGetType::ByFile => $this->pGetFileHash($str),
HashGetType::ByHash => $str
}; };
} }
@@ -76,4 +72,37 @@ final class FileHash
{ {
return StringExtension::Compare($this->Hash, $otherHash->Hash, true) === 0; return StringExtension::Compare($this->Hash, $otherHash->Hash, true) === 0;
} }
/**
* Проверяет, совпадает ли хэш с хэшем/файлом/строкой <code>str</code>.
*
* @param string $str Хэш, строка или имя файла.
* @param HashGetType $hashBy Тип получения хэша.
*
* @return bool <code>true</code>, если совпадают, и <code>false</code>, если не совпадают.
*/
public function Validate (string $str, HashGetType $hashBy): bool
{
return match ($hashBy) {
HashGetType::ByString => $this->pGetHash($str) == $this->Hash,
HashGetType::ByFile => $this->pGetFileHash($str) == $this->Hash,
HashGetType::ByHash => $str == $this->Hash,
};
}
/**
* @inheritDoc
*/
public function Serialize (): string
{
return serialize($this->Hash);
}
/**
* @inheritDoc
*/
public function UnSerialize (string $serialized): void
{
$this->Hash = unserialize($serialized);
}
} }

View File

@@ -9,7 +9,7 @@ use goodboyalex\php_components_pack\traits\EnumExtensionsTrait;
* *
* @author Александр Бабаев * @author Александр Бабаев
* @package php_components_pack * @package php_components_pack
* @version 1.0 * @version 1.1
* @since 1.0.5 * @since 1.0.5
*/ */
enum HashGetType: int enum HashGetType: int
@@ -17,13 +17,18 @@ enum HashGetType: int
// Подключаю расширение для Enum // Подключаю расширение для Enum
use EnumExtensionsTrait; use EnumExtensionsTrait;
/**
* По строке хэша.
*/
case ByHash = 0;
/** /**
* По строке. * По строке.
*/ */
case ByString = 0; case ByString = 1;
/** /**
* По файлу. * По файлу.
*/ */
case ByFile = 1; case ByFile = 2;
} }

View File

@@ -0,0 +1,73 @@
<?php
namespace goodboyalex\php_components_pack\extensions;
use Exception;
/**
* Расширение типа "правда/ложь".
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.0
* @since 1.0.7
*/
final class BoolExtensions
{
/**
* Вывод в строку <code>ifTrue</code>, если выражение <code>b</code> правдиво и <code>ifFalse</code> в противном
* случае.
*
* @param bool $b Выражение типа правда/ложь.
* @param string $ifTrue Строка для правдивого выражения. По умолчанию "true".
* @param string $ifFalse Строка для лживого выражения. По умолчанию "false".
*
* @return string Вывод строки.
*/
public static function ExportToString (bool $b, string $ifTrue = "true", string $ifFalse = "false"): string
{
return $b ? $ifTrue : $ifFalse;
}
/**
* Вычисляет, есть ли хотя бы одно из переменных формата правда/ложь <code>expressions</code> в значении
* <code>true</code>.
*
* @param array $expressions Переменные формата правда/ложь.
*
* @return bool Есть ли хотя бы одно в значении true.
*
* @throws Exception Выбрасывается, если хотя бы один аргумент <code>expressions</code> не являются типом
* правда/ложь.
*/
public static function AnyTrue (array $expressions): bool
{
return self::TrueCount($expressions) > 0;
}
/**
* Вычисляет количество переменных формата правда/ложь <code>expressions</code> в значении <code>true</code>.
*
* @param array $expressions Переменные формата правда/ложь.
*
* @return int Количество переменных в значении true.
*
* @throws Exception Выбрасывается, если хотя бы один аргумент <code>expressions</code> не являются типом
* правда/ложь.
*/
public static function TrueCount (array $expressions): int
{
// Проверяем все аргументы
foreach ($expressions as $expression)
// - если аргумент не является типом правда/ложь
if (!is_bool($expression))
// -- то выбрасываем исключение
throw new Exception('All arguments must be bool. / Все аргументы должны быть типа «правда/ложь».');
// Используем array_filter для фильтрации всех истинных значений
$filtered = array_filter($expressions);
// Возвращаем количество элементов в отфильтрованном массиве
return count($filtered);
}
}

View File

@@ -3,6 +3,8 @@
namespace goodboyalex\php_components_pack\tests\classes; namespace goodboyalex\php_components_pack\tests\classes;
use goodboyalex\php_components_pack\classes\ClassMapper; use goodboyalex\php_components_pack\classes\ClassMapper;
use goodboyalex\php_components_pack\tests\data\A;
use goodboyalex\php_components_pack\tests\data\B;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
class ClassMapperTest extends TestCase class ClassMapperTest extends TestCase
@@ -11,12 +13,10 @@ class ClassMapperTest extends TestCase
{ {
$this->PrepareForTest(); $this->PrepareForTest();
$a = new \goodboyalex\php_components_pack\tests\data\A(); $a = new A('a', 2, true);
$a->a = 'a';
$a->b = 2;
$a->c = true;
$b = new B(); $b = new B();
ClassMapper::MapClass($a, $b); ClassMapper::MapClass($a, $b);
$this->assertEquals('a', $b->a); $this->assertEquals('a', $b->a);

View File

@@ -12,7 +12,11 @@ class FileHashTest extends TestCase
{ {
$this->PrepareForTest(); $this->PrepareForTest();
$fileHash = new FileHash("Тестовое слово"); $fileHash = new FileHash("e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855");
$this->assertEquals("e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", $fileHash->Hash);
$fileHash = new FileHash("Тестовое слово", HashGetType::ByString);
$this->assertEquals("000e22f7ba01ae35f781bc3069038110c46593306cafef6b489f7c83b34629b7", $fileHash->Hash); $this->assertEquals("000e22f7ba01ae35f781bc3069038110c46593306cafef6b489f7c83b34629b7", $fileHash->Hash);
$fileHash = new FileHash(__DIR__ . '/../data/A.php', HashGetType::ByFile); $fileHash = new FileHash(__DIR__ . '/../data/A.php', HashGetType::ByFile);
@@ -27,6 +31,7 @@ class FileHashTest extends TestCase
require_once __DIR__ . '/../../sources/traits/EnumExtensionsTrait.php'; require_once __DIR__ . '/../../sources/traits/EnumExtensionsTrait.php';
require_once __DIR__ . '/../../sources/enums/HashGetType.php'; require_once __DIR__ . '/../../sources/enums/HashGetType.php';
require_once __DIR__ . '/../../sources/extensions/StringExtension.php'; require_once __DIR__ . '/../../sources/extensions/StringExtension.php';
require_once __DIR__ . '/../../sources/interfaces/ISerializable.php';
require_once __DIR__ . '/../../sources/classes/FileHash.php'; require_once __DIR__ . '/../../sources/classes/FileHash.php';
} }
@@ -34,9 +39,49 @@ class FileHashTest extends TestCase
{ {
$this->PrepareForTest(); $this->PrepareForTest();
$fileHash = new FileHash("Тестовое слово"); $fileHash = new FileHash("Тестовое слово", HashGetType::ByString);
$this->assertTrue($fileHash->IsEqual(new FileHash("Тестовое слово"))); $this->assertTrue($fileHash->IsEqual(new FileHash("Тестовое слово", HashGetType::ByString)));
$this->assertFalse($fileHash->IsEqual(new FileHash("Тестовое слово2"))); $this->assertFalse($fileHash->IsEqual(new FileHash("Тестовое слово2", HashGetType::ByString)));
}
public function testSerialize ()
{
$this->PrepareForTest();
$fileHash = new FileHash("Тестовое слово", HashGetType::ByString);
$serialized = $fileHash->Serialize();
$this->assertEquals("s:64:\"000e22f7ba01ae35f781bc3069038110c46593306cafef6b489f7c83b34629b7\";", $serialized);
}
public function testUnSerialize ()
{
$this->PrepareForTest();
$fileHash = new FileHash();
$serialized = "s:64:\"000e22f7ba01ae35f781bc3069038110c46593306cafef6b489f7c83b34629b7\";";
$fileHash->UnSerialize($serialized);
$this->assertEquals("000e22f7ba01ae35f781bc3069038110c46593306cafef6b489f7c83b34629b7", $fileHash->Hash);
}
public function testValidate ()
{
$this->PrepareForTest();
$fileHash = new FileHash("Тестовое слово", HashGetType::ByString);
$this->assertTrue($fileHash->Validate("Тестовое слово", HashGetType::ByString));
$this->assertTrue($fileHash->Validate("000e22f7ba01ae35f781bc3069038110c46593306cafef6b489f7c83b34629b7",
HashGetType::ByHash));
$this->assertFalse($fileHash->Validate("000e22f7ba01ae35f781bc3069038110c46593306cafef6b489f7c83b34629b7",
HashGetType::ByString));
$fileHash = new FileHash(__DIR__ . '/../data/A.php', HashGetType::ByFile);
$this->assertTrue($fileHash->Validate(__DIR__ . '/../data/A.php', HashGetType::ByFile));
} }
} }

View File

@@ -1,10 +1,17 @@
<?php <?php
namespace goodboyalex\php_components_pack\tests\classes; namespace goodboyalex\php_components_pack\tests\data;
class B class B
{ {
public string $a; public string $a;
public int $b; public int $b;
public string $d; public string $d;
public function __construct (string $a = "", int $b = 0, string $d = "")
{
$this->a = $a;
$this->b = $b;
$this->d = $d;
}
} }

View File

@@ -0,0 +1,68 @@
<?php
namespace goodboyalex\php_components_pack\tests\extensions;
use Exception;
use goodboyalex\php_components_pack\extensions\BoolExtensions;
use PHPUnit\Framework\TestCase;
class BoolExtensionsTest extends TestCase
{
public function testAnyTrue ()
{
$this->PrepareForTest();
$hasTrue = [
true, false, true, false, true, false, true, false, true, false, true, false, true, false, true, false,
true, false, true, false, true, false, true, false, true, false, true, false
];
$noTrue = [
false, false, false, false, false, false, false, false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false, false, false, false
];
$this->assertTrue(BoolExtensions::AnyTrue($hasTrue));
$this->assertFalse(BoolExtensions::AnyTrue($noTrue));
}
private function PrepareForTest (): void
{
require_once __DIR__ . '/../../sources/extensions/BoolExtensions.php';
}
public function testTrueCount ()
{
$this->PrepareForTest();
$array = [
true, false, true, false, true, false, true, false, true, false, true, false,
true, false, true, false, true, false, true, false, true, false, true, false, true, false, true,
false
];
$this->assertEquals(14,
BoolExtensions::TrueCount($array));
$this->expectException(Exception::class);
$array[] = "ПРЕДАТЕЛЬ!";
BoolExtensions::TrueCount($array);
}
public function testExportToString ()
{
$this->PrepareForTest();
$b = true;
$this->assertEquals('О, да!', BoolExtensions::ExportToString($b, 'О, да!', 'О, нет!'));
$b = false;
$this->assertEquals('О, нет!', BoolExtensions::ExportToString($b, 'О, да!', 'О, нет!'));
}
}