English | العربية | বাংলা | Bosanski | Deutsch | Español | Français | हिन्दी | Italiano | 日本語 | 한국어 | मराठी | Português | Русский | Kiswahili | தமிழ் | తెలుగు | Türkçe | اردو | Tiếng Việt | 中文

• Введение
  • Основные функции
  • Пример
• Установка
  • Требования
  • Дополнительные зависимости
• Использование
  • Основной рабочий процесс
  • Конфигурация хранения
  • Конфигурация параллелизма
  • Именование файлов
  • Начальная установка для воспроизводимости
• Генераторы
  • Генераторы изображений
  • Генератор текста
  • Генератор CSV
  • Генератор бинарных данных
  • Генератор email
• Расширенное использование
  • Пользовательские генераторы
  • Классы конфигурации
  • Советы по производительности
• Конфигурация
  • Глобальные методы конфигурации
• Руководство по поддержке
  • Поддержка, основанная на сообществе
  • Ошибки и приоритизация функций
• Лицензия - MIT Лицензия

🔗Введение

Faker Storage — это высокопроизводительный пакет PHP, предназначенный для эффективного создания и хранения больших объемов фальшивых файлов данных. Созданный с учетом параллелизма, он использует Swoole или PCNTL для генерации тысяч файлов параллельно, что делает его идеальным для нагрузочного тестирования, разработки и бенчмаркинга систем хранения.

Пакет предоставляет интуитивно понятный API для генерации различных типов файлов, включая изображения (PNG, JPG, GIF, BMP, WEBP, AVIF), текстовые файлы, CSV-файлы, бинарные данные и email-сообщения, соответствующие RFC822. Каждый генератор создает детерминированный выходной результат при заданном начальном значении, обеспечивая воспроизводимость тестовых данных в разных средах.

🔗Основные функции

• Высокопроизводительный параллелизм: Автоматический выбор между Swoole (корутины) и PCNTL (разветвление процессов) для параллельной генерации файлов
• Несколько генераторов файлов: Встроенная поддержка изображений, текстовых, CSV, бинарных и email-файлов
• Детерминированный результат: Генерация на основе начального значения обеспечивает воспроизводимые результаты
• Гибкое хранилище: Работает с любым адаптером League Flysystem (локальное, S3 и т.д.)
• Настраиваемое именование файлов: Генерация имен на основе замыкания с полным управлением
• Поддержка изображений: Несколько форматов с настраиваемыми размерами и сжатием
• Генерация email-сообщений: Соответствующие RFC822 email-сообщения с вложениями и поддержкой MIME

🔗Пример

use DefectiveCode\Faker\Faker;
use League\Flysystem\Filesystem;
use DefectiveCode\Faker\Generators\Png;
use League\Flysystem\Local\LocalFilesystemAdapter;
 
// Генерация 1000 PNG изображений с 10 параллельными рабочими процессами
Faker::make(Png::class)
    ->width(800, 1920)
    ->height(600, 1080)
    ->toDisk(new Filesystem(new LocalFilesystemAdapter('/path/to/storage')))
    ->basePath('images')
    ->count(1000)
    ->concurrency(10)
    ->seed(42)
    ->generate();
 
// Генерация CSV файлов
use DefectiveCode\Faker\Generators\Csv;
 
Faker::make(Csv::class)
    ->columns(5, 10)
    ->rows(100, 500)
    ->delimiter(',')
    ->toDisk(new Filesystem(new LocalFilesystemAdapter('/path/to/storage')))
    ->count(50)
    ->generate();
 
// Генерация email-сообщений с вложениями
use DefectiveCode\Faker\Generators\Email;
 
Faker::make(Email::class)
    ->paragraphs(3, 5)
    ->sentences(2, 4)
    ->withAttachment(Png::class, 1, 3)
    ->toDisk(new Filesystem(new LocalFilesystemAdapter('/path/to/storage')))
    ->count(100)
    ->generate();

