tokimikichika/file-reader

File reading utilities

v0.1.0 2025-10-17 13:45 UTC

Requires

• php: >=8.0

Requires (Dev)

• phpunit/phpunit: ^10.0

MIT

• Tokimikichika

README

Простая библиотека для чтения текстовых файлов.

Установка

Если используешь как отдельный пакет:

composer require tokimikichika/file-reader

Если используешь в монорепозитории как path-репозиторий, добавь в composer.json:

{
  "repositories": [
    { "type": "path", "url": "../../file-reader" }
  ],
  "require": {
    "tokimikichika/file-reader": "*"
  }
}

Затем:

composer update

Использование

Простое использование

use Tokimikichika\FileReader\TextReader;

$reader = new TextReader();
$content = $reader->read(__DIR__ . '/tests/fixtures/sample.txt');
// $content содержит текст файла

Обработка ошибок

use Tokimikichika\FileReader\TextReader;
use RuntimeException;

$reader = new TextReader();

try {
    $content = $reader->read('/path/to/missing.txt');
} catch (RuntimeException $e) {
    // Логика обработки ошибки (файл не найден или не прочитан)
}

Архитектура

• TextReader — основной класс для безопасного чтения текстовых файлов c проверками:
  • проверка существования файла
  • обработка ошибок чтения

Возможности

• Чтение содержимого текстового файла в строку
• Бросает RuntimeException, если файл не найден или не удаётся прочитать
• Минимальные зависимости, готово для использования в сервисах и CLI

Тестирование

composer install
composer test

Лицензия

MIT