FixtureController

API reference › yii › console › controllers › FixtureController

class	`yii\console\controllers\FixtureController`
Extends	`yii\console\Controller` » `yii\base\Controller` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Uses traits	`yii\test\FixtureTrait`
Since	2.0
Source	`framework/console/controllers/FixtureController.php`

Manages fixture data loading and unloading.

#load fixtures from UsersFixture class with default namespace "tests\unit\fixtures"
yii fixture/load User

#also a short version of this command (generate action is default)
yii fixture User

#load all fixtures
yii fixture "*"

#load all fixtures except User
yii fixture "*, -User"

#load fixtures with different namespace.
yii fixture/load User --namespace=alias\my\custom\namespace\goes\here

The unload sub-command can be used similarly to unload fixtures.

Properties

Property	Type	Description	Defined by
`$action`	`yii\base\Action<static>\|null`	The action that is currently being executed. Default: `null`.	`yii\base\Controller`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$color`	`bool\|null`	Whether to enable ANSI color in the output. Default: `null`.	`yii\console\Controller`
`$defaultAction`	`string`	Controller default action ID. Default: `'load'`.	`FixtureController`
`$fixtures` read-only	`yii\test\Fixture[]`	The loaded fixtures for the current test case	`yii\test\FixtureTrait`
`$globalFixtures`	`array`	Global fixtures that should be applied when loading and unloading. Default: `['yii\test\InitDbFixture']`.	`FixtureController`
`$help`	`bool`	Whether to display help information about current command. Default: `false`. Available since 2.0.10.	`yii\console\Controller`
`$helpSummary` read-only	`string`	The one-line short summary describing this controller.	`yii\console\Controller`
`$id`	`string`	The ID of this controller. Default: `null`.	`yii\base\Controller`
`$interactive`	`bool`	Whether to run the command interactively. Default: `true`.	`yii\console\Controller`
`$layout`	`string\|null\|false`	The name of the layout to be applied to this controller’s views. Default: `null`.	`yii\base\Controller`
`$module`	`yii\base\T`	The module that this controller belongs to. Default: `null`.	`yii\base\Controller`
`$modules` read-only	`yii\base\Module[]`	All ancestor modules that this controller is located within.	`yii\base\Controller`
`$namespace`	`string`	Default namespace to search fixtures in Default: `'tests\unit\fixtures'`.	`FixtureController`
`$passedOptions` read-only	`array`	The names of the options passed during execution.	`yii\console\Controller`
`$passedOptionValues` read-only	`array`	The properties corresponding to the passed options.	`yii\console\Controller`
`$request`	`yii\console\Request`	The request object.	`yii\console\Controller`
`$response`	`yii\console\Response`	The response object.	`yii\console\Controller`
`$route` read-only	`string`	The route (module ID, controller ID and action ID) of the current request.	`yii\base\Controller`
`$silentExitOnException`	`bool\|null`	If true - script finish with `ExitCode::OK` in case of exception. false - `ExitCode::UNSPECIFIED_ERROR`. Default: `null`. Available since 2.0.36.	`yii\console\Controller`
`$uniqueId` read-only	`string`	The controller ID that is prefixed with the module ID (if any).	`yii\base\Controller`
`$view`	`yii\base\View\|yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Controller`
`$viewPath`	`string`	The directory containing the view files for this controller.	`yii\base\Controller`

Methods

Method	Description	Defined by
`__construct()`		`yii\base\Controller`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`actionLoad()`	Loads the specified fixture data.	`FixtureController`
`actions()`	Declares external actions for the controller.	`yii\base\Controller`
`actionUnload()`	Unloads the specified fixtures.	`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\console\Controller`
`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\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`confirm()`	Asks user to confirm by typing y or n.	`yii\console\Controller`
`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`
`findLayoutFile()`	Finds the applicable layout file.	`yii\base\Controller`
`fixtures()`	Declares the fixtures that are needed by the current test case.	`yii\test\FixtureTrait`
`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`
`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`
`getPassedOptions()`	Returns the names of valid options passed during execution.	`yii\console\Controller`
`getPassedOptionValues()`	Returns the properties corresponding to the passed options.	`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\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the object.	`yii\base\Controller`
`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.	`FixtureController`
`notifyNothingToLoad()`	Notifies user that there are no fixtures to load according input conditions.	`FixtureController`
`notifyNothingToUnload()`	Notifies user that there are no fixtures to unload according input conditions.	`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.	`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.	`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`
`bindInjectedParams()` protected final	Fills parameters based on types and names in action method signature.	`yii\base\Controller`
`createFixtures()` protected	Creates the specified fixture instances.	`yii\test\FixtureTrait`
`getActionMethodReflection()` protected		`yii\console\Controller`
`parseDocCommentDetail()` protected	Returns full description from the docblock.	`yii\console\Controller`
`parseDocCommentSummary()` protected	Returns the first line of docblock.	`yii\console\Controller`
`parseDocCommentTags()` protected	Parses the comment block into tags.	`yii\console\Controller`