🔗Установка

Установите пакет через Composer:

composer require defectivecode/faker-storage

🔗Требования

• PHP >= 8.4
• ext-gd (для генерации изображений)
• ext-swoole (по желанию, для повышения производительности)
• ext-pcntl (резервный вариант для параллелизма)

🔗Дополнительные зависимости

Для оптимальной производительности установите расширение Swoole:

pecl install swoole

Пакет автоматически будет использовать Swoole, если он доступен, в противном случае будет использован PCNTL.

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

🔗Основной рабочий процесс

Все генераторы следуют одному и тому же шаблону:

1. Создайте экземпляр Faker с генератором
2. Настройте генератор (по желанию)
3. Установите место хранения
4. Настройте параллелизм и количество
5. Сгенерируйте файлы

use DefectiveCode\Faker\Faker;
use League\Flysystem\Filesystem;
use DefectiveCode\Faker\Generators\Text;
use League\Flysystem\Local\LocalFilesystemAdapter;
 
Faker::make(Text::class)
    ->paragraphs(5, 10)          // Конфигурация, специфичная для генератора
    ->toDisk(new Filesystem(new LocalFilesystemAdapter('/storage')))
    ->basePath('documents')      // Файлы будут в /storage/documents/
    ->count(100)                 // Сгенерировать 100 файлов
    ->concurrency(4)             // Использовать 4 рабочих процесса
    ->seed(123)                  // Для детерминированного результата
    ->generate();

🔗Конфигурация хранения

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

Faker Storage использует League Flysystem для абстракции хранения:

use League\Flysystem\Filesystem;
use League\Flysystem\Local\LocalFilesystemAdapter;
 
// Локальное хранилище
$filesystem = new Filesystem(new LocalFilesystemAdapter('/path/to/storage'));
 
Faker::make(Png::class)
    ->toDisk($filesystem)
    ->generate();

Хранилище AWS S3

use Aws\S3\S3Client;
use League\Flysystem\Filesystem;
use League\Flysystem\AwsS3V3\AwsS3V3Adapter;
 
$client = new S3Client([
    'credentials' => [
        'key'    => 'your-key',
        'secret' => 'your-secret',
    ],
    'region' => 'us-east-1',
    'version' => 'latest',
]);
 
$adapter = new AwsS3V3Adapter($client, 'your-bucket-name');
$filesystem = new Filesystem($adapter);
 
Faker::make(Png::class)
    ->toDisk($filesystem)
    ->basePath('uploads/images')
    ->generate();

Опции диска

Передайте дополнительные параметры в адаптер файловой системы:

Faker::make(Png::class)
    ->toDisk($filesystem)
    ->diskOptions([
        'visibility' => 'public',
        'ACL' => 'public-read',
        'CacheControl' => 'max-age=31536000',
    ])
    ->generate();

🔗Конфигурация параллелизма

Контролируйте параллельное выполнение с помощью метода concurrency():

// Используйте 10 потоков/процессов
Faker::make(Png::class)
    ->concurrency(10)
    ->generate();
 
// Специфично для Swoole: Установите как потоки, так и корутины на поток
Faker::make(Png::class)
    ->concurrency(threads: 4, coroutines: 8)  // 4 рабочих, 8 корутин каждый
    ->generate();

🔗Именование файлов

Стандартное именование

По умолчанию файлы именуются с использованием UUID v4:

// Генерирует: e7f0a8d3-5c2b-4f9e-8a1d-3b4c5d6e7f8a.png
Faker::make(Png::class)->generate();

Встроенные генераторы имен

use DefectiveCode\Faker\NameGenerator;
 
// На основе UUID (по умолчанию)
NameGenerator::setDefault('uuid'); // Генерирует: e7f0a8d3-5c2b-4f9e-8a1d-3b4c5d6e7f8a.png
 
// Последовательная нумерация
NameGenerator::setDefault('sequence'); // Генерирует: 1.png, 2.png, 3.png, ...

