12 Commits

Author SHA1 Message Date
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
97f73a73e2 20250525
Добавлен новый класс Tuple, реализующий работу кортежей почти как в C#.
2025-05-25 12:45:43 +03:00
6a4df8373c 20250524
- Добавлено перечисление VarNotBoolAction, для определения действий в классе BoolExtensions (методы AnyTrue и TrueCount), если передана часть не булевого типа.

- В расширении BoolExtensions в методах AnyTrue и TrueCount убрано выброс исключение, если какой-то аргумент из массива expressions не является булевым типом. Вместо него в обоих методах введён необязательный параметр $ifNotBool (тип VarNotBoolAction), который определяет действие: игнорирование (этот аргумент просто исключается из проверки), считать правдивым (вместо него ставится true) и считать ложным (вместо него ставится false).
2025-05-24 14:31:14 +03:00
10ec8df983 20250522
* [Dictionary, ObjectArray] Исправлен баг сериализации. Теперь классы нормально восстанавливаются.
2025-05-22 22:03:39 +03:00
2d16baaef9 20250520
[Dictionary] добавлен метод AddRange (array $dictionary), который добавляет элементы в виде ассоциативного массива ключ => значение в словарь.

[Dictionary] Добавлен метод ToArray (), который возвращает все элементы словаря в виде массива..
2025-05-20 12:42:06 +03:00
2e684cb862 20250519
* [Dictionary, ObjectArray] Исправлен метод сериализации. Теперь классы нормально восстанавливаются.
2025-05-19 07:04:25 +03:00
f98a277986 Merge remote-tracking branch 'Babaev-anGit/main' 2025-05-16 23:35:54 +03:00
5b83b096e5 20250516
* [Dictionary] Добавлен метод Keys (): array, который возвращает все ключи словаря.
* [Dictionary] Добавлен метод Sort (bool $descending = false): void, который сортирует внутренние данные по ключам (в обратном порядке, если выбран $descending = true).
2025-05-16 23:35:48 +03:00
13 changed files with 789 additions and 71 deletions

View File

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