Events

Event	Type	Description	Defined by
`EVENT_BEFORE_ACTION`	`yii\base\ActionEvent`	An event raised right before executing a controller action. Event name: `'beforeAction'`.	`yii\base\Controller`
`EVENT_AFTER_ACTION`	`yii\base\ActionEvent`	An event raised right after executing a controller action. Event name: `'afterAction'`.	`yii\base\Controller`

Property details

$globalFixtures

public array $globalFixtures = ['yii\test\InitDbFixture']

Global fixtures that should be applied when loading and unloading.

By default it is set to InitDbFixture that disables and enables integrity check, so your data can be safely loaded.

Method details

actionLoad()

public function actionLoad(array $fixturesInput = []): int

Loads the specified fixture data.

For example,

# load the fixture data specified by User and UserProfile.
# any existing fixture data will be removed first
yii fixture/load "User, UserProfile"

# load all available fixtures found under 'tests\unit\fixtures'
yii fixture/load "*"

# load all fixtures except User and UserProfile
yii fixture/load "*, -User, -UserProfile"

Parameters

Parameter	Type	Description
`$fixturesInput`	`array`

Returns

int: Return code

Throws

yii\console\Exception: if the specified fixture does not exist.

actionUnload()

public function actionUnload(array $fixturesInput = []): int

Unloads the specified fixtures.

For example,

# unload the fixture data specified by User and UserProfile.
yii fixture/unload "User, UserProfile"

# unload all fixtures found under 'tests\unit\fixtures'
yii fixture/unload "*"

# unload all fixtures except User and UserProfile
yii fixture/unload "*, -User, -UserProfile"

Parameters

Parameter	Type	Description
`$fixturesInput`	`array`

Returns

int: Return code

Throws

yii\console\Exception: if the specified fixture does not exist.

needToApplyAll()

public function needToApplyAll(string $fixture): bool

Checks if needed to apply all fixtures.

Parameters

Parameter	Type	Description
`$fixture`	`string`

Returns

bool

notifyNothingToLoad()

public function notifyNothingToLoad(array $foundFixtures, array $except): mixed

Notifies user that there are no fixtures to load according input conditions.

Parameters

Parameter	Type	Description
`$foundFixtures`	`array`	Array of found fixtures
`$except`	`array`	Array of names of fixtures that should not be loaded

Returns

mixed

notifyNothingToUnload()

public function notifyNothingToUnload(array $foundFixtures, array $except): mixed

Notifies user that there are no fixtures to unload according input conditions.

Parameters

Parameter	Type	Description
`$foundFixtures`	`array`	Array of found fixtures
`$except`	`array`	Array of names of fixtures that should not be loaded

Returns

mixed

optionAliases()

public function optionAliases(): array

Returns option alias names.

Child classes may override this method to specify alias options.

Returns

array: The options alias names valid for the action where the keys is alias name for option and value is option name.

Since

2.0.8

options()

public function options(mixed $actionID): string[]

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.

Parameters

Parameter	Type	Description
`$actionID`	`mixed`	The action id of the current request

Returns

string[]: The names of the options valid for the action