Пользовательское именование

Предоставьте замыкание для настройки имен файлов:

use DefectiveCode\Faker\NameGenerator;
 
// Пользовательское замыкание
Faker::make(Png::class)
    ->nameGenerator(function (int $seed, int $completedFiles, $generator) {
        return "custom-{$completedFiles}-{$seed}.png";
    })
    ->generate();
 
// Именование на основе даты
Faker::make(Png::class)
    ->nameGenerator(function (int $seed, int $completedFiles, $generator) {
        return date('Y/m/d') . "/image-{$completedFiles}.png";
    })
    ->generate();

🔗Начальная установка для воспроизводимости

Установите начальное значение для генерации одинаковых файлов при повторных запусках:

Faker::make(Png::class)
    ->seed(42)
    ->count(10)
    ->generate();

Каждый файл получает уникальное детерминированное начальное значение, выведенное из базового начального значения и индекса файла.

🔗Генераторы

🔗Генераторы изображений

Все генераторы изображений поддерживают настройку размера и качества.

PNG

use DefectiveCode\Faker\Generators\Png;
 
Faker::make(Png::class)
    ->width(800, 1920)          // Случайная ширина от 800 до 1920 пикселей
    ->height(600, 1080)         // Случайная высота от 600 до 1080 пикселей
    ->withAlpha(true)           // Включить альфа-канал/канал прозрачности
    ->grid(5)                   // По желанию: сгенерировать симметричный паттерн 5x5
    ->toDisk($filesystem)
    ->generate();

JPG

use DefectiveCode\Faker\Generators\Jpg;
 
Faker::make(Jpg::class)
    ->width(800, 1920)          // Случайная ширина от 800 до 1920 пикселей
    ->height(600, 1080)         // Случайная высота от 600 до 1080 пикселей
    ->grid(5)                   // По желанию: сгенерировать симметричный паттерн 5x5
    ->toDisk($filesystem)
    ->generate();

GIF

use DefectiveCode\Faker\Generators\Gif;
 
Faker::make(Gif::class)
    ->width(800, 1920)          // Случайная ширина от 800 до 1920 пикселей
    ->height(600, 1080)         // Случайная высота от 600 до 1080 пикселей
    ->withAlpha(true)           // Включить альфа-канал/канал прозрачности
    ->grid(5)                   // По желанию: сгенерировать симметричный паттерн 5x5
    ->toDisk($filesystem)
    ->generate();

BMP

use DefectiveCode\Faker\Generators\Bmp;
 
Faker::make(Bmp::class)
    ->width(800, 1920)          // Случайная ширина от 800 до 1920 пикселей
    ->height(600, 1080)         // Случайная высота от 600 до 1080 пикселей
    ->grid(5)                   // По желанию: сгенерировать симметричный паттерн 5x5
    ->toDisk($filesystem)
    ->generate();

WEBP

use DefectiveCode\Faker\Generators\Webp;
 
Faker::make(Webp::class)
    ->width(800, 1920)          // Случайная ширина от 800 до 1920 пикселей
    ->height(600, 1080)         // Случайная высота от 600 до 1080 пикселей
    ->withAlpha(true)           // Включить альфа-канал/канал прозрачности
    ->grid(5)                   // По желанию: сгенерировать симметричный паттерн 5x5
    ->toDisk($filesystem)
    ->generate();

AVIF

use DefectiveCode\Faker\Generators\Avif;
 
Faker::make(Avif::class)
    ->width(800, 1920)          // Случайная ширина от 800 до 1920 пикселей
    ->height(600, 1080)         // Случайная высота от 600 до 1080 пикселей
    ->withAlpha(true)           // Включить альфа-канал/канал прозрачности
    ->grid(5)                   // По желанию: сгенерировать симметричный паттерн 5x5
    ->toDisk($filesystem)
    ->generate();

Случайное изображение

Генерирует изображение в случайном формате:

