Class yii\faker\FixtureController

This command creates fixtures based on a given template.

Fixtures are one of the important paths in unit testing. To speed up developers work these fixtures can be generated automatically, based on prepared template. This command is a simple wrapper for the Faker library.

You should configure your application as follows (you can use any alias, not only "fixture"):

'controllerMap' => [
    'fixture' => [
        'class' => 'yii\faker\FixtureController',
    ],
],

To start using the command you need to be familiar (read guide) with the Faker library and generate fixtures template files, according to the given format:

// users.php file under template path (by default @tests/unit/templates/fixtures)
return [
    'name' => $faker->firstName,
    'phone' => $faker->phoneNumber,
    'city' => $faker->city,
    'password' => Yii::$app->getSecurity()->generatePasswordHash('password_' . $index),
    'auth_key' => Yii::$app->getSecurity()->generateRandomString(),
    'intro' => $faker->sentence(7, true),  // generate a sentence with 7 words
];

If you use callback as an attribute value it will be called with the following three parameters:

• $faker: the Faker generator instance
• $index: the current fixture index. For example if user need to generate 3 fixtures for user table, it will be 0..2.

After you set all needed fields in callback, you need to return $fixture array back from the callback.

After you prepared needed templates for tables you can simply generate your fixtures via command

yii fixture/generate user

//generate fixtures from several templates, for example:
yii fixture/generate user profile team

In the code above "users" is template name, after this command run, new file named same as template will be created under the $fixtureDataPath folder. You can generate fixtures for all templates, for example:

yii fixture/generate-all

This command will generate fixtures for all template files that are stored under $templatePath and store fixtures under $fixtureDataPath with file names same as templates names.

You can specify how many fixtures per file you need by the second parameter. In the code below we generate all fixtures and in each file there will be 3 rows (fixtures).

yii fixture/generate-all --count=3

You can specify different options of this command:

//generate fixtures in russian language
yii fixture/generate user --count=5 --language=ru_RU

//read templates from the other path
yii fixture/generate-all --templatePath=@app/path/to/my/custom/templates

//generate fixtures into other folders
yii fixture/generate-all --fixtureDataPath=@tests/unit/fixtures/subfolder1/subfolder2/subfolder3

You can see all available templates by running command:

//list all templates under default template path (i.e. '@tests/unit/templates/fixtures')
yii fixture/templates

//list all templates under specified template path
yii fixture/templates --templatePath='@app/path/to/my/custom/templates'

You also can create your own data providers for custom tables fields, see Faker library guide for more info (https://github.com/fzaninotto/Faker); After you created custom provider, for example:

class Book extends \Faker\Provider\Base
{

    public function title($nbWords = 5)
    {
        $sentence = $this->generator->sentence($nbWords);
        return mb_substr($sentence, 0, mb_strlen($sentence) - 1);
    }

}

you can use it by adding it to the $providers property of the current command. In your console.php config:

   'controllerMap' => [
       'fixture' => [
           'class' => 'yii\faker\FixtureController',
           'providers' => [
               'app\tests\unit\faker\providers\Book',
           ],
       ],
   ],

Public Properties

Public Methods

Protected Methods

Events

Constants

Property Details

$count public property

Total count of data per fixture. Defaults to 2.

public integer $count = 2

$fixtureDataPath public property

Alias to the fixture data path, where data files should be written.

public string $fixtureDataPath = '@tests/unit/fixtures/data'

$generator public read-only property

public \Faker\Generator getGenerator ( )

$language public property

Language to use when generating fixtures data.

public string $language = null

$providers public property

Additional data providers that can be created by user and will be added to the Faker generator. More info in Faker library docs.

public array $providers = []

$templatePath public property

Alias to the template path, where all tables templates are stored.

public string $templatePath = '@tests/unit/templates/fixtures'

Method Details

//generate fixtures in russian language
yii fixture/generate user --count=5 --language=ru_RU

//generate several fixtures
yii fixture/generate user profile team

public function beforeAction($action)
{
    // your custom code here, if you want the code to run before action filters,
    // which are triggered on the [[EVENT_BEFORE_ACTION]] event, e.g. PageCache or AccessControl

    if (!parent::beforeAction($action)) {
        return false;
    }

    // other custom code here

    return true; // or false to not run the action
}