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, который преобразует размер файла в байтах в красивое строковое представление

composer.json

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

composer.lock

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

sources/classes/File.php

@@ -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]";
+    }
+}

tests/classes/FileTest.php

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