use DefectiveCode\Faker\Generators\RandomImage;
 
Faker::make(RandomImage::class)
    ->width(800, 1920)
    ->height(600, 1080)
    ->withAlpha(false)          // Случайное из: AVIF, BMP, GIF, JPEG, PNG, WEBP
    ->toDisk($filesystem)
    ->generate();
 
Faker::make(RandomImage::class)
    ->width(800, 1920)
    ->height(600, 1080)
    ->withAlpha(true)           // Случайное из: AVIF, GIF, PNG, WEBP
    ->toDisk($filesystem)
    ->generate();

🔗Генератор текста

Создайте текстовые файлы с абзацами:

use DefectiveCode\Faker\Generators\Text;
 
Faker::make(Text::class)
    ->paragraphs(5, 10)         // 5-10 абзацев на файл
    ->sentences(3, 6)           // 3-6 предложений на абзац
    ->toDisk($filesystem)
    ->generate();

Пример вывода:

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

🔗Генератор CSV

Создайте CSV файлы со случайными данными:

use DefectiveCode\Faker\Generators\Csv;
 
Faker::make(Csv::class)
    ->columns(5, 10)            // 5-10 столбцов
    ->rows(100, 500)            // 100-500 строк
    ->delimiter(',')            // Разделитель столбцов
    ->enclosure('"')            // Ограничитель полей
    ->escape('\\')              // Символ экранирования
    ->eol("\n")                 // Конец строки
    ->toDisk($filesystem)
    ->generate();

Пример вывода:

"John Doe","john@example.com","555-1234","New York","Engineer"
"Jane Smith","jane@example.com","555-5678","Los Angeles","Designer"
"Bob Johnson","bob@example.com","555-9012","Chicago","Manager"

🔗Генератор бинарных данных

Создайте случайные бинарные данные:

use DefectiveCode\Faker\Generators\Binary;
 
Faker::make(Binary::class)
    ->length(1024, 1048576)     // 1 КБ - 1 МБ
    ->toDisk($filesystem)
    ->generate();

🔗Генератор email

Создайте файлы email, соответствующие RFC822:

use DefectiveCode\Faker\Generators\Email;
 
Faker::make(Email::class)
    ->paragraphs(3, 5)          // Абзацы в теле email
    ->sentences(2, 4)           // Предложения на абзац
    ->withAttachment(Png::class, 1, 3)  // Добавить 1-3 вложения PNG
    ->toDisk($filesystem)
    ->generate();

Заголовки email

Сгенерированные email содержат:

• To: Случайное имя и email
• From: Случайное имя и email
• Subject: Случайное предложение
• Date: Текущая метка времени
• Message-ID: Детерминированный ID на основе начального значения

Email с вложениями

Присоединяйте файлы, используя имена или экземпляры классов генераторов:

use DefectiveCode\Faker\Generators\Email;
use DefectiveCode\Faker\Generators\Png;
use DefectiveCode\Faker\Generators\Pdf;
 
Faker::make(Email::class)
    ->withAttachment(Png::class, 1, 3)  // 1-3 вложения PNG
    ->generate();
 
// Присоедините, используя настроенный экземпляр генератора
$pngGenerator = new Png(Png::getDefaultConfig());
$pngGenerator->width(400, 800)->height(300, 600);
 
Faker::make(Email::class)
    ->withAttachment($pngGenerator, 2, 5)
    ->generate();

Пример вывода:

To: John Doe <john.doe@example.com>
From: Jane Smith <jane.smith@example.com>
Subject: Важная встреча завтра
Date: Fri, 03 Jan 2026 10:30:00 +0000
Message-ID: <3e92e5c2b0d632b3a36fbbb17484b7fe@example.com>
Content-Type: multipart/mixed; boundary="----=_Part_123"
 
------=_Part_123
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
 
Lorem ipsum dolor sit amet, consectetur adipiscing elit...
 
