Class yii\console\controllers\FixtureController

所有类 | 属性 | 方法 | 事件 | 常量

继承	yii\console\controllers\FixtureController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
实现	yii\base\Configurable, yii\base\ViewContextInterface
使用 Traits	yii\test\FixtureTrait
可用版本自	2.0
源码	https://github.com/yiichina/yii2/blob/api/framework/console/controllers/FixtureController.php

管理 Fixture 数据的装载和卸载。

#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

unload 子命令可用于卸载 fixtures。

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
$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	是否在输出中启用 ANSI 颜色。如果未设置，则仅为支持 ANSI 颜色的终端启用 ANSI 颜色。	yii\console\Controller
$defaultAction	string	控制器的 ID 的默认动作。	yii\console\controllers\FixtureController
$fixtures	yii\test\Fixture[]	当前测试用例加载的夹具对象。	yii\test\FixtureTrait
$globalFixtures	array	加载和卸载时应用的全局 fixtures。默认情况下它将设置 `InitDbFixture` 禁用并启用完整性检查，以便可以安全地加载数据。	yii\console\controllers\FixtureController
$help	boolean	是否显示有关当前命令的帮助信息。	yii\console\Controller
$helpSummary	string		yii\console\Controller
$id	string	The ID of this controller.	yii\base\Controller
$interactive	boolean	是否以交互方式运行命令。	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	搜索 fixtures 的默认命名空间	yii\console\controllers\FixtureController
$passedOptionValues	array	与传递的选项对应的属性	yii\console\Controller
$passedOptions	array	执行期间传递的选项的名称	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

公共方法

隐藏继承的方法

方法	描述	被定义在
__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
__construct()		yii\base\Controller
__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()	加载指定的 fixture 数据。	yii\console\controllers\FixtureController
actionUnload()	卸载指定的 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()	使用 ANSI 代码格式化字符串。	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()	将参数绑定到动作。当 yii\base\Action 开始使用给定的参数运行时，此方法被调用。此方法首先将参数与操作可用的 options绑定。然后验证给定的参数。	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()	Returns the fully qualified name of this class.	yii\base\BaseObject
confirm()	要求用户通过键入 y 或 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()	声明当前测试用例需要的夹具。	yii\test\FixtureTrait
getActionArgsHelp()	返回动作的匿名参数的帮助信息。	yii\console\Controller
getActionHelp()	返回指定动作的详细帮助信息。	yii\console\Controller
getActionHelpSummary()	返回描述指定动作的一行简短摘要。	yii\console\Controller
getActionOptionsHelp()	返回动作选项的帮助信息。	yii\console\Controller
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getFixture()	方法指定的夹具。	yii\test\FixtureTrait
getFixtures()	返回 globalFixtures() 和 fixtures() 指定的夹具对象。	yii\test\FixtureTrait
getHelp()	返回此控制器的帮助信息。	yii\console\Controller
getHelpSummary()	返回描述此控制器的一行简短摘要。	yii\console\Controller
getModules()	Returns all ancestor modules of this controller.	yii\base\Controller
getOptionValues()	返回与动作 ID 的选项对应的属性子类可以重写此方法以指定可能的属性。	yii\console\Controller
getPassedOptionValues()	返回与传递的选项对应的属性。	yii\console\Controller
getPassedOptions()	返回执行期间传递的有效选项的名称。	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()	声明被所有测试用例都需要的共享夹具。它的返回值类似 fixtures()。你应该在基类中重写这个方法。	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\BaseObject
initFixtures()	初始化夹具	yii\test\FixtureTrait
isColorEnabled()	返回一个指示是否启用 ANSI 颜色的值。	yii\console\Controller
loadFixtures()	加载特定的夹具。	yii\test\FixtureTrait
needToApplyAll()	检查是否需要应用所有 fixtures。	yii\console\controllers\FixtureController
notifyNothingToLoad()	通知用户没有可根据输入条件加载的 fixtures。	yii\console\controllers\FixtureController
notifyNothingToUnload()	通知用户没有要根据输入条件卸载的 fixtures。	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()	返回选项别名。子类可以重写此方法以指定别名选项。	yii\console\controllers\FixtureController
options()	返回操作的有效选项的动作（id）选项要求存在一个名为选项名的公共成员变量。子类可以重写此方法以指定可能的选项。	yii\console\controllers\FixtureController
prompt()	提示用户输入并验证它。	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()	使用指定的动作 ID 和参数运行动作。如果动作 ID 为空，则该方法将使用 $defaultAction。	yii\console\Controller
select()	为用户提供可供选择的选项。给予 '?' 作为输入将显示可供选择的选项列表及其解释。	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()	将字符串打印到 STDERR。	yii\console\Controller
stdout()	将字符串打印到 STDOUT。	yii\console\Controller
trigger()	Triggers an event.	yii\base\Component
unloadFixtures()	卸载指定的夹具。这个方法将会调用每个夹具对象的 yii\test\Fixture::unload() 方法。	yii\test\FixtureTrait

