W3cubDocs

/Yii 2.0

Class yii\console\controllers\FixtureController

All Classes | Properties | Methods | Events | Constants

Inheritance	yii\console\controllers\FixtureController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\Object
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Uses Traits	yii\test\FixtureTrait
Subclasses	yii\faker\FixtureController
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/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.

Public Properties

Property	Type	Description	Defined By
$action	yii\base\Action	The action that is currently being executed.	yii\base\Controller
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$color	boolean	Whether to enable ANSI color in the output.	yii\console\Controller
$defaultAction	string	Controller default action ID.	yii\console\controllers\FixtureController
$fixtures	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.	yii\console\controllers\FixtureController
$help	boolean	Whether to display help information about current command.	yii\console\Controller
$helpSummary	string		yii\console\Controller
$id	string	The ID of this controller.	yii\base\Controller
$interactive	boolean	Whether to run the command interactively.	yii\console\Controller
$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
$modules	yii\base\Module[]	All ancestor modules that this controller is located within.	yii\base\Controller
$namespace	string	Default namespace to search fixtures in	yii\console\controllers\FixtureController
$passedOptionValues	array	The properties corresponding to the passed options	yii\console\Controller
$passedOptions	array	The names of the options passed during execution	yii\console\Controller
$route	string	The route (module ID, controller ID and action ID) of the current request.	yii\base\Controller
$uniqueId	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

Public Methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Object
__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\Object
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Object
__set()	Sets value of an object property.	yii\base\Object
__unset()	Sets an object property to null.	yii\base\Object
actionLoad()	Loads the specified fixture data.	yii\console\controllers\FixtureController
actionUnload()	Unloads the specified fixtures.	yii\console\controllers\FixtureController
actions()	Declares external actions for the controller.	yii\base\Controller
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\base\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\Object
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Object
className()	Returns the fully qualified name of this class.	yii\base\Object
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
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\Object
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\Object
init()	Initializes the object.	yii\base\Object
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\console\controllers\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

Method	Description	Defined By
createFixtures()	Creates the specified fixture instances.	yii\test\FixtureTrait
getActionMethodReflection()		yii\console\Controller
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

Event	Type	Description	Defined 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

Constant	Value	Description	Defined By
EXIT_CODE_ERROR	1		yii\console\Controller
EXIT_CODE_NORMAL	0		yii\console\Controller

Property Details

$defaultAction public property

Controller default action ID.

public string $defaultAction = 'load'

$globalFixtures public property

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.

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

$namespace public property

Default namespace to search fixtures in

public string $namespace = 'tests\unit\fixtures'

Method Details

actionLoad() public method

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"

public integer actionLoad ( array $fixturesInput = [] )
$fixturesInput	array
return	integer	Return code
throws	yii\console\Exception	if the specified fixture does not exist.

actionUnload() public method

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"

public integer actionUnload ( array $fixturesInput = [] )
$fixturesInput	array
return	integer	Return code
throws	yii\console\Exception	if the specified fixture does not exist.

needToApplyAll() public method

Checks if needed to apply all fixtures.

public boolean needToApplyAll ( $fixture )
$fixture	string

notifyNothingToLoad() public method

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

public void notifyNothingToLoad ( $foundFixtures, $except )
$foundFixtures	array	Array of found fixtures
$except	array	Array of names of fixtures that should not be loaded

notifyNothingToUnload() public method

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

public void notifyNothingToUnload ( $foundFixtures, $except )
$foundFixtures	array	Array of found fixtures
$except	array	Array of names of fixtures that should not be loaded

optionAliases() public method (available since version 2.0.8)

Returns option alias names.

Child classes may override this method to specify alias options.

public array optionAliases ( )
return	array	The options alias names valid for the action where the keys is alias name for option and value is option name.

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

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-console-controllers-fixturecontroller.html