------=_Part_123
Content-Type: image/png; name="attachment.png"
Content-Disposition: attachment; filename="attachment.png"
Content-Transfer-Encoding: base64
 
iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==
------=_Part_123--

🔗Расширенное использование

🔗Пользовательские генераторы

Создайте свои собственные генераторы, реализуя интерфейс Generator:

use DefectiveCode\Faker\Configs\Config;
use DefectiveCode\Faker\Concerns\SetsSeed;
use DefectiveCode\Faker\Generators\Generator;
use DefectiveCode\Faker\Concerns\PreparesFaker;
 
class MyCustomGenerator implements Generator
{
    use PreparesFaker;
    use SetsSeed;
 
    public function __construct(public Config $config) {}
 
    public static function getDefaultConfig(): Config
    {
        return new MyCustomConfig([
            'contentType' => 'application/x-custom',
            'nameGenerator' => NameGenerator::default('extension'),
        ]);
    }
 
    public function generate(): mixed
    {
        // Ваша логика генерации здесь
        $data = $this->faker->randomElement(['foo', 'bar', 'baz']);
 
        $stream = fopen('php://temp', 'w+');
        fwrite($stream, $data);
 
        return $stream;
    }
}
 
// Используйте ваш пользовательский генератор
Faker::make(MyCustomGenerator::class)
    ->toDisk($filesystem)
    ->generate();

🔗Классы конфигурации

Каждый генератор использует класс конфигурации, расширяющий Config:

use DefectiveCode\Faker\Configs\Config;
 
class MyCustomConfig extends Config
{
    public int $minValue = 1;
    public int $maxValue = 100;
}

🔗Советы по производительности

1. Используйте Swoole: Установите расширение Swoole для наилучшей производительности
2. Настройте параллелизм: Соответствуйте количеству потоков количеству ядер процессора для оптимального пропускного能力
3. Пакетные операции: Генерируйте большие партии вместо нескольких мелких запусков
4. Место хранения: Используйте быстрое хранилище (SSD, локальный диск) для временных файлов перед их загрузкой
5. Сетевая ввод/вывод: При использовании S3 увеличьте параллелизм, чтобы максимизировать использование пропускной способности

🔗Конфигурация

🔗Глобальные методы конфигурации

Эти методы доступны для всех экземпляров Faker:

make(string $generator): Faker

Создайте новый экземпляр Faker с указанным генератором:

Faker::make(Png::class)

toDisk(Filesystem $filesystem): Faker

Установите место хранения (обязательно):

Faker::make(Png::class)
    ->toDisk(new Filesystem(new LocalFilesystemAdapter('/storage')))

basePath(string $basePath): Faker

Установите базовый путь в файловой системе:

Faker::make(Png::class)
    ->basePath('images/uploads')  // Файлы хранятся в /storage/images/uploads/

count(int $count): Faker

Установите количество файлов для генерации:

Faker::make(Png::class)
    ->count(1000)

concurrency(int $threads, ?int $coroutines = null): Faker

Настройте параллельное выполнение:

// Базовый параллелизм
Faker::make(Png::class)
    ->concurrency(4)
 
// Специфично для Swoole: потоки и корутины
Faker::make(Png::class)
    ->concurrency(threads: 4, coroutines: 8)

seed(int $seed): Faker

Установите начальное значение для детерминированной генерации:

Faker::make(Png::class)
    ->seed(42)

nameGenerator(Closure $generator): Faker

Настройте именование файлов:

Faker::make(Png::class)
    ->nameGenerator(function (int $seed, int $completedFiles, $generator) {
        return "file-{$completedFiles}.png";
    })

diskOptions(array $diskOptions): Faker

Передайте параметры адаптеру файловой системы:

Faker::make(Png::class)
    ->diskOptions([
        'visibility' => 'public',
        'ACL' => 'public-read',
    ])

generate(): void

Выполните генерацию файлов:

Faker::make(Png::class)->generate();

🔗Руководство по поддержке

