Class yii\faker\FixtureController

Inheritanceyii\faker\FixtureController » yii\console\controllers\FixtureController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable, yii\base\ViewContextInterface
Uses Traitsyii\test\FixtureTrait
Available since version2.0.0
Source Code https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php

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

Hide inherited properties

PropertyTypeDescriptionDefined By
$action yii\base\Action The action that is currently being executed. yii\base\Controller
$color boolean Whether to enable ANSI color in the output. yii\console\Controller
$count integer Total count of data per fixture. yii\faker\FixtureController
$defaultAction string Controller default action ID. yii\console\controllers\FixtureController
$fixtureDataPath string Alias to the fixture data path, where data files should be written. yii\faker\FixtureController
$globalFixtures array Global fixtures that should be applied when loading and unloading. yii\console\controllers\FixtureController
$help boolean Whether to display help information about current command. yii\console\Controller
$id string The ID of this controller. yii\base\Controller
$interactive boolean Whether to run the command interactively. yii\console\Controller
$language string Language to use when generating fixtures data. yii\faker\FixtureController
$layout null|string|false The name of the layout to be applied to this controller's views. yii\base\Controller
$module yii\base\Module The module that this controller belongs to. yii\base\Controller
$namespace string Default namespace to search fixtures in yii\console\controllers\FixtureController
$providers array Additional data providers that can be created by user and will be added to the Faker generator. yii\faker\FixtureController
$templatePath string Alias to the template path, where all tables templates are stored. yii\faker\FixtureController

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() yii\base\Controller
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
actionGenerate() Generates fixtures and fill them with Faker data. yii\faker\FixtureController
actionGenerateAll() Generates all fixtures template path that can be found. yii\faker\FixtureController
actionLoad() Loads the specified fixture data. yii\console\controllers\FixtureController
actionTemplates() Lists all available fixtures template files. yii\faker\FixtureController
actionUnload() Unloads the specified fixtures. yii\console\controllers\FixtureController
actions() Declares external actions for the controller. yii\base\Controller
addProviders() Adds users providers to the faker generator. yii\faker\FixtureController
afterAction() This method is invoked right after an action is executed. yii\base\Controller
ansiFormat() Formats a string with ANSI codes. yii\console\Controller
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeAction() This method is invoked right before an action is executed. yii\faker\FixtureController
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
bindActionParams() Binds the parameters to the action. yii\console\Controller
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
checkPaths() Check if the template path and migrations path exists and writable. yii\faker\FixtureController
className() Returns the fully qualified name of this class. yii\base\BaseObject
confirm() Asks user to confirm by typing y or n. yii\console\Controller
confirmGeneration() Prompts user with message if he confirm generation with given fixture templates files. yii\faker\FixtureController
createAction() Creates an action based on the given action ID. yii\base\Controller
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
exportFixtures() Returns exported to the string representation of given fixtures array. yii\faker\FixtureController
findLayoutFile() Finds the applicable layout file. yii\base\Controller
fixtures() Declares the fixtures that are needed by the current test case. yii\test\FixtureTrait
generateFixture() Generates fixture from given template yii\faker\FixtureController
generateFixtureFile() Generates fixture file by the given fixture template file. yii\faker\FixtureController
getActionArgsHelp() Returns the help information for the anonymous arguments for the action. yii\console\Controller
getActionHelp() Returns the detailed help information for the specified action. yii\console\Controller
getActionHelpSummary() Returns a one-line short summary describing the specified action. yii\console\Controller
getActionOptionsHelp() Returns the help information for the options for the action. yii\console\Controller
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getFixture() Returns the named fixture. yii\test\FixtureTrait
getFixtures() Returns the fixture objects as specified in globalFixtures() and fixtures(). yii\test\FixtureTrait
getGenerator() Returns Faker generator instance. Getter for private property. yii\faker\FixtureController
getHelp() Returns help information for this controller. yii\console\Controller
getHelpSummary() Returns one-line short summary describing this controller. yii\console\Controller
getModules() Returns all ancestor modules of this controller. yii\base\Controller
getOptionValues() Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. yii\console\Controller
getPassedOptionValues() Returns the properties corresponding to the passed options. yii\console\Controller
getPassedOptions() Returns the names of valid options passed during execution. yii\console\Controller
getRoute() Returns the route of the current request. yii\base\Controller
getUniqueId() Returns the unique ID of the controller. yii\base\Controller
getView() Returns the view object that can be used to render views or view files. yii\base\Controller
getViewPath() Returns the directory containing view files for this controller. yii\base\Controller
globalFixtures() Declares the fixtures shared required by different test cases. yii\test\FixtureTrait
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
initFixtures() Initialize the fixtures. yii\test\FixtureTrait
isColorEnabled() Returns a value indicating whether ANSI color is enabled. yii\console\Controller
loadFixtures() Loads the specified fixtures. yii\test\FixtureTrait
needToApplyAll() Checks if needed to apply all fixtures. yii\console\controllers\FixtureController
notifyNothingToLoad() Notifies user that there are no fixtures to load according input conditions. yii\console\controllers\FixtureController
notifyNothingToUnload() Notifies user that there are no fixtures to unload according input conditions. yii\console\controllers\FixtureController
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
optionAliases() Returns option alias names. yii\console\controllers\FixtureController
options() Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name. yii\faker\FixtureController
prompt() Prompts the user for input and validates it. yii\console\Controller
render() Renders a view and applies layout if available. yii\base\Controller
renderContent() Renders a static string by applying a layout. yii\base\Controller
renderFile() Renders a view file. yii\base\Controller
renderPartial() Renders a view without applying layout. yii\base\Controller
run() Runs a request specified in terms of a route. yii\base\Controller
runAction() Runs an action with the specified action ID and parameters. yii\console\Controller
select() Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations. yii\console\Controller
setView() Sets the view object to be used by this controller. yii\base\Controller
setViewPath() Sets the directory that contains the view files. yii\base\Controller
stderr() Prints a string to STDERR. yii\console\Controller
stdout() Prints a string to STDOUT. yii\console\Controller
trigger() Triggers an event. yii\base\Component
unloadFixtures() Unloads the specified fixtures. yii\test\FixtureTrait

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
createFixtures() Creates the specified fixture instances. yii\test\FixtureTrait
findTemplatesFiles() Returns array containing fixtures templates file names. You can specify what files to find by the given parameter. yii\faker\FixtureController
getActionMethodReflection() yii\console\Controller
notifyNoTemplatesFound() Notifies user that there was not found any files matching given input conditions. yii\faker\FixtureController
notifyNotFoundTemplates() Notifies user that given fixtures template files were not found. yii\faker\FixtureController
notifyTemplatesCanBeGenerated() Notifies user about templates which could be generated. yii\faker\FixtureController
notifyTemplatesGenerated() Notifies user that given fixtures template files were generated. yii\faker\FixtureController
parseDocCommentDetail() Returns full description from the docblock. yii\console\Controller
parseDocCommentSummary() Returns the first line of docblock. yii\console\Controller
parseDocCommentTags() Parses the comment block into tags. yii\console\Controller

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_ACTION yii\base\ActionEvent An event raised right after executing a controller action. yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent An event raised right before executing a controller action. yii\base\Controller

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
EXIT_CODE_ERROR 1 Deprecated since 2.0.13. Use \yii\faker\ExitCode::UNSPECIFIED_ERROR instead. yii\console\Controller
EXIT_CODE_NORMAL 0 Deprecated since 2.0.13. Use \yii\faker\ExitCode::OK instead. yii\console\Controller

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

