Необходимо написать minion таск на php 7.1, который позволит генерировать xlsx отчеты.…
- User
Необходимо написать minion таск на php 7.1, который позволит генерировать xlsx отчеты. На данный момент есть 2 вида отчетов, но в будущем их может стать больше. Необходимо использовать библиотеку box/spout 3.1 Как лучше организовать код таска в таком случае?
- Assistant
Для создания Minion таска, который генерирует XLSX отчеты с использованием библиотеки
box/spoutверсии 3.1, и при этом поддерживает возможность расширения на новые типы отчетов — важно правильно организовать архитектуру кода.📌 Цели:
- Разделить логику генерации отчетов;
- Упростить добавление новых типов отчетов в будущем;
- Использовать принципы SOLID (особенно Open/Closed Principle);
- Не захламлять таск логикой, делегировать ответственность классам-генераторам отчетов.
✅ 1. Структура каталогов
Предложенная структура:
/classes /Minion /Task ReportGenerate.php /Report /Generators UserActivityReport.php SalesReport.php ReportGeneratorInterface.php ReportFactory.php /vendor
✅ 2. Интерфейс генератора отчетов
// /classes/Report/ReportGeneratorInterface.php interface ReportGeneratorInterface { /** * Генерирует отчет и возвращает путь к файлу. * * @return string */ public function generate(): string; }
✅ 3. Пример конкретного генератора
// /classes/Report/Generators/UserActivityReport.php use Box\Spout\Writer\Common\Creator\WriterEntityFactory; use Box\Spout\Common\Entity\Row; class Report_Generators_UserActivityReport implements ReportGeneratorInterface { public function generate(): string { $filePath = APPPATH . 'logs/user_activity_report_' . date('Ymd_His') . '.xlsx'; $writer = WriterEntityFactory::createXLSXWriter(); $writer->openToFile($filePath); // Пример данных $headers = ['User ID', 'Name', 'Last Login']; $rows = [ [1, 'John Doe', '2025-07-14 12:00'], [2, 'Jane Doe', '2025-07-13 14:30'] ]; $writer->addRow(WriterEntityFactory::createRowFromArray($headers)); foreach ($rows as $row) { $writer->addRow(WriterEntityFactory::createRowFromArray($row)); } $writer->close(); return $filePath; } }
✅ 4. ReportFactory (Фабрика генераторов)
// /classes/Report/ReportFactory.php class Report_ReportFactory { public static function create(string $type): ReportGeneratorInterface { switch ($type) { case 'user_activity': return new Report_Generators_UserActivityReport(); case 'sales': return new Report_Generators_SalesReport(); default: throw new InvalidArgumentException("Неизвестный тип отчета: {$type}"); } } }
✅ 5. Minion таск
// /classes/Minion/Task/ReportGenerate.php class Minion_Task_ReportGenerate extends Minion_Task { protected $_options = [ 'type' => null, // Тип отчета ]; protected function _execute(array $params) { try { if (empty($params['type'])) { throw new InvalidArgumentException('Необходимо передать параметр --type'); } /** @var ReportGeneratorInterface $generator */ $generator = Report_ReportFactory::create($params['type']); $filePath = $generator->generate(); Minion_CLI::write("Отчет успешно создан: {$filePath}"); } catch (Exception $e) { Minion_CLI::write('Ошибка при генерации отчета: ' . $e->getMessage()); } } }
✅ 6. Пример запуска таска
php index.php --task=ReportGenerate --type=user_activity
✅ 7. Установка box/spout
Убедитесь, что библиотека установленa:
composer require box/spout:^3.1
✅ Преимущества подхода
- Каждый отчет изолирован в свой класс
- Легко добавлять новые отчеты
- Minion таск остается простым и ответственным только за выбор и запуск логики
- Использована проверенная библиотека для генерации xlsx
Если потребуется добавить новый отчет — просто создайте новый класс-генератор и зарегистрируйте его в
ReportFactory.
❓Вопросы на будущее
- Нужна ли фильтрация/параметры отчета? → тогда передавать параметры в
generate() - Нужен ли единый шаблон выхода? (например: лог, email, загрузка в S3)
Если нужно поддержку параметров —
generate(array $params = [])
Нужно пример генерации отчета с параметрами или сохранением в определенную директорию?
- User
данные запрашиваются пачками в цикле do...while
- Assistant
Отлично! Если данные для отчета обрабатываются постранично (батчами) в цикле
do...while, то это важно учитывать в реализации генератора отчета. Такой подход позволяет:- обрабатывать большие объемы данных в рамках доступной памяти (особенно важно для PHP 7.1),
- улучшить читаемость и структуру кода.
📌 Расширим генератор отчета с использованием батчей
Допустим, у нас есть некий источник данных, например — БД или API. Мы будем обрабатывать данные порциями, скажем по 500 записей, и писать их в файл по мере получения.
Вот как это можно реализовать.
✅ Обновленная реализация генератора отчета с пагинацией
// /classes/Report/Generators/UserActivityReport.php use Box\Spout\Writer\Common\Creator\WriterEntityFactory; class Report_Generators_UserActivityReport implements ReportGeneratorInterface { const BATCH_SIZE = 500; public function generate(): string { $filePath = APPPATH . 'logs/user_activity_report_' . date('Ymd_His') . '.xlsx'; $writer = WriterEntityFactory::createXLSXWriter(); $writer->openToFile($filePath); // Заголовки $headers = ['ID', 'Имя', 'Последний вход']; $writer->addRow(WriterEntityFactory::createRowFromArray($headers)); $page = 0; do { $dataBatch = $this->fetchDataBatch($page, self::BATCH_SIZE); foreach ($dataBatch as $record) { $row = [ $record['id'], $record['name'], $record['last_login'] ]; $writer->addRow( WriterEntityFactory::createRowFromArray($row) ); } $page++; } while (count($dataBatch) === self::BATCH_SIZE); $writer->close(); return $filePath; } /** * Имитация получения данных из БД или другого источника * * @param int $page * @param int $limit * @return array */ protected function fetchDataBatch(int $page, int $limit): array { // Пример: вы берете данные из БД при помощи ORM или прямого SQL // return DB::select('SELECT * FROM users LIMIT :limit OFFSET :offset', [...]); // Для примера — решение с фиктивными данными if ($page > 2) return []; // Жестко ограничим 3 выгрузки по 500 $data = []; for ($i = 1; $i <= $limit; $i++) { $id = $page * $limit + $i; $data[] = [ 'id' => $id, 'name' => 'Test User ' . $id, 'last_login' => date('Y-m-d H:i:s', strtotime("-{$id} hours")) ]; } return $data; } }
✅ Краткий обзор:
- Метод
generate()инициализирует Spout, задает заголовки, затем в циклеdo...whileпо батчам пишет строки в XLSX. - Метод
fetchDataBatch()эмулирует запрос данных (в реальности тут можно обращаться к ORM, SQL или API). - Пишем в файл построчно, не храним весь объем в памяти.
- Цикл останавливается, как только полученная пачка меньше
BATCH_SIZE, значит данных больше нет.
✅ Полезные советы:
- ✅ Убедитесь, что используете
offset+limitили курсор (id > last_id) — второй способ предпочтительнее при больших объемах. - ✅ Как только
fetchDataBatchвозвращает менееBATCH_SIZE— выходим из цикла. - ✅ Учитывайте лимиты по памяти: библиотека Spout эффективно обрабатывает данные, но не забывайте закрывать writer после завершения.
❓Нужно ли принимать параметры в отчет?
Можно обновить интерфейс
generate(array $params = [])и передавать в Minion таске например дату:$params = [ 'from_date' => '2025-07-01', 'to_date' => '2025-07-14', ]; $report = new Report_Generators_SomeReport(); $report->generate($params);
❓Хотите пример генератора на основе запроса к базе в Kohana или Doctrine?
Могу показать пример с выборкой из MySQL через Kohana ORM или с подготовленным SQL — дайте знать.
- User
данные запрашивается пачками по api, т.к. данные специфичны для каждого отчета, то добавление новых строк в отчет может иметь сложную логику
- Assistant
Отлично! Поблагодарим за уточнение ✅
Вы описали важные детали:
- Данные получаются пачками через API;
- У каждого отчета — уникальные правила агрегации и форматирования строк;
- Добавление записей в XLSX может быть «умным» и не всегда 1 к 1 с полученными данными.
Это означает:
- Бизнес-логика генерирования строк специфична для каждого отчета — значит каждый генератор должен инкапсулировать всю свою логику сам.
- Архитектура должна быть расширяемой, но не усложняться при добавлении новых отчетов.
- Общие задачи (батчинг, инициализация writer, логирование, обработка ошибок) можно вынести в базовый абстрактный генератор.
✅ Рекомендованная архитектура
📁 Структура
/classes /Minion /Task ReportGenerate.php /Report /AbstractGenerator.php <-- Новый базовый класс /ReportFactory.php /Generators SalesReport.php UserActivityReport.php ReportGeneratorInterface.php
✅ Абстрактный генератор
// /classes/Report/AbstractGenerator.php use Box\Spout\Writer\Common\Creator\WriterEntityFactory; use Box\Spout\Writer\WriterInterface; abstract class Report_AbstractGenerator implements ReportGeneratorInterface { /** @var WriterInterface */ protected $writer; /** @var string путь к файлу */ protected $filePath; /** @var int размер батча */ protected $batchSize = 500; public function generate(): string { $this->prepareWriter(); $page = 0; do { $batch = $this->fetchBatch($page, $this->batchSize); $hasData = false; foreach ($batch as $item) { $rows = $this->transformToRows($item); foreach ($rows as $row) { $this->writer->addRow(WriterEntityFactory::createRowFromArray($row)); $hasData = true; } } $page++; } while ($hasData && count($batch) === $this->batchSize); $this->writer->close(); return $this->filePath; } protected function prepareWriter() { $this->filePath = APPPATH . 'logs/report_' . time() . '.xlsx'; $this->writer = WriterEntityFactory::createXLSXWriter(); $this->writer->openToFile($this->filePath); $headers = $this->headers(); $this->writer->addRow(WriterEntityFactory::createRowFromArray($headers)); } /** * Получает батч данных с API */ abstract protected function fetchBatch(int $page, int $limit): array; /** * Возвращает заголовки таблицы */ abstract protected function headers(): array; /** * Преобразование сущности API в строки отчета (может возвращать несколько строк!) */ abstract protected function transformToRows($item): array; }
✅ Пример конкретного генератора
// /classes/Report/Generators/UserActivityReport.php class Report_Generators_UserActivityReport extends Report_AbstractGenerator { protected function headers(): array { return ['User ID', 'Name', 'Login Count', 'Last Activity']; } protected function fetchBatch(int $page, int $limit): array { // Пример API-запроса (в реальном проекте - через cURL, Guzzle и т.п.) $offset = $page * $limit; /** ВАШ API КЛИЕНТ */ $response = APIClient::get('/users/activity', [ 'offset' => $offset, 'limit' => $limit ]); return $response['data'] ?? []; } protected function transformToRows($item): array { // У каждой записи может быть несколько подстрок в отчете (например — сериализованные активности) $rows = []; foreach ($item['activities'] as $activity) { $rows[] = [ $item['id'], $item['name'], $activity['login_count'], $activity['last_active'] ]; } return $rows; } }☝️ Нюанс: батч API может возвращать данные сложной структуры, и метод
transformToRows()может проводить маппинг или вызывать вспомогательные сервисы.
✅ Обновление
ReportFactory(без изменений):// /classes/Report/ReportFactory.php class Report_ReportFactory { public static function create(string $type): ReportGeneratorInterface { switch ($type) { case 'user_activity': return new Report_Generators_UserActivityReport(); case 'sales': return new Report_Generators_SalesReport(); default: throw new InvalidArgumentException("Неизвестный тип отчета: {$type}"); } } }
✅ Использование в таске Minion (без изменений)
// /classes/Minion/Task/ReportGenerate.php class Minion_Task_ReportGenerate extends Minion_Task { protected $_options = ['type' => null]; protected function _execute(array $params) { try { if (empty($params['type'])) { throw new InvalidArgumentException('Не указан --type'); } $report = Report_ReportFactory::create($params['type']); $path = $report->generate(); Minion_CLI::write("Отчет создан: $path"); } catch (Exception $e) { Minion_CLI::write('Ошибка в Minion таске: ' . $e->getMessage()); } } }
🎯 Преимущества такой архитектуры:
- Расширяемость: каждый генератор реализует
fetchBatch,headers,transformToRowsпод себя; - Гибкость: можно легко кастомизировать агрегацию (внутри
transformToRows); - Производительность: батчи + потоковая запись в файл без сохранения всего отчета в памяти;
- Простота поддержки: общий код переиспользуется, только логика специфичных отчетов различается.
⏭ Что можно улучшить дальше?
- 👉 Добавить поддержку параметров (
generate(array $params)), например--from-date,--client-id; - 👉 Логировать прогресс (страница X/∞);
- 👉 Оборачивать API-запросы в retry-обертки и логировать их;
- 👉 Делать предварительную валидацию/проверку структуры API данных.
Если нужно — могу помочь составить:
- 🎯 шаблон API клиента;
- 🎯 мок-генератор для тестов без реального API;
- 🎯 поддержку параметров (даты, IDшники и т.п.) для гибкой фильтрации.
Дайте знать — и мы дополним! 😎