72
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": "62046e22c8307ed8e1f622a0f7bd7a05", "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",
@@ -245,16 +245,16 @@
}, },
{ {
"name": "phpunit/php-code-coverage", "name": "phpunit/php-code-coverage",
"version": "12.2.1", "version": "12.3.0",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/sebastianbergmann/php-code-coverage.git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git",
"reference": "448f2c504d86dbff3949dcd02c95aa85db2c7617" "reference": "9075a8efc66e11bc55c319062e147bdb06777267"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/448f2c504d86dbff3949dcd02c95aa85db2c7617", "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/9075a8efc66e11bc55c319062e147bdb06777267",
"reference": "448f2c504d86dbff3949dcd02c95aa85db2c7617", "reference": "9075a8efc66e11bc55c319062e147bdb06777267",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@@ -281,7 +281,7 @@
"type": "library", "type": "library",
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-main": "12.2.x-dev" "dev-main": "12.3.x-dev"
} }
}, },
"autoload": { "autoload": {
@@ -310,7 +310,7 @@
"support": { "support": {
"issues": "https://github.com/sebastianbergmann/php-code-coverage/issues", "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues",
"security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy", "security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy",
"source": "https://github.com/sebastianbergmann/php-code-coverage/tree/12.2.1" "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/12.3.0"
}, },
"funding": [ "funding": [
{ {
@@ -330,7 +330,7 @@
"type": "tidelift" "type": "tidelift"
} }
], ],
"time": "2025-05-04T05:25:05+00:00" "time": "2025-05-23T15:49:03+00:00"
}, },
{ {
"name": "phpunit/php-file-iterator", "name": "phpunit/php-file-iterator",
@@ -579,16 +579,16 @@
}, },
{ {
"name": "phpunit/phpunit", "name": "phpunit/phpunit",
"version": "12.1.5", "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": "f93ef2198df8d54b3195bcee381a33be51d8705e" "reference": "5f09fda04e7caea93cff50b4e90319184f3e6ee3"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/f93ef2198df8d54b3195bcee381a33be51d8705e", "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/5f09fda04e7caea93cff50b4e90319184f3e6ee3",
"reference": "f93ef2198df8d54b3195bcee381a33be51d8705e", "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.0", "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.5" "source": "https://github.com/sebastianbergmann/phpunit/tree/12.2.1"
}, },
"funding": [ "funding": [
{ {
@@ -680,7 +680,7 @@
"type": "tidelift" "type": "tidelift"
} }
], ],
"time": "2025-05-11T06:44:52+00:00" "time": "2025-06-07T05:17:47+00:00"
}, },
{ {
"name": "sebastian/cli-parser", "name": "sebastian/cli-parser",
@@ -946,16 +946,16 @@
}, },
{ {
"name": "sebastian/environment", "name": "sebastian/environment",
"version": "8.0.0", "version": "8.0.2",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/sebastianbergmann/environment.git", "url": "https://github.com/sebastianbergmann/environment.git",
"reference": "8afe311eca49171bf95405cc0078be9a3821f9f2" "reference": "d364b9e5d0d3b18a2573351a1786fbf96b7e0792"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/8afe311eca49171bf95405cc0078be9a3821f9f2", "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/d364b9e5d0d3b18a2573351a1786fbf96b7e0792",
"reference": "8afe311eca49171bf95405cc0078be9a3821f9f2", "reference": "d364b9e5d0d3b18a2573351a1786fbf96b7e0792",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@@ -998,15 +998,27 @@
"support": { "support": {
"issues": "https://github.com/sebastianbergmann/environment/issues", "issues": "https://github.com/sebastianbergmann/environment/issues",
"security": "https://github.com/sebastianbergmann/environment/security/policy", "security": "https://github.com/sebastianbergmann/environment/security/policy",
"source": "https://github.com/sebastianbergmann/environment/tree/8.0.0" "source": "https://github.com/sebastianbergmann/environment/tree/8.0.2"
}, },
"funding": [ "funding": [
{ {
"url": "https://github.com/sebastianbergmann", "url": "https://github.com/sebastianbergmann",
"type": "github" "type": "github"
},
{
"url": "https://liberapay.com/sebastianbergmann",
"type": "liberapay"
},
{
"url": "https://thanks.dev/u/gh/sebastianbergmann",
"type": "thanks_dev"
},
{
"url": "https://tidelift.com/funding/github/packagist/sebastian/environment",
"type": "tidelift"
} }
], ],
"time": "2025-02-07T04:56:08+00:00" "time": "2025-05-21T15:05:44+00:00"
}, },
{ {
"name": "sebastian/exporter", "name": "sebastian/exporter",
@@ -1609,4 +1621,4 @@
}, },
"platform-dev": {}, "platform-dev": {},
"plugin-api-version": "2.6.0" "plugin-api-version": "2.6.0"
} }

View File

@@ -13,7 +13,7 @@ use IteratorAggregate;
* *
* @author Александр Бабаев * @author Александр Бабаев
* @package php_components_pack * @package php_components_pack
* @version 1.0 * @version 1.0.3
* @since 1.0.14 * @since 1.0.14
*/ */
final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISerializable final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISerializable
@@ -26,6 +26,21 @@ final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISe
// Реализация наследуемых интерфейсов и классов // Реализация наследуемых интерфейсов и классов
use ArrayBasicTrait; use ArrayBasicTrait;
/**
* Добавление элементов в словарь.
*
* @param array $dictionary Ассоциативный массив вида ключ => значение, который будет добавлен в словарь.
*
* @return void
*/
public function AddRange (array $dictionary): void
{
// Для каждого элемента массива
foreach ($dictionary as $key => $value)
// - добавляем его в словарь.
$this->Add($key, $value);
}
/** /**
* Добавление элемента в словарь. * Добавление элемента в словарь.
* *
@@ -125,4 +140,14 @@ final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISe
// - иначе, стандартная сортировка по ключам в порядке возрастания // - иначе, стандартная сортировка по ключам в порядке возрастания
ksort($this->Container); ksort($this->Container);
} }
/**
* Возвращает все элементы словаря в виде массива.
*
* @return array Массив, содержащий все элементы словаря.
*/
public function ToArray (): array
{
return $this->Container;
}
} }

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

@@ -17,7 +17,7 @@ use IteratorAggregate;
* *
* @author Александр Бабаев * @author Александр Бабаев
* @package php_components_pack * @package php_components_pack
* @version 1.0 * @version 1.0.5
* @since 1.0 * @since 1.0
*/ */
final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, ISerializable final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, ISerializable

