Compare commits

...

8 Commits

Author SHA1 Message Date
3e199fc460 20250615
* Исправлена ошибка Class "GetOnly" not found.
2025-06-15 15:53:22 +03:00
a58b6f1358 20250612
* Добавлен атрибут для свойств класса #[GetOnly]. Он маркирует только те свойства, которые имеют только get часть, чтобы при маппинге класс корректно его прошёл.

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

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

View File

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

32
composer.lock generated
View File

@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically" "This file is @generated automatically"
], ],
"content-hash": "0c5a35b9c8987ac3fd0f7480fea87d4c", "content-hash": "f5bf0ec4042cb12fb3a702cad65f099d",
"packages": [], "packages": [],
"packages-dev": [ "packages-dev": [
{ {
@ -69,16 +69,16 @@
}, },
{ {
"name": "nikic/php-parser", "name": "nikic/php-parser",
"version": "v5.4.0", "version": "v5.5.0",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/nikic/PHP-Parser.git", "url": "https://github.com/nikic/PHP-Parser.git",
"reference": "447a020a1f875a434d62f2a401f53b82a396e494" "reference": "ae59794362fe85e051a58ad36b289443f57be7a9"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/447a020a1f875a434d62f2a401f53b82a396e494", "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/ae59794362fe85e051a58ad36b289443f57be7a9",
"reference": "447a020a1f875a434d62f2a401f53b82a396e494", "reference": "ae59794362fe85e051a58ad36b289443f57be7a9",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -121,9 +121,9 @@
], ],
"support": { "support": {
"issues": "https://github.com/nikic/PHP-Parser/issues", "issues": "https://github.com/nikic/PHP-Parser/issues",
"source": "https://github.com/nikic/PHP-Parser/tree/v5.4.0" "source": "https://github.com/nikic/PHP-Parser/tree/v5.5.0"
}, },
"time": "2024-12-30T11:07:19+00:00" "time": "2025-05-31T08:24:38+00:00"
}, },
{ {
"name": "phar-io/manifest", "name": "phar-io/manifest",
@ -579,16 +579,16 @@
}, },
{ {
"name": "phpunit/phpunit", "name": "phpunit/phpunit",
"version": "12.1.6", "version": "12.2.1",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/sebastianbergmann/phpunit.git", "url": "https://github.com/sebastianbergmann/phpunit.git",
"reference": "2fdf0056c673c8f0f1eed00030be5f8243c1e6e0" "reference": "5f09fda04e7caea93cff50b4e90319184f3e6ee3"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/2fdf0056c673c8f0f1eed00030be5f8243c1e6e0", "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/5f09fda04e7caea93cff50b4e90319184f3e6ee3",
"reference": "2fdf0056c673c8f0f1eed00030be5f8243c1e6e0", "reference": "5f09fda04e7caea93cff50b4e90319184f3e6ee3",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -602,7 +602,7 @@
"phar-io/manifest": "^2.0.4", "phar-io/manifest": "^2.0.4",
"phar-io/version": "^3.2.1", "phar-io/version": "^3.2.1",
"php": ">=8.3", "php": ">=8.3",
"phpunit/php-code-coverage": "^12.2.1", "phpunit/php-code-coverage": "^12.3.0",
"phpunit/php-file-iterator": "^6.0.0", "phpunit/php-file-iterator": "^6.0.0",
"phpunit/php-invoker": "^6.0.0", "phpunit/php-invoker": "^6.0.0",
"phpunit/php-text-template": "^5.0.0", "phpunit/php-text-template": "^5.0.0",
@ -610,7 +610,7 @@
"sebastian/cli-parser": "^4.0.0", "sebastian/cli-parser": "^4.0.0",
"sebastian/comparator": "^7.0.1", "sebastian/comparator": "^7.0.1",
"sebastian/diff": "^7.0.0", "sebastian/diff": "^7.0.0",
"sebastian/environment": "^8.0.1", "sebastian/environment": "^8.0.2",
"sebastian/exporter": "^7.0.0", "sebastian/exporter": "^7.0.0",
"sebastian/global-state": "^8.0.0", "sebastian/global-state": "^8.0.0",
"sebastian/object-enumerator": "^7.0.0", "sebastian/object-enumerator": "^7.0.0",
@ -624,7 +624,7 @@
"type": "library", "type": "library",
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-main": "12.1-dev" "dev-main": "12.2-dev"
} }
}, },
"autoload": { "autoload": {
@ -656,7 +656,7 @@
"support": { "support": {
"issues": "https://github.com/sebastianbergmann/phpunit/issues", "issues": "https://github.com/sebastianbergmann/phpunit/issues",
"security": "https://github.com/sebastianbergmann/phpunit/security/policy", "security": "https://github.com/sebastianbergmann/phpunit/security/policy",
"source": "https://github.com/sebastianbergmann/phpunit/tree/12.1.6" "source": "https://github.com/sebastianbergmann/phpunit/tree/12.2.1"
}, },
"funding": [ "funding": [
{ {
@ -680,7 +680,7 @@
"type": "tidelift" "type": "tidelift"
} }
], ],
"time": "2025-05-21T12:36:31+00:00" "time": "2025-06-07T05:17:47+00:00"
}, },
{ {
"name": "sebastian/cli-parser", "name": "sebastian/cli-parser",

View File

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

View File

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

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

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

View File

@ -0,0 +1,272 @@
# Описание класса VersionInfo
## Информация о версии
Версия класса: 1.0
Впервые введено в пакет с версии: 1.0.24
Описание класса: Класс, описывающий информацию о версии.
## Публичные свойства и константы класса
В классе определены следующие константы:
* `array StagesNames` - имена стадий сборки.
* `string DefaultTemplate` - шаблон вывода по умолчанию.
В классе определены следующе свойства:
* `int $Major` - мажорная версия (**только чтение**).
* `int $Minor` - минорная версия (**только чтение**).
* `int $Release` - номер релиза (**только чтение**).
* `int $Build` - номер сборки (**только чтение**).
* `VersionInfoStage $Stage` - стадия сборки (**только чтение**).
* `int $StageNumber` - номер стадии сборки (**только чтение**).
## Методы и функции
### Конструктор.
Конструктор принимает **4 обязательных** и **2 дополнительных параметра**:
* `int $Major` - мажорная версия (**обязательный**);
* `int $Minor` - минорная версия (**обязательный**);
* `int $Release` - номер релиза (**обязательный**);
* `int $Build` - номер сборки (**обязательный**);
* `VersionInfoStage` $Stage - стадия сборки (по умолчанию, `VersionInfoStage::Undefined`);
* `int $StageNumber` - номер стадии сборки (по умолчанию, `0`).
В результате создаётся новый класс `VersionInfo`.
Пример:
$version = new VersionInfo (1, 0, 0, 0, VersionInfoStage::Beta, 1);
Создаст класс `VersionInfo` для версии `1.0.0.0 Beta 1`.
### Преобразование в строку.
За преобразование в строку отвечает 2 метода: `ToString` и `__toString ()`.
#### Метод `ToString`
Этот метод возвращает строковое представление версии. Он содержит **2 необязательных параметра**:
* `string $template` - шаблон вывода (по умолчанию, `DefaultTemplate`);
* `array $stagesNames` - имена стадий сборки (по умолчанию, `StagesNames`).
Метод возвращает `string` - строковое представление версии.
В шаблоне должны присутствовать маркеры:
| Маркер | Описание | Обязательный |
|:--------------:|:--------------------|:------------:|
| #{Major} | Мажорная версия | ДА |
| #{Minor} | Минорная версия | ДА |
| #{Release} | Номер релиза | ДА |
| #{Build} | Номер сборки | ДА |
| #{Stage} | Стадия сборки | НЕТ |
| #{StageNumber} | Номер стадии сборки | НЕТ |
Эти маркеры в шаблоне заменяются на значения соответствующих свойств.
Синтаксис:
public function ToString (string $template, array $stagesNames): string
Пример,
// Создаю объект
$version = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
// Задаю шаблон
$template = #{Major}.#{Minor}.#{Release} (сборка #{Build});
// Вывожу
echo $version->ToString($template);
В результате на экране появится:
1.2.3 (сборка 4)
#### Метод `__toString`
Этот метод полностью аналогичен методу `ToString` с той лишь разницей, что в этом методе невозможно задать параметры
вывода (такие, как шаблон и имена стадий). Эти параметры берутся по умолчанию.
Этот метод необходим для вывода корректной информации при попытке привести объект класса `VersionInfo` к типу `string`.
Метод возвращает `string` - строковое представление версии.
Синтаксис:
public function __toString (): string
Пример,
// Создаю объект
$version = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
// Вывожу
echo $version;
В результате на экране появится:
1.2.3.4 Beta 5
### Сравнение версий
Для сравнения версий используется две аналогичные друг другу (но различающиеся по способу вызова) функции: `Compare` и
`CompareWith`.
#### Метод `Compare`
Это статический метод, который сравнивает две версии, заданные в **2 обязательных параметрах**:
* `VersionInfo $version1` - версия 1;
* `VersionInfo $version2` - версия 2.
Этот метод возвращает `int`:
| version1 | version2 | Результат |
|:---------:|:---------:|:---------:|
| Младше | Старше | -1 |
| Совпадает | Совпадает | 0 |
| Старше | Младше | 1 |
Синтаксис:
public static function Compare (VersionInfo $version1, VersionInfo $version2): int
Пример,
// Создаю объекты
// - $version11 младше $version12
$version11 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
$version12 = new VersionInfo (1, 2, 3, 5, VersionInfoStage::Beta, 6);
// $version21 совпадает с $version22
$version21 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
$version22 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
// $version31 старше $version32
$version31 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Stable);
$version32 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
// Сравниваю
$verCompare1 = VersionInfo::Compare($version11, $version12);
$verCompare2 = VersionInfo::Compare($version21, $version22);
$verCompare3 = VersionInfo::Compare($version31, $version32);
// Вывожу
echo $verCompare1 . '|' . $verCompare2 . '|' . $verCompare3;
В результате на экране появится:
-1|0|1
#### Метод `CompareWith`
Этот метод полностью аналогичен методу `Compare`. Он отличается лишь только тем, что **не статичен** и вызывается из
ранее созданного экземпляра класса. Он сравнивает текущую версию с переданной. Этот метод имеет только **1 обязательный
параметр**: `VersionInfo $version` - переданная версия.
Этот метод возвращает `int`: `1`, если текущая версия старше переданной, `0`, если совпадает и `-1`, если текущая версия
младше переданной.
Синтаксис:
public function CompareWith (VersionInfo $version): int
Пример,
// Создаю объекты
// - $version11 младше $version12
$version11 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
$version12 = new VersionInfo (1, 2, 3, 5, VersionInfoStage::Beta, 6);
// $version21 совпадает с $version22
$version21 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
$version22 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
// $version31 старше $version32
$version31 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Stable);
$version32 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
// Сравниваю
$verCompare1 = $version11->CompareWith($version12);
$verCompare2 = $version21->CompareWith($version22);
$verCompare3 = $version31->CompareWith($version32);
// Вывожу
echo $verCompare1 . '|' . $verCompare2 . '|' . $verCompare3;
В результате на экране появится:
-1|0|1
### Парсинг версий
Для преобразования строки с версией в объект `VersionInfo` используется статичный метод `Parse`.
Он требует **1 обязательный параметр** и **1 необязательный**:
* `string $version` - строка с версией (она должна быть в формате
`#{Major}.#{Minor}.#{Release}.#{Build} #{Stage} #{StageNumber}`, причём `#{Stage}` и `#{StageNumber}` можно не
указывать);
* `array $stagesNames` - имена стадий сборки (по умолчанию, `StagesNames`).
Этот метод возвращает объект {@link VersionInfo} с данными о версии или `new VersionInfo(0, 0, 0, 0)` в случае ошибки.
Синтаксис:
public static function Parse (string $version, array $stagesNames = self::StagesNames): VersionInfo
Пример,
// Создаю текст
$verText = '1.2.3.4 Beta 2';
// Преобразую
$version = VersionInfo::Parse($verText);
// Вывожу
echo $version;
В результате на экране появится:
1.2.3.4 Beta 2
### Вспомогательные методы
#### Метод `IsNotUndefinedOrStable`
Этот **статический** метод проверяет, является ли версия в неопределённой стадии или уже релизом.
Он имеет только **1 обязательный параметр**: `VersionInfoStage $versionStage` - стадия сборки.
Этот метод возвращает `bool`: `true`, если стадия сборки определена и не является релизом и `false` в противном случае.
Синтаксис:
public static function IsNotUndefinedOrStable (VersionInfoStage $versionStage): bool
Пример,
// Создаю объекты
$version1 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Undefined, 5);
$version2 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
$version3 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Stable);
// Сравниваю
$res1 = VersionInfo::IsNotUndefinedOrStabl($version1->Stage);
$res2 = VersionInfo::IsNotUndefinedOrStabl($version2->Stage);
$res3 = VersionInfo::IsNotUndefinedOrStabl($version3->Stage);
// Вывожу
echo $res1 . '|' . $res2 . '|' . $res3;
В результате на экране появится:
false|true|false

View File

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

View File

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

View File

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

View File

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

View File

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