README

This repository contains sample language providers for DummyGenerator:

• en_US
• en_GB
• pl_PL

Installation

composer require johnykvsky/dummyproviders --dev

Usage

Easiest way is to go with DummyGeneratorFactory:

$generator = DummyGeneratorFactory::create()->withProvider(new EnUsDefinitionPack());

Beside that there are few other options. Option 1, add language providers to container on generator initialization:

$container = DefinitionContainerBuilder::all(); // initialize the container with core extensions
$en_US_pack = new EnUsDefinitionPack(); // en_US provider definitions pack
foreach ($en_US_pack->all() as $id => $class) { // add all extensions
    $container->add($id, $class);
}

$generator = new DummyGenerator($container); // create generator with providers
echo $generator->state(); // i.e. "Arkansas"
echo $generator->realText(); // it will give you part of ./resources/en_US.txt

Option 2, run method with given provider

$container = DefinitionContainerBuilder::all(); // initialize the container with core extensions
$generator = new DummyGenerator($container); // create generator with no providers, core extensions are loaded

echo $generator->state(); // will throw an error, no such method in Address extension

echo $generator->withProvider(new EnUsDefinitionPack())->state(); // en_US provider is loaded, output will be i.e. "Arkansas"

echo $generator->state(); // will throw an error, no such method in Address extension

Option 3, same as number two, but better if you have more data to be generated for provider:

$container = DefinitionContainerBuilder::all(); // initialize the container with core extensions
$generator = new DummyGenerator($container); // create generator with no providers, core extensions are loaded

$en_US_generator = $generator->withProvider(new EnUsDefinitionPack());
echo $en_US_generator->state(); // i.e. "Arkansas"
echo $en_US_generator->stateAbbr(); // i.e. "CA"
// since $generator stays as it was, there is no such method as state()
$generator->state() // error

Text extension

Providers add one more extension: Text. It has only one method, realText() that allows you to generate text from passed string or given txt file.

By default txt files are in resources folder.

Regexify

There is Regexify class in src folder, for compatibility - it's still being used in some providers