121
sources/classes/Tuple.php Normal file
View File

@@ -0,0 +1,121 @@
<?php
namespace goodboyalex\php_components_pack\classes;
use ArrayAccess;
use ArrayIterator;
use Countable;
use Exception;
use goodboyalex\php_components_pack\interfaces\ISerializable;
use IteratorAggregate;
use Traversable;
/**
* Класс, реализующий функционал кортежей от C#.
*
* @author Александр Бабаев
* @package php_components_pack
* @version 1.2
* @since 1.0.20
*/
final class Tuple implements ISerializable, ArrayAccess, IteratorAggregate, Countable
{
/**
* @var array Массив значений кортежа.
*/
private array $Values;
/**
* Конструктор кортежа.
*
* @param mixed ...$values Значения кортежа.
*/
public function __construct (...$values)
{
$this->Values = $values;
}
/**
* @inheritDoc
*/
public function Serialize (): string
{
return serialize($this->Values);
}
/**
* @inheritDoc
*/
public function UnSerialize (string $serialized): void
{
$this->Values = unserialize($serialized);
}
/**
* @inheritDoc
*/
public function offsetExists (mixed $offset): bool
{
return isset($this->Values[$offset]);
}
/**
* @inheritDoc
*/
public function offsetGet (mixed $offset): mixed
{
// Если ключ не является целым числом
if (!is_int($offset))
// - возвращаем null
return null;
// Возвращаем значение кортежа по индексу
return $this->Get($offset);
}
/**
* Возвращает значение кортежа по индексу.
*
* @param int $index Индекс значения.
*
* @return mixed Значение кортежа по индексу.
*/
public function Get (int $index): mixed
{
return $this->Values[$index] ?? null;
}
/**
* @inheritDoc
* @throws Exception Элементы кортежа не могут быть изменены после создания! / Tuple elements cannot be changed
* after creation!
*/
public function offsetSet (mixed $offset, mixed $value): void
{
throw new Exception('Элементы кортежа не могут быть изменены после создания! / Tuple elements cannot be changed after creation!');
}
/**
* @inheritDoc
*/
public function offsetUnset (mixed $offset): void
{
unset($this->Values[$offset]);
}
/**
* @inheritDoc
*/
public function getIterator (): Traversable
{
return new ArrayIterator($this->Values);
}
/**
* @inheritDoc
*/
public function count (): int
{
return count($this->Values);
}
}

View File

@@ -0,0 +1,34 @@
<?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.19
*/
enum VarNotBoolAction: int
{
// Подключаю расширение для Enum
use EnumExtensionsTrait;
/**
* Игнорировать это утверждение.
*/
case Ignore = 0;
/**
* Считать это утверждение истинным.
*/
case ConsiderItTrue = 1;
/**
* Считать это утверждение ложным.
*/
case ConsiderItFalse = 2;
}

View File