actionGenerate() public method

Generates fixtures and fill them with Faker data.

For example,

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

//generate several fixtures
yii fixture/generate user profile team
public void actionGenerate ( )
throws yii\base\InvalidParamException
throws yii\console\Exception
actionGenerateAll() public method

Generates all fixtures template path that can be found.

public void actionGenerateAll ( )
actionTemplates() public method

Lists all available fixtures template files.

public void actionTemplates ( )
addProviders() public method

Adds users providers to the faker generator.

public void addProviders ( )
beforeAction() public method

This method is invoked right before an action is executed.

The method will trigger the EVENT_BEFORE_ACTION event. The return value of the method will determine whether the action should continue to run.

In case the action should not run, the request should be handled inside of the beforeAction code by either providing the necessary output or redirecting the request. Otherwise the response will be empty.

If you override this method, your code should look like the following:

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
}
public boolean beforeAction ( $action )
$action yii\base\Action

The action to be executed.

return boolean

Whether the action should continue to run.

checkPaths() public method

Check if the template path and migrations path exists and writable.

public void checkPaths ( )
confirmGeneration() public method

Prompts user with message if he confirm generation with given fixture templates files.

public boolean confirmGeneration ( $files )
$files array
exportFixtures() public method

Returns exported to the string representation of given fixtures array.

public string exportFixtures ( $fixtures )
$fixtures array
return string

Exported fixtures format

findTemplatesFiles() protected method (available since version 2.0.4)

Returns array containing fixtures templates file names. You can specify what files to find by the given parameter.

protected array findTemplatesFiles ( array $templatesNames = [] )
$templatesNames array

Template file names to search. If empty then all files will be searched.

generateFixture() public method

Generates fixture from given template

public array generateFixture ( $_template_, $index )
$_template_ string

The fixture template file

$index integer

The current fixture index

return array

Fixture

generateFixtureFile() public method

Generates fixture file by the given fixture template file.

public void generateFixtureFile ( $templateName, $templatePath, $fixtureDataPath )
$templateName string

Template file name

$templatePath string

Path where templates are stored

$fixtureDataPath string

Fixture data path where generated file should be written

getGenerator() public method

Returns Faker generator instance. Getter for private property.

public \Faker\Generator getGenerator ( )
notifyNoTemplatesFound() protected method (available since version 2.0.4)

Notifies user that there was not found any files matching given input conditions.

protected void notifyNoTemplatesFound ( )
notifyNotFoundTemplates() protected method (available since version 2.0.4)

Notifies user that given fixtures template files were not found.

protected void notifyNotFoundTemplates ( $templatesNames )
$templatesNames array
notifyTemplatesCanBeGenerated() protected method (available since version 2.0.4)

Notifies user about templates which could be generated.

protected void notifyTemplatesCanBeGenerated ( $templatesNames )
$templatesNames array
notifyTemplatesGenerated() protected method (available since version 2.0.4)

Notifies user that given fixtures template files were generated.

protected void notifyTemplatesGenerated ( $templatesNames )
$templatesNames array
options() public method

Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.

Child classes may override this method to specify possible options.

Note that the values setting via options are not available until beforeAction() is being called.

public string[] options ( $actionID )
$actionID string

The action id of the current request

return string[]

The names of the options valid for the action