Спасибо, что выбрали наш пакет с открытым исходным кодом! Пожалуйста, уделите немного времени, чтобы ознакомиться с этими рекомендациями по поддержке. Они помогут вам максимально эффективно использовать наш проект.

🔗Поддержка, основанная на сообществе

Наш проект с открытым исходным кодом поддерживается нашим замечательным сообществом. Если у вас есть вопросы или требуется помощь, StackOverflow и другие онлайн-ресурсы — ваши лучшие помощники.

🔗Ошибки и приоритизация функций

Реальность управления проектом с открытым исходным кодом заключается в том, что мы не можем сразу же решить каждую сообщенную ошибку или запрос на новую функцию. Мы приоритизируем проблемы в следующем порядке:

1. Ошибки, влияющие на наши платные продукты

Ошибки, которые затрагивают наши платные продукты, всегда будут нашим приоритетом. В некоторых случаях мы можем рассматривать только те ошибки, которые влияют на нас напрямую.

2. Запросы на внесение изменений от сообщества

Если вы выявили ошибку и у вас есть решение, пожалуйста, отправьте запрос на внесение изменений. После вопросов, касающихся наших продуктов, мы придаем следующий высокий приоритет этим исправлениям, инициированным сообществом. После проверки и одобрения мы объединим ваше решение и отметим ваш вклад.

3. Финансовая поддержка

Для вопросов за пределами упомянутых категорий вы можете выбрать финансирование их решения. Каждая открытая проблема связана с формой заказа, через которую вы можете внести финансовый вклад. Мы приоритизируем эти вопросы на основе суммы финансирования.

Вклад сообщества

Проекты с открытым исходным кодом процветают, когда их сообщество активно. Даже если вы не исправляете ошибки, подумайте о том, чтобы внести вклад через улучшение кода, обновление документации, создание учебных пособий или помощь другим в каналах сообщества. Мы настоятельно призываем всех, как сообщество, поддерживать работу с открытым исходным кодом.

Повторим, что DefectiveCode будет приоритизировать ошибки в зависимости от того, как они влияют на наши платные продукты, запросы на внесение изменений от сообщества и финансовую поддержку, полученную за проблемы.

🔗Лицензия - MIT Лицензия

Авторские права © Defective Code, LLC. Все права защищены

Настоящим предоставляется разрешение, безвозмездно, любому лицу, получающему копию этого программного обеспечения и сопутствующих документационных файлов (далее «Программное обеспечение»), пользоваться Программным обеспечением без ограничений, включая, но не ограничиваясь правами использовать, копировать, изменять, сливать, публиковать, распространять, предоставлять сублицензии и/или продавать копии Программного обеспечения, а также разрешать лицам, которым предоставляется Программное обеспечение, делать это, при соблюдении следующих условий:

Указанные выше авторские права и данное разрешение должны быть включены во все копии или значительные части Программного обеспечения.

ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ ГАРАНТИЙ ЛЮБОГО ВИДА, ЯВНЫХ ИЛИ ИМПЛИЦИТНЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ, ГАРАНТИЯМИ ТОРГОВОЙ ПРИГОДНОСТИ, ПРИГОДНОСТИ ДЛЯ ОПРЕДЕЛЁННЫХ ЦЕЛЕЙ И НАРУШЕНИЯ ПРАВ. В НИКАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ДЕРЖАТЕЛИ АВТОРСКИХ ПРАВ НЕ НЕСУТ ОТВЕТСТВЕННОСТЬ ЗА ЛЮБЫЕ ИСКИ, УЩЕРБ ИЛИ ДРУГИЕ ОБЯЗАТЕЛЬСТВА, НИ В КАКОМ УКАЗАНИИ, ДОГОВОРЕ, ДЕЛИКТЕ ИЛИ ИНОМ, ВЫТЕКАЮЩИЕ ИЗ, ИЛИ В СВЯЗИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ИЛИ ДРУГИМИ СДЕЛКАМИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.