@@ -2,14 +2,14 @@
namespace goodboyalex\php_components_pack\extensions; namespace goodboyalex\php_components_pack\extensions;
use Exception; use goodboyalex\php_components_pack\enums\VarNotBoolAction;
/** /**
* Расширение типа "правда/ложь". * Расширение типа "правда/ложь".
* *
* @author Александр Бабаев * @author Александр Бабаев
* @package php_components_pack * @package php_components_pack
* @version 1.0 * @version 1.1
* @since 1.0.7 * @since 1.0.7
*/ */
final class BoolExtensions final class BoolExtensions
@@ -34,38 +34,55 @@ final class BoolExtensions
* <code>true</code>. * <code>true</code>.
* *
* @param array $expressions Переменные формата правда/ложь. * @param array $expressions Переменные формата правда/ложь.
* @param VarNotBoolAction $ifNotBool Действие, если какой-то аргумент <code>expressions</code> не является булевым
* типом. По умолчанию игнорировать.
* *
* @return bool Есть ли хотя бы одно в значении true. * @return bool Есть ли хотя бы одно в значении true.
* *
* @throws Exception Выбрасывается, если хотя бы один аргумент <code>expressions</code> не являются типом
* правда/ложь.
*/ */
public static function AnyTrue (array $expressions): bool public static function AnyTrue (array $expressions, VarNotBoolAction $ifNotBool = VarNotBoolAction::Ignore): bool
{ {
return self::TrueCount($expressions) > 0; return self::TrueCount($expressions, $ifNotBool) > 0;
} }
/** /**
* Вычисляет количество переменных формата правда/ложь <code>expressions</code> в значении <code>true</code>. * Вычисляет количество переменных формата правда/ложь <code>expressions</code> в значении <code>true</code>.
* *
* @param array $expressions Переменные формата правда/ложь. * @param array $expressions Переменные формата правда/ложь.
* @param VarNotBoolAction $ifNotBool Действие, если какой-то аргумент <code>expressions</code> не является булевым
* типом. По умолчанию игнорировать.
* *
* @return int Количество переменных в значении true. * @return int Количество переменных в значении true.
*
* @throws Exception Выбрасывается, если хотя бы один аргумент <code>expressions</code> не являются типом
* правда/ложь.
*/ */
public static function TrueCount (array $expressions): int public static function TrueCount (array $expressions, VarNotBoolAction $ifNotBool = VarNotBoolAction::Ignore): int
{ {
// Проверяем все аргументы // Создаем пустой массив для хранения проверяемых аргументов
$checkArray = [];
// Проверяем все входящие аргументы
foreach ($expressions as $expression) foreach ($expressions as $expression)
// - если аргумент не является типом правда/ложь // - если аргумент не является типом правда/ложь
if (!is_bool($expression)) if (!is_bool($expression))
// -- то выбрасываем исключение // -- то делаем следующее в зависимости от настроек:
throw new Exception('All arguments must be bool. / Все аргументы должны быть типа «правда/ложь».'); switch ($ifNotBool) {
case VarNotBoolAction::Ignore:
// --- игнорируем аргумент
break;
case VarNotBoolAction::ConsiderItTrue:
// --- считаем аргумент как истинное значение
$checkArray[] = true;
break;
case VarNotBoolAction::ConsiderItFalse:
// --- считаем аргумент как ложное значение
$checkArray[] = false;
break;
}
else
// - иначе добавляем аргумент в массив проверяемых аргументов
$checkArray[] = $expression;
// Используем array_filter для фильтрации всех истинных значений // Используем array_filter для фильтрации всех истинных значений
$filtered = array_filter($expressions); $filtered = array_filter($checkArray, fn ($value) => $value === true);
// Возвращаем количество элементов в отфильтрованном массиве // Возвращаем количество элементов в отфильтрованном массиве
return count($filtered); return count($filtered);

View File

@@ -77,7 +77,11 @@ trait ArrayBasicTrait
*/ */
public function Serialize (): string public function Serialize (): string
{ {
return json_encode($this->Container); /**
* ВНИМАНИЕ! Не используйте json_encode для сериализации объектов данного класса, так как он НЕ СОХРАНЯЕТ классы объектов!
* Корректное восстановление объектов невозможно (восстанавливает только как ассоциативный массив).
*/
return serialize($this->Container);
} }
/** /**
@@ -85,6 +89,10 @@ trait ArrayBasicTrait
*/ */
public function UnSerialize (string $serialized): void public function UnSerialize (string $serialized): void
{ {
$this->Container = json_decode($serialized, true); /**
* ВНИМАНИЕ! Не используйте json_decode для десериализации объектов данного класса, так как он НЕ ВОССТАНОВЛЯЕТ
* классы объектов! Корректное восстановление объектов невозможно (восстанавливается только как ассоциативный массив).
*/
$this->Container = unserialize($serialized);
} }
} }

View File