受保护的方法

隐藏继承的方法

方法	描述	被定义在
createFixtures()	创建指定的夹具实例。所有的依赖夹具也会被创建。	yii\test\FixtureTrait
getActionMethodReflection()		yii\console\Controller
parseDocCommentDetail()	返回 docblock 的完整描述。	yii\console\Controller
parseDocCommentSummary()	返回 docblock 的第一行。	yii\console\Controller
parseDocCommentTags()	将注释块解析为标记。	yii\console\Controller

Events

隐藏继承的事件

事件	类型	描述	被定义在
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

常量

隐藏继承的常量

常量	值	描述	被定义在
EXIT_CODE_ERROR	1	Deprecated 自 2.0.13。使用 yii\console\ExitCode::UNSPECIFIED_ERROR 替代。	yii\console\Controller
EXIT_CODE_NORMAL	0	Deprecated 自 2.0.13。使用 yii\console\ExitCode::OK 替代。	yii\console\Controller

属性详情

$defaultAction 公共属性

控制器的 ID 的默认动作。

public string $defaultAction = 'load'

$globalFixtures 公共属性

加载和卸载时应用的全局 fixtures。默认情况下它将设置 InitDbFixture 禁用并启用完整性检查，以便可以安全地加载数据。

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

$namespace 公共属性

搜索 fixtures 的默认命名空间

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

方法详情

actionLoad() 公共方法

加载指定的 fixture 数据。

例如，

# 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	返回代码
throws	yii\console\Exception	如果指定的 fixture 不存在。

actionUnload() 公共方法

卸载指定的 fixtures。

例如，

# 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	返回代码
throws	yii\console\Exception	如果指定的 fixture 不存在。

needToApplyAll() 公共方法

检查是否需要应用所有 fixtures。

public boolean needToApplyAll($fixture)
$fixture	string

notifyNothingToLoad() 公共方法

通知用户没有可根据输入条件加载的 fixtures。

public void notifyNothingToLoad($foundFixtures, $except)
$foundFixtures	array	找到的 fixtures 数组
$except	array	不应加载的 fixtures 的数组。

notifyNothingToUnload() 公共方法

通知用户没有要根据输入条件卸载的 fixtures。

public void notifyNothingToUnload($foundFixtures, $except)
$foundFixtures	array	找到的 fixtures 数组
$except	array	不应加载的 fixtures 的数组。

optionAliases() 公共方法（自版本 2.0.8 可用）

返回选项别名。子类可以重写此方法以指定别名选项。

public array optionAliases()
return	array	选项别名对操作有效，其中键是选项的别名，值是选项名。

options() 公共方法

返回操作的有效选项的动作（id）选项要求存在一个名为选项名的公共成员变量。子类可以重写此方法以指定可能的选项。

请注意，通过选项设置的值不可用直到调用 beforeAction()。

public string[] options($actionID)
$actionID	string	当前请求的动作 id
return	string[]	对操作有效的选项名称