Класс yii\faker\FixtureController

Эта команда создаёт фикстуры на основе заданного шаблона.

Фикстуры являются важными элементами в тестировании юнит-тестов. Для ускорения работы разработчиков эти фикстуры могут быть сгенерированы автоматически на основе подготовленного шаблона. Эта команда является простым оболочкой для библиотеки Faker.

Вы должны настроить свою приложение следующим образом (вы можете использовать любой псевдоним, а не только "fixture"):

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

Для начала использования команды вам нужно ознакомиться (прочитать руководство) с библиотекой Faker и сгенерировать файлы шаблонов фикстур в соответствии с заданным форматом:

// 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
];

Если вы используете обратный вызов в качестве значения атрибута, он будет вызван со следующими тремя параметрами:

• $faker: экземпляр генератора Faker
• $index: текущий индекс фикстуры. Например, если нужно сгенерировать 3 фикстуры для таблицы пользователей, он будет от 0 до 2.

После установки всех необходимых полей в обратном вызове, вы должны вернуть массив $fixture обратно из обратного вызова.

После подготовки необходимых шаблонов для таблиц вы можете просто сгенерировать фикстуры с помощью команды

yii fixture/generate user

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

В приведенном выше коде "users" - это имя шаблона, после выполнения этой команды будет создан новый файл с таким же именем, что и шаблон, в папке $fixtureDataPath. Вы можете сгенерировать фикстуры для всех шаблонов, например:

yii fixture/generate-all

Эта команда сгенерирует фикстуры для всех файлов шаблонов, которые хранятся в $templatePath и сохранит фикстуры в $fixtureDataPath с именами файлов, совпадающими с именами шаблонов.

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

yii fixture/generate-all --count=3

Вы можете указать различные параметры этой команды:

//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

Вы можете увидеть все доступные шаблоны, выполнив команду:

//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'

Вы также можете создать собственные поставщики данных для полей пользовательских таблиц, см. руководство библиотеки Faker для получения дополнительной информации (https://github.com/fzaninotto/Faker); После создания пользовательского поставщика, например:

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);
    }

}

вы можете использовать его, добавив его в свойство $providers текущей команды. В вашем конфигурационном файле console.php:

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

Публичные свойства

Общие методы

Защищенные методы

События

Постоянные значения

Подробное описание свойств

$count общедоступное свойство

Общее количество данных на фикстуру. По умолчанию равно 2.

public integer $count = 2

$fixtureDataPath общедоступное свойство

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

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

$generator общедоступное только для чтения свойство

public \Faker\Generator getGenerator ( )

$language общедоступное свойство

Язык, используемый при генерации данных фикстуры.

public string $language = null

$providers общедоступное свойство

Дополнительные поставщики данных, которые могут быть созданы пользователем и будут добавлены к генератору Faker. Дополнительная информация в документации библиотеки Faker.

public array $providers = []

$templatePath общедоступное свойство

Псевдоним пути к шаблонам, где хранятся все шаблоны таблиц.

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

Подробное описание методов

//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
}