@@ -31,18 +31,6 @@ class DictionaryTest extends TestCase
require_once __DIR__ . '/../../sources/classes/Dictionary.php'; require_once __DIR__ . '/../../sources/classes/Dictionary.php';
} }
public function testSerialize ()
{
$this->PrepareForTest();
$dict = new Dictionary();
$dict->Add('1', 1);
$dict->Add('2', '2');
$dict->Add('3', true);
$this->assertEquals("{\"1\":1,\"2\":\"2\",\"3\":true}", $dict->Serialize());
}
public function testGet () public function testGet ()
{ {
$this->PrepareForTest(); $this->PrepareForTest();
@@ -129,4 +117,38 @@ class DictionaryTest extends TestCase
$this->assertArrayIsEqualToArrayIgnoringListOfKeys($array, $dict->Keys(), []); $this->assertArrayIsEqualToArrayIgnoringListOfKeys($array, $dict->Keys(), []);
} }
public function testAddRange ()
{
$this->PrepareForTest();
$dict = new Dictionary();
$dict->Add('1', 1);
$array = ['2' => '2', '3' => true, '4' => false];
$dict->AddRange($array);
$this->assertEquals(1, $dict->Get('1'));
$this->assertTrue($dict->Get('3'));
$this->assertEquals(4, $dict->count());
$this->assertFalse($dict->Get("4"));
}
public function testToArray ()
{
$this->PrepareForTest();
$dict = new Dictionary();
$dict->Add('1', 1);
$dict->Add('3', true);
$dict->Add('2', '2');
$array = $dict->ToArray();
$this->assertIsArray($array);
$this->assertEquals(1, $array['1']);
$this->assertTrue($array['3']);
$this->assertCount(3, $array);
}
} }

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,37 @@
<?php
namespace goodboyalex\php_components_pack\tests\classes;
use Exception;
use goodboyalex\php_components_pack\classes\Tuple;
use PHPUnit\Framework\TestCase;
class TupleTest extends TestCase
{
public function testTuple ()
{
$this->PrepareForTest();
$tuple = new Tuple(1, 'string', ['array1', 'array2', 'array3']);
// Проверка на то, что возвращает значение кортежа при запросе значения по индексу
$this->assertEquals(1, $tuple->Get(0));
$this->assertEquals('string', $tuple->Get(1));
$this->assertEquals(['array1', 'array2', 'array3'], $tuple->Get(2));
// Проверка на то, что возвращает переменные
[$firstElement, $secondElement, $thirdElement] = $tuple;
$this->assertEquals(1, $firstElement);
$this->assertEquals('string', $secondElement);
$this->assertEquals(['array1', 'array2', 'array3'], $thirdElement);
// Проверка на то, что выбрасывает исключение при попытке задать данные в кортеж после его создания
$this->expectException(Exception::class);
$tuple[] = 'New data';
}
private function PrepareForTest (): void
{
require_once __DIR__ . '/../../sources/classes/Tuple.php';
}
}

View File

@@ -2,7 +2,7 @@
namespace goodboyalex\php_components_pack\tests\extensions; namespace goodboyalex\php_components_pack\tests\extensions;
use Exception; use goodboyalex\php_components_pack\enums\VarNotBoolAction;
use goodboyalex\php_components_pack\extensions\BoolExtensions; use goodboyalex\php_components_pack\extensions\BoolExtensions;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
@@ -30,6 +30,7 @@ class BoolExtensionsTest extends TestCase
private function PrepareForTest (): void private function PrepareForTest (): void
{ {
require_once __DIR__ . '/../../sources/enums/VarNotBoolAction.php';
require_once __DIR__ . '/../../sources/extensions/BoolExtensions.php'; require_once __DIR__ . '/../../sources/extensions/BoolExtensions.php';
} }
@@ -46,23 +47,19 @@ class BoolExtensionsTest extends TestCase
$this->assertEquals(14, $this->assertEquals(14,
BoolExtensions::TrueCount($array)); BoolExtensions::TrueCount($array));
$this->expectException(Exception::class);
$array[] = "ПРЕДАТЕЛЬ!"; $array[] = "ПРЕДАТЕЛЬ!";
BoolExtensions::TrueCount($array); $this->assertEquals(14, BoolExtensions::TrueCount($array));
$this->assertEquals(14, BoolExtensions::TrueCount($array, VarNotBoolAction::ConsiderItFalse));
$this->assertEquals(15, BoolExtensions::TrueCount($array, VarNotBoolAction::ConsiderItTrue));
} }
public function testExportToString () public function testExportToString ()
{ {
$this->PrepareForTest(); $this->PrepareForTest();
$b = true; $this->assertEquals('О, да!', BoolExtensions::ExportToString(true, 'О, да!', 'О, нет!'));
$this->assertEquals('О, да!', BoolExtensions::ExportToString($b, 'О, да!', 'О, нет!')); $this->assertEquals('О, нет!', BoolExtensions::ExportToString(false, 'О, да!', 'О, нет!'));
$b = false;
$this->assertEquals('О, нет!', BoolExtensions::ExportToString($b, 'О, да!', 'О, нет!'));
} }
} }