類別 yii\console\controllers\FixtureController
管理 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
子命令的使用方式與卸載 fixture 類似。
公開屬性
公開方法
Protected Methods
方法 | 描述 | 定義於 |
---|---|---|
bindInjectedParams() | 根據動作方法簽名中的類型和名稱填寫參數。 | yii\base\Controller |
createFixtures() | 建立指定的 fixture 實例。 | yii\test\FixtureTrait |
getActionMethodReflection() | yii\console\Controller | |
parseDocCommentDetail() | 從 docblock 傳回完整描述。 | yii\console\Controller |
parseDocCommentSummary() | 傳回 docblock 的第一行。 | yii\console\Controller |
parseDocCommentTags() | 將註解區塊解析為標籤。 | yii\console\Controller |
Events
Event | 類型 | 描述 | 定義於 |
---|---|---|---|
EVENT_AFTER_ACTION | yii\base\ActionEvent | 在執行控制器動作之後立即引發的事件。 | yii\base\Controller |
EVENT_BEFORE_ACTION | yii\base\ActionEvent | 在執行控制器動作之前立即引發的事件。 | yii\base\Controller |
Constants
Constant | Value | 描述 | 定義於 |
---|---|---|---|
EXIT_CODE_ERROR | 1 | 自 2.0.13 版本起已棄用。請改用 yii\console\ExitCode::UNSPECIFIED_ERROR。 | yii\console\Controller |
EXIT_CODE_NORMAL | 0 | 自 2.0.13 版本起已棄用。請改用 yii\console\ExitCode::OK。 | yii\console\Controller |
Property Details
在載入和卸載時應用的全域 fixture。 預設情況下,它設定為 InitDbFixture
,它會停用和啟用完整性檢查,以便可以安全地載入您的資料。
Method Details
Defined in: yii\base\Component::__call()
呼叫非類別方法的具名方法。
此方法將檢查是否有任何附加的行為具有指定的名稱方法,如果有的話,將執行該方法。
不要直接呼叫此方法,因為它是 PHP 魔術方法,當調用未知方法時,將會隱式呼叫它。
public mixed __call ( $name, $params ) | ||
$name | string |
方法名稱 |
$params | array |
方法參數 |
return | mixed |
方法傳回值 |
---|---|---|
throws | yii\base\UnknownMethodException |
當呼叫未知方法時 |
public function __call($name, $params)
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $object) {
if ($object->hasMethod($name)) {
return call_user_func_array([$object, $name], $params);
}
}
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
Defined in: yii\base\Controller::__construct()
public void __construct ( $id, $module, $config = [] ) | ||
$id | string |
此 controller 的 ID。 |
$module | yii\base\Module |
此 controller 所屬的模組。 |
$config | array |
將用於初始化物件屬性的名值對。 |
public function __construct($id, $module, $config = [])
{
$this->id = $id;
$this->module = $module;
parent::__construct($config);
}
Defined in: yii\base\Component::__get()
傳回元件屬性的值。
此方法將依以下順序檢查並採取相應措施
- 由 getter 定義的屬性:傳回 getter 結果
- 行為的屬性:傳回行為屬性值
不要直接呼叫此方法,因為它是 PHP 魔術方法,當執行 $value = $component->property;
時,將會隱式呼叫它。
另請參閱 __set()。
public mixed __get ( $name ) | ||
$name | string |
屬性名稱 |
return | mixed |
屬性值或行為屬性的值 |
---|---|---|
throws | yii\base\UnknownPropertyException |
如果未定義屬性 |
throws | yii\base\InvalidCallException |
如果屬性是唯寫的。 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
// read property, e.g. getName()
return $this->$getter();
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name;
}
}
if (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\Component::__isset()
檢查屬性是否已設定,即已定義且非 null。
此方法將依以下順序檢查並採取相應措施
- 由 setter 定義的屬性:傳回屬性是否已設定
- 行為的屬性:傳回屬性是否已設定
- 對於不存在的屬性,傳回
false
不要直接呼叫此方法,因為它是 PHP 魔術方法,當執行 isset($component->property)
時,將會隱式呼叫它。
public boolean __isset ( $name ) | ||
$name | string |
屬性名稱或事件名稱 |
return | boolean |
指定的屬性是否已設定 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name !== null;
}
}
return false;
}
Defined in: yii\base\Component::__set()
設定元件屬性的值。
此方法將依以下順序檢查並採取相應措施
- 由 setter 定義的屬性:設定屬性值
- 格式為 "on xyz" 的事件:將處理器附加到事件 "xyz"
- 格式為 "as xyz" 的行為:附加名為 "xyz" 的行為
- 行為的屬性:設定行為屬性值
不要直接呼叫此方法,因為它是 PHP 魔術方法,當執行 $component->property = $value;
時,將會隱式呼叫它。
另請參閱 __get()。
public void __set ( $name, $value ) | ||
$name | string |
屬性名稱或事件名稱 |
$value | mixed |
屬性值 |
throws | yii\base\UnknownPropertyException |
如果未定義屬性 |
---|---|---|
throws | yii\base\InvalidCallException |
如果屬性是唯讀的。 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
// set property
$this->$setter($value);
return;
} elseif (strncmp($name, 'on ', 3) === 0) {
// on event: attach event handler
$this->on(trim(substr($name, 3)), $value);
return;
} elseif (strncmp($name, 'as ', 3) === 0) {
// as behavior: attach behavior
$name = trim(substr($name, 3));
$this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = $value;
return;
}
}
if (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\Component::__unset()
將元件屬性設定為 null。
此方法將依以下順序檢查並採取相應措施
- 由 setter 定義的屬性:將屬性值設定為 null
- 行為的屬性:將屬性值設定為 null
不要直接呼叫此方法,因為它是 PHP 魔術方法,當執行 unset($component->property)
時,將會隱式呼叫它。
public void __unset ( $name ) | ||
$name | string |
屬性名稱 |
throws | yii\base\InvalidCallException |
如果屬性是唯讀的。 |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = null;
return;
}
}
throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
載入指定的 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 不存在。 |
public function actionLoad(array $fixturesInput = [])
{
if ($fixturesInput === []) {
$this->printHelpMessage();
return ExitCode::OK;
}
$filtered = $this->filterFixtures($fixturesInput);
$except = $filtered['except'];
if (!$this->needToApplyAll($fixturesInput[0])) {
$fixtures = $filtered['apply'];
$foundFixtures = $this->findFixtures($fixtures);
$notFoundFixtures = array_diff($fixtures, $foundFixtures);
if ($notFoundFixtures !== []) {
$this->notifyNotFound($notFoundFixtures);
}
} else {
$foundFixtures = $this->findFixtures();
}
$fixturesToLoad = array_diff($foundFixtures, $except);
if (!$foundFixtures) {
throw new Exception(
'No files were found for: "' . implode(', ', $fixturesInput) . "\".\n" .
"Check that files exist under fixtures path: \n\"" . $this->getFixturePath() . '".'
);
}
if ($fixturesToLoad === []) {
$this->notifyNothingToLoad($foundFixtures, $except);
return ExitCode::OK;
}
if (!$this->confirmLoad($fixturesToLoad, $except)) {
return ExitCode::OK;
}
$fixtures = $this->getFixturesConfig(array_merge($this->globalFixtures, $fixturesToLoad));
if (!$fixtures) {
throw new Exception('No fixtures were found in namespace: "' . $this->namespace . '"' . '');
}
$fixturesObjects = $this->createFixtures($fixtures);
$this->unloadFixtures($fixturesObjects);
$this->loadFixtures($fixturesObjects);
$this->notifyLoaded($fixturesObjects);
return ExitCode::OK;
}
卸載指定的 fixture。
例如,
# 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 不存在。 |
public function actionUnload(array $fixturesInput = [])
{
if ($fixturesInput === []) {
$this->printHelpMessage();
return ExitCode::OK;
}
$filtered = $this->filterFixtures($fixturesInput);
$except = $filtered['except'];
if (!$this->needToApplyAll($fixturesInput[0])) {
$fixtures = $filtered['apply'];
$foundFixtures = $this->findFixtures($fixtures);
$notFoundFixtures = array_diff($fixtures, $foundFixtures);
if ($notFoundFixtures !== []) {
$this->notifyNotFound($notFoundFixtures);
}
} else {
$foundFixtures = $this->findFixtures();
}
if ($foundFixtures === []) {
throw new Exception(
'No files were found for: "' . implode(', ', $fixturesInput) . "\".\n" .
"Check that files exist under fixtures path: \n\"" . $this->getFixturePath() . '".'
);
}
$fixturesToUnload = array_diff($foundFixtures, $except);
if ($fixturesToUnload === []) {
$this->notifyNothingToUnload($foundFixtures, $except);
return ExitCode::OK;
}
if (!$this->confirmUnload($fixturesToUnload, $except)) {
return ExitCode::OK;
}
$fixtures = $this->getFixturesConfig(array_merge($this->globalFixtures, $fixturesToUnload));
if ($fixtures === []) {
throw new Exception('No fixtures were found in namespace: ' . $this->namespace . '".');
}
$this->unloadFixtures($this->createFixtures($fixtures));
$this->notifyUnloaded($fixtures);
}
Defined in: yii\base\Controller::actions()
宣告 controller 的外部 action。
此方法旨在被覆寫,以宣告控制器的外部動作。它應傳回一個陣列,其中陣列鍵為動作 ID,陣列值為對應的動作類別名稱或動作配置陣列。例如,
return [
'action1' => 'app\components\Action1',
'action2' => [
'class' => 'app\components\Action2',
'property1' => 'value1',
'property2' => 'value2',
],
];
Yii::createObject() 將稍後用於使用此處提供的配置建立請求的動作。
public array actions ( ) |
public function actions()
{
return [];
}
Defined in: yii\base\Controller::afterAction()
此方法在 action 執行後立即調用。
此方法將觸發 EVENT_AFTER_ACTION 事件。此方法的傳回值將用作動作傳回值。
如果您覆寫此方法,您的程式碼應如下所示
public function afterAction($action, $result)
{
$result = parent::afterAction($action, $result);
// your custom code here
return $result;
}
public mixed afterAction ( $action, $result ) | ||
$action | yii\base\Action |
剛執行的動作。 |
$result | mixed |
動作傳回結果。 |
return | mixed |
已處理的動作結果。 |
---|
public function afterAction($action, $result)
{
$event = new ActionEvent($action);
$event->result = $result;
$this->trigger(self::EVENT_AFTER_ACTION, $event);
return $event->result;
}
Defined in: yii\console\Controller::ansiFormat()
使用 ANSI 代碼格式化字串。
您可以使用 yii\helpers\Console 中定義的常數傳遞其他參數。
範例
echo $this->ansiFormat('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public string ansiFormat ( $string ) | ||
$string | string |
要格式化的字串 |
public function ansiFormat($string)
{
if ($this->isColorEnabled()) {
$args = func_get_args();
array_shift($args);
$string = Console::ansiFormat($string, $args);
}
return $string;
}
Defined in: yii\base\Component::attachBehavior()
將 behavior 附加到此元件。
此方法將根據給定的配置建立行為物件。之後,將透過呼叫 yii\base\Behavior::attach() 方法將行為物件附加到此元件。
另請參閱 detachBehavior()。
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | string |
行為的名稱。 |
$behavior | string|array|yii\base\Behavior |
行為配置。這可以是以下之一
|
return | yii\base\Behavior |
行為物件 |
---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
Defined in: yii\base\Component::attachBehaviors()
將 behavior 列表附加到此元件。
每個行為都按其名稱索引,並且應該是一個 yii\base\Behavior 物件、一個指定行為類別的字串,或一個用於建立行為的配置陣列。
另請參閱 attachBehavior()。
public void attachBehaviors ( $behaviors ) | ||
$behaviors | array |
要附加到元件的行為列表 |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
Defined in: yii\console\Controller::beforeAction()
此方法在 action 執行前立即調用。
此方法將觸發 EVENT_BEFORE_ACTION 事件。此方法的傳回值將決定是否應繼續執行動作。
如果動作不應執行,則應在 beforeAction
程式碼內處理請求,方法是提供必要的輸出或重新導向請求。否則,回應將為空。
如果您覆寫此方法,您的程式碼應如下所示
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 |
要執行的動作。 |
return | boolean |
是否應繼續執行動作。 |
---|
public function beforeAction($action)
{
$silentExit = $this->silentExitOnException !== null ? $this->silentExitOnException : YII_ENV_TEST;
Yii::$app->errorHandler->silentExitOnException = $silentExit;
return parent::beforeAction($action);
}
Defined in: yii\base\Component::behaviors()
傳回此元件應表現為哪些 behavior 的列表。
子類別可以覆寫此方法,以指定它們想要表現為的行為。
此方法的傳回值應為行為物件或配置的陣列,並以行為名稱索引。行為配置可以是指定行為類別的字串或以下結構的陣列
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
請注意,行為類別必須從 yii\base\Behavior 擴展。行為可以使用名稱或匿名方式附加。當名稱用作陣列鍵時,使用此名稱,稍後可以使用 getBehavior() 檢索行為,或使用 detachBehavior() 分離行為。匿名行為無法檢索或分離。
在此方法中宣告的行為將自動(按需)附加到元件。
public array behaviors ( ) | ||
return | array |
行為配置。 |
---|
public function behaviors()
{
return [];
}
Defined in: yii\console\Controller::bindActionParams()
將參數繫結到 action。
當 yii\base\Action 開始使用給定參數執行時,將會調用此方法。此方法將首先將參數與動作可用的 options 繫結。然後它會驗證給定的引數。
public array bindActionParams ( $action, $params ) | ||
$action | yii\base\Action |
要與參數繫結的動作 |
$params | array |
要繫結到動作的參數 |
return | array |
動作可以運行的有效參數。 |
---|---|---|
throws | yii\console\Exception |
如果存在未知選項或遺失引數 |
public function bindActionParams($action, $params)
{
if ($action instanceof InlineAction) {
$method = new \ReflectionMethod($this, $action->actionMethod);
} else {
$method = new \ReflectionMethod($action, 'run');
}
$args = [];
$missing = [];
$actionParams = [];
$requestedParams = [];
foreach ($method->getParameters() as $i => $param) {
$name = $param->getName();
$key = null;
if (array_key_exists($i, $params)) {
$key = $i;
} elseif (array_key_exists($name, $params)) {
$key = $name;
}
if ($key !== null) {
if (PHP_VERSION_ID >= 80000) {
$isArray = ($type = $param->getType()) instanceof \ReflectionNamedType && $type->getName() === 'array';
} else {
$isArray = $param->isArray();
}
if ($isArray) {
$params[$key] = $params[$key] === '' ? [] : preg_split('/\s*,\s*/', $params[$key]);
}
$args[] = $actionParams[$key] = $params[$key];
unset($params[$key]);
} elseif (
PHP_VERSION_ID >= 70100
&& ($type = $param->getType()) !== null
&& $type instanceof \ReflectionNamedType
&& !$type->isBuiltin()
) {
try {
$this->bindInjectedParams($type, $name, $args, $requestedParams);
} catch (\yii\base\Exception $e) {
throw new Exception($e->getMessage());
}
} elseif ($param->isDefaultValueAvailable()) {
$args[] = $actionParams[$i] = $param->getDefaultValue();
} else {
$missing[] = $name;
}
}
if (!empty($missing)) {
throw new Exception(Yii::t('yii', 'Missing required arguments: {params}', ['params' => implode(', ', $missing)]));
}
// We use a different array here, specifically one that doesn't contain service instances but descriptions instead.
if (\Yii::$app->requestedParams === null) {
\Yii::$app->requestedParams = array_merge($actionParams, $requestedParams);
}
return array_merge($args, $params);
}
Defined in: yii\base\Controller::bindInjectedParams()
根據動作方法簽名中的類型和名稱填寫參數。
protected void bindInjectedParams ( ReflectionType $type, $name, &$args, &$requestedParams ) | ||
$type | ReflectionType |
動作參數的反射型別。 |
$name | string |
參數的名稱。 |
$args | array |
動作的參數陣列,此函數可能會在其中附加項目。 |
$requestedParams | array |
包含請求參數的陣列,此函數可能會在其中寫入特定的鍵。 |
throws | yii\base\ErrorException |
當我們無法載入必要的服務時。 |
---|---|---|
throws | yii\base\InvalidConfigException |
當 DI 設定中發生錯誤時拋出。 |
throws | yii\di\NotInstantiableException |
當定義無法解析為具體的類別(例如介面類型提示),且容器中沒有適當的定義時拋出。 |
final protected function bindInjectedParams(\ReflectionType $type, $name, &$args, &$requestedParams)
{
// Since it is not a builtin type it must be DI injection.
$typeName = $type->getName();
if (($component = $this->module->get($name, false)) instanceof $typeName) {
$args[] = $component;
$requestedParams[$name] = 'Component: ' . get_class($component) . " \$$name";
} elseif ($this->module->has($typeName) && ($service = $this->module->get($typeName)) instanceof $typeName) {
$args[] = $service;
$requestedParams[$name] = 'Module ' . get_class($this->module) . " DI: $typeName \$$name";
} elseif (\Yii::$container->has($typeName) && ($service = \Yii::$container->get($typeName)) instanceof $typeName) {
$args[] = $service;
$requestedParams[$name] = "Container DI: $typeName \$$name";
} elseif ($type->allowsNull()) {
$args[] = null;
$requestedParams[$name] = "Unavailable service: $name";
} else {
throw new Exception('Could not load required service: ' . $name);
}
}
定義於: yii\base\Component::canGetProperty()
傳回一個值,指示是否可以讀取屬性。
如果屬性可讀取,則為以下情況:
- 類別具有與指定名稱相關聯的 getter 方法(在這種情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時); - 附加的行為具有給定名稱的可讀屬性(當
$checkBehaviors
為 true 時)。
另請參閱 canSetProperty()。
公有 boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
$checkBehaviors | boolean |
是否將行為的屬性視為此元件的屬性 |
return | boolean |
屬性是否可以讀取 |
---|
public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
定義於: yii\base\Component::canSetProperty()
傳回一個值,指示是否可以設定屬性。
如果屬性可寫入,則為以下情況:
- 類別具有與指定名稱相關聯的 setter 方法(在這種情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時); - 附加的行為具有給定名稱的可寫屬性(當
$checkBehaviors
為 true 時)。
另請參閱 canGetProperty()。
公有 boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
$checkBehaviors | boolean |
是否將行為的屬性視為此元件的屬性 |
return | boolean |
屬性是否可以寫入 |
---|
public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
::class
。
定義於: yii\base\BaseObject::className()
傳回此類別的完整限定名稱。
公有靜態 string className ( ) | ||
return | string |
此類別的完整限定名稱。 |
---|
public static function className()
{
return get_called_class();
}
定義於: yii\console\Controller::confirm()
要求使用者輸入 y 或 n 以確認。
典型的用法如下所示
if ($this->confirm("Are you sure?")) {
echo "user typed yes\n";
} else {
echo "user typed no\n";
}
公有 boolean confirm ( $message, $default = false ) | ||
$message | string |
等待使用者輸入前要輸出的訊息 |
$default | boolean |
如果沒有做出選擇,則返回此值。 |
return | boolean |
使用者是否確認。如果 $interactive 為 false,將返回 true。 |
---|
public function confirm($message, $default = false)
{
if ($this->interactive) {
return Console::confirm($message, $default);
}
return true;
}
定義於: yii\base\Controller::createAction()
根據給定的 action ID 建立 action。
此方法首先檢查動作 ID 是否已在 actions() 中宣告。如果是,它將使用那裡宣告的配置來建立動作物件。如果不是,它將尋找控制器方法,其名稱格式為 actionXyz
,其中 xyz
是動作 ID。如果找到,將建立並返回代表該方法的 yii\base\InlineAction。
公有 yii\base\Action|null createAction ( $id ) | ||
$id | string |
動作 ID。 |
return | yii\base\Action|null |
新建立的動作實例。如果 ID 無法解析為任何動作,則為 Null。 |
---|
public function createAction($id)
{
if ($id === '') {
$id = $this->defaultAction;
}
$actionMap = $this->actions();
if (isset($actionMap[$id])) {
return Yii::createObject($actionMap[$id], [$id, $this]);
}
if (preg_match('/^(?:[a-z0-9_]+-)*[a-z0-9_]+$/', $id)) {
$methodName = 'action' . str_replace(' ', '', ucwords(str_replace('-', ' ', $id)));
if (method_exists($this, $methodName)) {
$method = new \ReflectionMethod($this, $methodName);
if ($method->isPublic() && $method->getName() === $methodName) {
return new InlineAction($id, $this, $methodName);
}
}
}
return null;
}
定義於: yii\test\FixtureTrait::createFixtures()
建立指定的 fixture 實例。
所有相依的 fixture 也將被建立。重複的 fixture 和循環相依性只會建立一次。
受保護 yii\test\Fixture[] createFixtures ( array $fixtures ) | ||
$fixtures | array |
要建立的 fixture。您可以提供 fixture 名稱或 fixture 配置。如果未提供此參數,將建立在 globalFixtures() 和 fixtures() 中指定的 fixture。 |
return | yii\test\Fixture[] |
已建立的 fixture 實例 |
---|---|---|
throws | yii\base\InvalidConfigException |
如果 fixture 未正確配置 |
protected function createFixtures(array $fixtures)
{
// normalize fixture configurations
$config = []; // configuration provided in test case
$aliases = []; // class name => alias or class name
foreach ($fixtures as $name => $fixture) {
if (!is_array($fixture)) {
$class = ltrim($fixture, '\\');
$fixtures[$name] = ['class' => $class];
$aliases[$class] = is_int($name) ? $class : $name;
} elseif (isset($fixture['class'])) {
$class = ltrim($fixture['class'], '\\');
$config[$class] = $fixture;
$aliases[$class] = $name;
} else {
throw new InvalidConfigException("You must specify 'class' for the fixture '$name'.");
}
}
// create fixture instances
$instances = [];
$stack = array_reverse($fixtures);
while (($fixture = array_pop($stack)) !== null) {
if ($fixture instanceof Fixture) {
$class = get_class($fixture);
$name = isset($aliases[$class]) ? $aliases[$class] : $class;
unset($instances[$name]); // unset so that the fixture is added to the last in the next line
$instances[$name] = $fixture;
} else {
$class = ltrim($fixture['class'], '\\');
$name = isset($aliases[$class]) ? $aliases[$class] : $class;
if (!isset($instances[$name])) {
$instances[$name] = false;
$stack[] = $fixture = Yii::createObject($fixture);
foreach ($fixture->depends as $dep) {
// need to use the configuration provided in test case
$stack[] = isset($config[$dep]) ? $config[$dep] : ['class' => $dep];
}
}
// if the fixture is already loaded (ie. a circular dependency or if two fixtures depend on the same fixture) just skip it.
}
}
return $instances;
}
公有 yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | string |
行為的名稱。 |
return | yii\base\Behavior|null |
已分離的行為。如果行為不存在,則為 Null。 |
---|
public function detachBehavior($name)
{
$this->ensureBehaviors();
if (isset($this->_behaviors[$name])) {
$behavior = $this->_behaviors[$name];
unset($this->_behaviors[$name]);
$behavior->detach();
return $behavior;
}
return null;
}
定義於: yii\base\Component::detachBehaviors()
從元件中分離所有 behavior。
公有 void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定義於: yii\base\Component::ensureBehaviors()
確保在 behaviors() 中宣告的 behavior 已附加到此元件。
公有 void ensureBehaviors ( ) |
public function ensureBehaviors()
{
if ($this->_behaviors === null) {
$this->_behaviors = [];
foreach ($this->behaviors() as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
}
定義於: yii\base\Controller::findLayoutFile()
尋找適用的版面配置檔案。
公有 string|boolean findLayoutFile ( $view ) | ||
$view | yii\base\View |
要呈現版面配置檔案的 view 物件。 |
return | string|boolean |
版面配置檔案路徑,如果不需要版面配置,則為 false。請參閱 render() 了解如何指定此參數。 |
---|---|---|
throws | yii\base\InvalidArgumentException |
如果使用無效的路徑別名來指定版面配置。 |
public function findLayoutFile($view)
{
$module = $this->module;
$layout = null;
if (is_string($this->layout)) {
$layout = $this->layout;
} elseif ($this->layout === null) {
while ($module !== null && $module->layout === null) {
$module = $module->module;
}
if ($module !== null && is_string($module->layout)) {
$layout = $module->layout;
}
}
if ($layout === null) {
return false;
}
if (strncmp($layout, '@', 1) === 0) {
$file = Yii::getAlias($layout);
} elseif (strncmp($layout, '/', 1) === 0) {
$file = Yii::$app->getLayoutPath() . DIRECTORY_SEPARATOR . substr($layout, 1);
} else {
$file = $module->getLayoutPath() . DIRECTORY_SEPARATOR . $layout;
}
if (pathinfo($file, PATHINFO_EXTENSION) !== '') {
return $file;
}
$path = $file . '.' . $view->defaultExtension;
if ($view->defaultExtension !== 'php' && !is_file($path)) {
$path = $file . '.php';
}
return $path;
}
定義於: yii\test\FixtureTrait::fixtures()
宣告目前測試案例需要的 fixture。
此方法的返回值必須是 fixture 配置的陣列。例如:
[
// anonymous fixture
PostFixture::class,
// "users" fixture
'users' => UserFixture::class,
// "cache" fixture with configuration
'cache' => [
'class' => CacheFixture::class,
'host' => 'xxx',
],
]
請注意,用於測試案例的實際 fixture 將包含 globalFixtures() 和 fixtures()。
公有 array fixtures ( ) | ||
return | array |
當前測試案例所需的 fixture |
---|
public function fixtures()
{
return [];
}
定義於: yii\console\Controller::getActionArgsHelp()
傳回 action 的匿名引數的幫助資訊。
返回的值應為陣列。鍵是參數名稱,值是相應的幫助資訊。每個值都必須是以下結構的陣列
- required: bool,此參數是否為必填
- type: string|null,此參數的 PHP 型別
- default: mixed,此參數的預設值
- comment: string,此參數的描述
預設實作將返回從與動作方法相對應的參數的 Reflection 或 DocBlock 中提取的幫助資訊。
公有 array getActionArgsHelp ( $action ) | ||
$action | yii\base\Action |
動作實例 |
return | array |
動作參數的幫助資訊 |
---|
public function getActionArgsHelp($action)
{
$method = $this->getActionMethodReflection($action);
$tags = $this->parseDocCommentTags($method);
$tags['param'] = isset($tags['param']) ? (array) $tags['param'] : [];
$phpDocParams = [];
foreach ($tags['param'] as $i => $tag) {
if (preg_match('/^(?<type>\S+)(\s+\$(?<name>\w+))?(?<comment>.*)/us', $tag, $matches) === 1) {
$key = empty($matches['name']) ? $i : $matches['name'];
$phpDocParams[$key] = ['type' => $matches['type'], 'comment' => $matches['comment']];
}
}
unset($tags);
$args = [];
/** @var \ReflectionParameter $parameter */
foreach ($method->getParameters() as $i => $parameter) {
$type = null;
$comment = '';
if (PHP_MAJOR_VERSION > 5 && $parameter->hasType()) {
$reflectionType = $parameter->getType();
if (PHP_VERSION_ID >= 70100) {
$types = method_exists($reflectionType, 'getTypes') ? $reflectionType->getTypes() : [$reflectionType];
foreach ($types as $key => $reflectionType) {
$types[$key] = $reflectionType->getName();
}
$type = implode('|', $types);
} else {
$type = (string) $reflectionType;
}
}
// find PhpDoc tag by property name or position
$key = isset($phpDocParams[$parameter->name]) ? $parameter->name : (isset($phpDocParams[$i]) ? $i : null);
if ($key !== null) {
$comment = $phpDocParams[$key]['comment'];
if ($type === null && !empty($phpDocParams[$key]['type'])) {
$type = $phpDocParams[$key]['type'];
}
}
// if type still not detected, then using type of default value
if ($type === null && $parameter->isDefaultValueAvailable() && $parameter->getDefaultValue() !== null) {
$type = gettype($parameter->getDefaultValue());
}
$args[$parameter->name] = [
'required' => !$parameter->isOptional(),
'type' => $type,
'default' => $parameter->isDefaultValueAvailable() ? $parameter->getDefaultValue() : null,
'comment' => $comment,
];
}
return $args;
}
定義於: yii\console\Controller::getActionHelp()
傳回指定 action 的詳細幫助資訊。
公有 string getActionHelp ( $action ) | ||
$action | yii\base\Action |
要獲取幫助的動作 |
return | string |
指定動作的詳細幫助資訊。 |
---|
public function getActionHelp($action)
{
return $this->parseDocCommentDetail($this->getActionMethodReflection($action));
}
定義於: yii\console\Controller::getActionHelpSummary()
傳回描述指定 action 的單行簡短摘要。
公有 string getActionHelpSummary ( $action ) | ||
$action | yii\base\Action |
要獲取摘要的動作 |
return | string |
描述指定動作的單行簡短摘要。 |
---|
public function getActionHelpSummary($action)
{
if ($action === null) {
return $this->ansiFormat(Yii::t('yii', 'Action not found.'), Console::FG_RED);
}
return $this->parseDocCommentSummary($this->getActionMethodReflection($action));
}
受保護 ReflectionFunctionAbstract getActionMethodReflection ( $action ) | ||
$action | yii\base\Action |
protected function getActionMethodReflection($action)
{
if (!isset($this->_reflections[$action->id])) {
if ($action instanceof InlineAction) {
$this->_reflections[$action->id] = new \ReflectionMethod($this, $action->actionMethod);
} else {
$this->_reflections[$action->id] = new \ReflectionMethod($action, 'run');
}
}
return $this->_reflections[$action->id];
}
定義於: yii\console\Controller::getActionOptionsHelp()
傳回 action 的選項的幫助資訊。
返回的值應為陣列。鍵是選項名稱,值是相應的幫助資訊。每個值都必須是以下結構的陣列
- type: string,此參數的 PHP 型別。
- default: string,此參數的預設值
- comment: string,此參數的註解
預設實作將返回從與動作選項相對應的屬性的 doc-comment 中提取的幫助資訊。
公有 array getActionOptionsHelp ( $action ) | ||
$action | yii\base\Action | |
return | array |
動作選項的幫助資訊 |
---|
public function getActionOptionsHelp($action)
{
$optionNames = $this->options($action->id);
if (empty($optionNames)) {
return [];
}
$class = new \ReflectionClass($this);
$options = [];
foreach ($class->getProperties() as $property) {
$name = $property->getName();
if (!in_array($name, $optionNames, true)) {
continue;
}
$defaultValue = $property->getValue($this);
$tags = $this->parseDocCommentTags($property);
// Display camelCase options in kebab-case
$name = Inflector::camel2id($name, '-', true);
if (isset($tags['var']) || isset($tags['property'])) {
$doc = isset($tags['var']) ? $tags['var'] : $tags['property'];
if (is_array($doc)) {
$doc = reset($doc);
}
if (preg_match('/^(\S+)(.*)/s', $doc, $matches)) {
$type = $matches[1];
$comment = $matches[2];
} else {
$type = null;
$comment = $doc;
}
$options[$name] = [
'type' => $type,
'default' => $defaultValue,
'comment' => $comment,
];
} else {
$options[$name] = [
'type' => null,
'default' => $defaultValue,
'comment' => '',
];
}
}
return $options;
}
定義於: yii\base\Component::getBehavior()
傳回具名的 behavior 物件。
公有 yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string |
行為名稱 |
return | yii\base\Behavior|null |
行為物件,如果行為不存在,則為 null |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
定義於: yii\base\Component::getBehaviors()
傳回附加到此元件的所有 behavior。
公有 yii\base\Behavior[] getBehaviors ( ) | ||
return | yii\base\Behavior[] |
附加到此元件的行為列表 |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
定義於: yii\test\FixtureTrait::getFixture()
傳回具名的 fixture。
公有 yii\test\Fixture|null getFixture ( $name ) | ||
$name | string |
fixture 名稱。這可以是 fixture 別名,或者如果未使用別名,則可以是類別名稱。 |
return | yii\test\Fixture|null |
fixture 物件,如果指定的 fixture 不存在,則為 null。 |
---|
public function getFixture($name)
{
if ($this->_fixtures === null) {
$this->_fixtures = $this->createFixtures(array_merge($this->globalFixtures(), $this->fixtures()));
}
$name = ltrim($name, '\\');
return isset($this->_fixtures[$name]) ? $this->_fixtures[$name] : null;
}
定義於: yii\test\FixtureTrait::getFixtures()
傳回在 globalFixtures() 和 fixtures() 中指定的 fixture 物件。
公有 yii\test\Fixture[] getFixtures ( ) | ||
return | yii\test\Fixture[] |
目前測試案例的已載入 fixture |
---|
public function getFixtures()
{
if ($this->_fixtures === null) {
$this->_fixtures = $this->createFixtures(array_merge($this->globalFixtures(), $this->fixtures()));
}
return $this->_fixtures;
}
公有 string getHelp ( ) |
public function getHelp()
{
return $this->parseDocCommentDetail(new \ReflectionClass($this));
}
定義於: yii\console\Controller::getHelpSummary()
傳回描述此控制器的單行簡短摘要。
您可以覆寫此方法以返回自訂的摘要。預設實作返回 PHPDoc 註解的第一行。
公有 string getHelpSummary ( ) |
public function getHelpSummary()
{
return $this->parseDocCommentSummary(new \ReflectionClass($this));
}
公有 yii\base\Module[] getModules ( ) | ||
return | yii\base\Module[] |
此 controller 所在的所有上層模組。 |
---|
public function getModules()
{
$modules = [$this->module];
$module = $this->module;
while ($module->module !== null) {
array_unshift($modules, $module->module);
$module = $module->module;
}
return $modules;
}
定義於: yii\console\Controller::getOptionValues()
傳回對應於動作 ID 選項的屬性。子類別可以覆寫此方法以指定可能的屬性。
公有 array getOptionValues ( $actionID ) | ||
$actionID | string |
當前請求的動作 ID |
return | array |
與動作選項相對應的屬性 |
---|
public function getOptionValues($actionID)
{
// $actionId might be used in subclasses to provide properties specific to action id
$properties = [];
foreach ($this->options($this->action->id) as $property) {
$properties[$property] = $this->$property;
}
return $properties;
}
定義於: yii\console\Controller::getPassedOptionValues()
傳回對應於已傳遞選項的屬性。
公有 array getPassedOptionValues ( ) | ||
return | array |
與傳遞的選項相對應的屬性 |
---|
public function getPassedOptionValues()
{
$properties = [];
foreach ($this->_passedOptions as $property) {
$properties[$property] = $this->$property;
}
return $properties;
}
定義於: yii\console\Controller::getPassedOptions()
傳回執行期間傳遞的有效選項名稱。
公有 array getPassedOptions ( ) | ||
return | array |
執行期間傳遞的選項名稱 |
---|
public function getPassedOptions()
{
return $this->_passedOptions;
}
定義於: yii\base\Controller::getRoute()
傳回當前請求的路由。
公有 string getRoute ( ) | ||
return | string |
目前請求的路由(模組 ID、controller ID 和 action ID)。 |
---|
public function getRoute()
{
return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
}
定義於: yii\base\Controller::getUniqueId()
傳回控制器的唯一 ID。
公有 string getUniqueId ( ) | ||
return | string |
以模組 ID(如果有的話)作為前綴的 controller ID。 |
---|
public function getUniqueId()
{
return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
}
定義於: yii\base\Controller::getView()
傳回可用於渲染視圖或視圖檔案的視圖物件。
render()、renderPartial() 和 renderFile() 方法將使用此 view 物件來實作實際的 view 呈現。如果未設定,則預設為 "view" 應用程式元件。
公有 yii\base\View|yii\web\View getView ( ) | ||
return | yii\base\View|yii\web\View |
可用於渲染視圖或視圖檔案的視圖物件。 |
---|
public function getView()
{
if ($this->_view === null) {
$this->_view = Yii::$app->getView();
}
return $this->_view;
}
定義於: yii\base\Controller::getViewPath()
傳回包含此控制器視圖檔案的目錄。
public string getViewPath ( ) | ||
return | string |
包含此 controller 視圖檔案的目錄。 |
---|
public function getViewPath()
{
if ($this->_viewPath === null) {
$this->_viewPath = $this->module->getViewPath() . DIRECTORY_SEPARATOR . $this->id;
}
return $this->_viewPath;
}
定義於: yii\test\FixtureTrait::globalFixtures()
宣告不同測試案例共用的 fixture。
傳回值應與 fixtures() 的傳回值相似。您通常應該在基底類別中覆寫此方法。
另請參閱 fixtures()。
public array globalFixtures ( ) | ||
return | array |
不同測試案例共用和需要的 Fixture。 |
---|
public function globalFixtures()
{
return [];
}
定義於: yii\base\Component::hasEventHandlers()
傳回一個值,指示是否有名稱事件附加任何處理器。
public boolean hasEventHandlers ( $name ) | ||
$name | string |
事件名稱 |
return | boolean |
是否有任何處理常式附加到事件。 |
---|
public function hasEventHandlers($name)
{
$this->ensureBehaviors();
if (!empty($this->_events[$name])) {
return true;
}
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
return true;
}
}
return Event::hasHandlers($this, $name);
}
定義於: yii\base\Component::hasMethod()
傳回一個值,指示是否已定義方法。
方法定義於以下情況:
- 類別具有指定名稱的方法
- 附加的行為具有給定名稱的方法(當
$checkBehaviors
為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkBehaviors | boolean |
是否將行為的方法視為此元件的方法 |
return | boolean |
方法是否已定義 |
---|
public function hasMethod($name, $checkBehaviors = true)
{
if (method_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->hasMethod($name)) {
return true;
}
}
}
return false;
}
定義於: yii\base\Component::hasProperty()
傳回一個值,指示是否為此元件定義了屬性。
屬性定義於以下情況:
- 類別具有與指定名稱關聯的 getter 或 setter 方法(在這種情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時); - 附加的行為具有給定名稱的屬性(當
$checkBehaviors
為 true 時)。
另請參閱
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
$checkBehaviors | boolean |
是否將行為的屬性視為此元件的屬性 |
return | boolean |
屬性是否已定義 |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
public void init ( ) |
public function init()
{
parent::init();
$this->request = Instance::ensure($this->request, Request::className());
$this->response = Instance::ensure($this->response, Response::className());
}
定義於: yii\test\FixtureTrait::initFixtures()
初始化 fixture。
public void initFixtures ( ) |
public function initFixtures()
{
$this->unloadFixtures();
$this->loadFixtures();
}
定義於: yii\console\Controller::isColorEnabled()
傳回一個值,指示是否啟用 ANSI 彩色。
只有在 $color 設定為 true 或未設定,且終端機支援 ANSI 彩色時,才會啟用 ANSI 彩色。
public boolean isColorEnabled ( $stream = \STDOUT ) | ||
$stream | resource |
要檢查的串流。 |
return | boolean |
是否在輸出中啟用 ANSI 樣式。 |
---|
public function isColorEnabled($stream = \STDOUT)
{
return $this->color === null ? Console::streamSupportsAnsiColors($stream) : $this->color;
}
定義於: yii\test\FixtureTrait::loadFixtures()
載入指定的 fixture。
此方法將為每個 fixture 物件呼叫 yii\test\Fixture::load()。
public void loadFixtures ( $fixtures = null ) | ||
$fixtures | yii\test\Fixture[]|null |
要載入的 fixture。如果未指定此參數,將會使用 getFixtures() 的傳回值。 |
public function loadFixtures($fixtures = null)
{
if ($fixtures === null) {
$fixtures = $this->getFixtures();
}
/* @var $fixture Fixture */
foreach ($fixtures as $fixture) {
$fixture->beforeLoad();
}
foreach ($fixtures as $fixture) {
$fixture->load();
}
foreach (array_reverse($fixtures) as $fixture) {
$fixture->afterLoad();
}
}
檢查是否需要應用所有 fixture。
public boolean needToApplyAll ( $fixture ) | ||
$fixture | string |
public function needToApplyAll($fixture)
{
return $fixture === '*';
}
通知使用者根據輸入條件沒有要載入的 fixture。
public void notifyNothingToLoad ( $foundFixtures, $except ) | ||
$foundFixtures | array |
已找到的 fixture 陣列 |
$except | array |
不應載入的 fixture 名稱陣列 |
public function notifyNothingToLoad($foundFixtures, $except)
{
$this->stdout("Fixtures to load could not be found according given conditions:\n\n", Console::FG_RED);
$this->stdout("Fixtures namespace is: \n", Console::FG_YELLOW);
$this->stdout("\t" . $this->namespace . "\n", Console::FG_GREEN);
if (count($foundFixtures)) {
$this->stdout("\nFixtures founded under the namespace:\n\n", Console::FG_YELLOW);
$this->outputList($foundFixtures);
}
if (count($except)) {
$this->stdout("\nFixtures that will NOT be loaded: \n\n", Console::FG_YELLOW);
$this->outputList($except);
}
}
通知使用者根據輸入條件沒有要卸載的 fixture。
public void notifyNothingToUnload ( $foundFixtures, $except ) | ||
$foundFixtures | array |
已找到的 fixture 陣列 |
$except | array |
不應載入的 fixture 名稱陣列 |
public function notifyNothingToUnload($foundFixtures, $except)
{
$this->stdout("Fixtures to unload could not be found according to given conditions:\n\n", Console::FG_RED);
$this->stdout("Fixtures namespace is: \n", Console::FG_YELLOW);
$this->stdout("\t" . $this->namespace . "\n", Console::FG_GREEN);
if (count($foundFixtures)) {
$this->stdout("\nFixtures found under the namespace:\n\n", Console::FG_YELLOW);
$this->outputList($foundFixtures);
}
if (count($except)) {
$this->stdout("\nFixtures that will NOT be unloaded: \n\n", Console::FG_YELLOW);
$this->outputList($except);
}
}
定義於: yii\base\Component::off()
從此元件分離現有的事件處理器。
此方法與 on() 相反。
注意:如果為事件名稱傳遞萬用字元模式,則只會移除使用此萬用字元註冊的處理常式,而使用符合此萬用字元的純名稱註冊的處理常式將保持不變。
另請參閱 on()。
public boolean off ( $name, $handler = null ) | ||
$name | string |
事件名稱 |
$handler | callable|null |
要移除的事件處理常式。如果為 null,則會移除附加到具名事件的所有處理常式。 |
return | boolean |
如果找到並分離處理常式 |
---|
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
return false;
}
if ($handler === null) {
unset($this->_events[$name], $this->_eventWildcards[$name]);
return true;
}
$removed = false;
// plain event names
if (isset($this->_events[$name])) {
foreach ($this->_events[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_events[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_events[$name] = array_values($this->_events[$name]);
return true;
}
}
// wildcard event names
if (isset($this->_eventWildcards[$name])) {
foreach ($this->_eventWildcards[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_eventWildcards[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
// remove empty wildcards to save future redundant regex checks:
if (empty($this->_eventWildcards[$name])) {
unset($this->_eventWildcards[$name]);
}
}
}
return $removed;
}
將事件處理器附加到事件。
事件處理常式必須是有效的 PHP 回呼。以下是一些範例
function ($event) { ... } // anonymous function
[$object, 'handleClick'] // $object->handleClick()
['Page', 'handleClick'] // Page::handleClick()
'handleClick' // global function handleClick()
事件處理常式必須使用以下簽名定義:
function ($event)
其中 $event
是一個 yii\base\Event 物件,其中包含與事件關聯的參數。
自 2.0.14 版起,您可以將事件名稱指定為萬用字元模式
$component->on('event.group.*', function ($event) {
Yii::trace($event->name . ' is triggered.');
});
另請參閱 off()。
public void on ( $name, $handler, $data = null, $append = true ) | ||
$name | string |
事件名稱 |
$handler | callable |
事件處理常式 |
$data | mixed |
事件觸發時要傳遞給事件處理常式的資料。當呼叫事件處理常式時,可以透過 yii\base\Event::$data 存取此資料。 |
$append | boolean |
是否將新的事件處理常式附加到現有處理常式清單的末尾。如果為 false,則新的處理常式將插入到現有處理常式清單的開頭。 |
public function on($name, $handler, $data = null, $append = true)
{
$this->ensureBehaviors();
if (strpos($name, '*') !== false) {
if ($append || empty($this->_eventWildcards[$name])) {
$this->_eventWildcards[$name][] = [$handler, $data];
} else {
array_unshift($this->_eventWildcards[$name], [$handler, $data]);
}
return;
}
if ($append || empty($this->_events[$name])) {
$this->_events[$name][] = [$handler, $data];
} else {
array_unshift($this->_events[$name], [$handler, $data]);
}
}
傳回選項別名。
子類別可以覆寫此方法以指定別名選項。
public array optionAliases ( ) | ||
return | array |
對動作有效的選項別名,其中鍵是選項的別名,值是選項名稱。 |
---|
public function optionAliases()
{
return array_merge(parent::optionAliases(), [
'g' => 'globalFixtures',
'n' => 'namespace',
]);
}
傳回動作 (id) 的有效選項名稱。選項需要存在一個公有成員變數,其名稱為選項名稱。
子類別可以覆寫此方法以指定可能的選項。
請注意,透過選項設定的值在呼叫 beforeAction() 之前不可用。
public string[] options ( $actionID ) | ||
$actionID | string |
當前請求的動作 ID |
return | string[] |
對動作有效的選項名稱 |
---|
public function options($actionID)
{
return array_merge(parent::options($actionID), [
'namespace', 'globalFixtures',
]);
}
定義於: yii\console\Controller::parseDocCommentDetail()
從 docblock 傳回完整描述。
protected string parseDocCommentDetail ( $reflection ) | ||
$reflection | ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract |
protected function parseDocCommentDetail($reflection)
{
$comment = strtr(trim(preg_replace('/^\s*\**([ \t])?/m', '', trim($reflection->getDocComment(), '/'))), "\r", '');
if (preg_match('/^\s*@\w+/m', $comment, $matches, PREG_OFFSET_CAPTURE)) {
$comment = trim(substr($comment, 0, $matches[0][1]));
}
if ($comment !== '') {
return rtrim(Console::renderColoredString(Console::markdownToAnsi($comment)));
}
return '';
}
定義於: yii\console\Controller::parseDocCommentSummary()
傳回 docblock 的第一行。
protected string parseDocCommentSummary ( $reflection ) | ||
$reflection | ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract |
protected function parseDocCommentSummary($reflection)
{
$docLines = preg_split('~\R~u', $reflection->getDocComment());
if (isset($docLines[1])) {
return trim($docLines[1], "\t *");
}
return '';
}
定義於: yii\console\Controller::parseDocCommentTags()
將註解區塊解析為標籤。
protected array parseDocCommentTags ( $reflection ) | ||
$reflection | ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract |
註解區塊 |
return | array |
已剖析的標籤 |
---|
protected function parseDocCommentTags($reflection)
{
$comment = $reflection->getDocComment();
$comment = "@description \n" . strtr(trim(preg_replace('/^\s*\**([ \t])?/m', '', trim($comment, '/'))), "\r", '');
$parts = preg_split('/^\s*@/m', $comment, -1, PREG_SPLIT_NO_EMPTY);
$tags = [];
foreach ($parts as $part) {
if (preg_match('/^(\w+)(.*)/ms', trim($part), $matches)) {
$name = $matches[1];
if (!isset($tags[$name])) {
$tags[$name] = trim($matches[2]);
} elseif (is_array($tags[$name])) {
$tags[$name][] = trim($matches[2]);
} else {
$tags[$name] = [$tags[$name], trim($matches[2])];
}
}
}
return $tags;
}
定義於: yii\console\Controller::prompt()
提示使用者輸入並驗證它。
public string prompt ( $text, $options = [] ) | ||
$text | string |
提示字串 |
$options | array |
驗證輸入的選項
如何使用具有驗證器函式的 prompt 方法的範例。
|
return | string |
使用者輸入 |
---|
public function prompt($text, $options = [])
{
if ($this->interactive) {
return Console::prompt($text, $options);
}
return isset($options['default']) ? $options['default'] : '';
}
定義於: yii\base\Controller::render()
渲染視圖並在可用時應用佈局。
要呈現的視圖可以用以下格式之一指定
- 路徑別名 (例如 "@app/views/site/index");
- 應用程式內的絕對路徑 (例如 "//site/index"):視圖名稱以雙斜線開頭。實際的視圖檔案將在應用程式的 視圖路徑 下尋找。
- 模組內的絕對路徑 (例如 "/site/index"):視圖名稱以單斜線開頭。實際的視圖檔案將在 $module 的 視圖路徑 下尋找。
- 相對路徑 (例如 "index"):實際的視圖檔案將在 $viewPath 下尋找。
為了確定應套用哪個版面配置,將執行以下兩個步驟
- 在第一步中,它確定版面配置名稱和上下文模組
- 如果 $layout 指定為字串,則將其用作版面配置名稱,並將 $module 用作上下文模組;
- 如果 $layout 為 null,則搜尋此控制器的所有祖先模組,並找到第一個 layout 不為 null 的模組。版面配置和對應的模組將分別用作版面配置名稱和上下文模組。如果找不到這樣的模組,或對應的版面配置不是字串,則它將傳回 false,表示沒有適用的版面配置。
- 在第二步中,它根據先前找到的版面配置名稱和上下文模組確定實際的版面配置檔案。版面配置名稱可以是
- 路徑別名 (例如 "@app/views/layouts/main");
- 絕對路徑 (例如 "/main"):版面配置名稱以斜線開頭。實際的版面配置檔案將在應用程式的 版面配置路徑 下尋找;
- 相對路徑 (例如 "main"):實際的版面配置檔案將在上下文模組的 版面配置路徑 下尋找。
如果版面配置名稱不包含檔案副檔名,它將使用預設的 .php
。
public string render ( $view, $params = [] ) | ||
$view | string |
視圖名稱。 |
$params | array |
應在視圖中提供的參數(名稱-值組)。這些參數在版面配置中將不可用。 |
return | string |
呈現結果。 |
---|---|---|
throws | yii\base\InvalidArgumentException |
如果視圖檔案或版面配置檔案不存在。 |
public function render($view, $params = [])
{
$content = $this->getView()->render($view, $params, $this);
return $this->renderContent($content);
}
定義於: yii\base\Controller::renderContent()
透過應用佈局來渲染靜態字串。
public string renderContent ( $content ) | ||
$content | string |
正在呈現的靜態字串 |
return | string |
具有給定靜態字串作為 |
---|
public function renderContent($content)
{
$layoutFile = $this->findLayoutFile($this->getView());
if ($layoutFile !== false) {
return $this->getView()->renderFile($layoutFile, ['content' => $content], $this);
}
return $content;
}
定義於: yii\base\Controller::renderFile()
渲染視圖檔案。
public string renderFile ( $file, $params = [] ) | ||
$file | string |
要呈現的視圖檔案。這可以是檔案路徑或 路徑別名。 |
$params | array |
應在視圖中提供的參數(名稱-值組)。 |
return | string |
呈現結果。 |
---|---|---|
throws | yii\base\InvalidArgumentException |
如果視圖檔案不存在。 |
public function renderFile($file, $params = [])
{
return $this->getView()->renderFile($file, $params, $this);
}
public string renderPartial ( $view, $params = [] ) | ||
$view | string |
視圖名稱。請參閱 render() 以了解如何指定視圖名稱。 |
$params | array |
應在視圖中提供的參數(名稱-值組)。 |
return | string |
呈現結果。 |
---|---|---|
throws | yii\base\InvalidArgumentException |
如果視圖檔案不存在。 |
public function renderPartial($view, $params = [])
{
return $this->getView()->render($view, $params, $this);
}
定義於: yii\base\Controller::run()
執行以路由形式指定的請求。
路由可以是此控制器中動作的 ID,也可以是由模組 ID、控制器 ID 和動作 ID 組成的完整路由。如果路由以斜線 '/' 開頭,則路由的剖析將從應用程式開始;否則,它將從此控制器的父模組開始。
另請參閱 runAction()。
public mixed run ( $route, $params = [] ) | ||
$route | string |
要處理的路由,例如 'view'、'comment/view'、'/admin/comment/view'。 |
$params | array |
要傳遞給動作的參數。 |
return | mixed |
動作的結果。 |
---|
public function run($route, $params = [])
{
$pos = strpos($route, '/');
if ($pos === false) {
return $this->runAction($route, $params);
} elseif ($pos > 0) {
return $this->module->runAction($route, $params);
}
return Yii::$app->runAction(ltrim($route, '/'), $params);
}
定義於: yii\console\Controller::runAction()
使用指定的動作 ID 和參數執行動作。
如果動作 ID 為空,此方法將使用 $defaultAction。
另請參閱 createAction()。
public integer runAction ( $id, $params = [] ) | ||
$id | string |
要執行的動作的 ID。 |
$params | array |
要傳遞給動作的參數(名稱-值組)。 |
return | integer |
動作執行的狀態。0 表示正常,其他值表示異常。 |
---|---|---|
throws | yii\base\InvalidRouteException |
如果請求的動作 ID 無法成功解析為動作。 |
throws | yii\console\Exception |
如果存在未知選項或遺失引數 |
public function runAction($id, $params = [])
{
if (!empty($params)) {
// populate options here so that they are available in beforeAction().
$options = $this->options($id === '' ? $this->defaultAction : $id);
if (isset($params['_aliases'])) {
$optionAliases = $this->optionAliases();
foreach ($params['_aliases'] as $name => $value) {
if (array_key_exists($name, $optionAliases)) {
$params[$optionAliases[$name]] = $value;
} else {
$message = Yii::t('yii', 'Unknown alias: -{name}', ['name' => $name]);
if (!empty($optionAliases)) {
$aliasesAvailable = [];
foreach ($optionAliases as $alias => $option) {
$aliasesAvailable[] = '-' . $alias . ' (--' . $option . ')';
}
$message .= '. ' . Yii::t('yii', 'Aliases available: {aliases}', [
'aliases' => implode(', ', $aliasesAvailable)
]);
}
throw new Exception($message);
}
}
unset($params['_aliases']);
}
foreach ($params as $name => $value) {
// Allow camelCase options to be entered in kebab-case
if (!in_array($name, $options, true) && strpos($name, '-') !== false) {
$kebabName = $name;
$altName = lcfirst(Inflector::id2camel($kebabName));
if (in_array($altName, $options, true)) {
$name = $altName;
}
}
if (in_array($name, $options, true)) {
$default = $this->$name;
if (is_array($default) && is_string($value)) {
$this->$name = preg_split('/\s*,\s*(?![^()]*\))/', $value);
} elseif ($default !== null) {
settype($value, gettype($default));
$this->$name = $value;
} else {
$this->$name = $value;
}
$this->_passedOptions[] = $name;
unset($params[$name]);
if (isset($kebabName)) {
unset($params[$kebabName]);
}
} elseif (!is_int($name)) {
$message = Yii::t('yii', 'Unknown option: --{name}', ['name' => $name]);
if (!empty($options)) {
$message .= '. ' . Yii::t('yii', 'Options available: {options}', ['options' => '--' . implode(', --', $options)]);
}
throw new Exception($message);
}
}
}
if ($this->help) {
$route = $this->getUniqueId() . '/' . $id;
return Yii::$app->runAction('help', [$route]);
}
return parent::runAction($id, $params);
}
定義於: yii\console\Controller::select()
讓使用者可以從選項中選擇。輸入 '?' 將顯示選項列表及其說明。
public string select ( $prompt, $options = [], $default = null ) | ||
$prompt | string |
提示訊息 |
$options | array |
要從中選擇的鍵值陣列選項 |
$default | string|null |
當使用者未提供選項時要使用的值。如果預設值為 |
return | string |
使用者選擇的選項字元 |
---|
版本 | 描述 |
---|---|
2.0.49 | 新增了 $default 參數 |
public function select($prompt, $options = [], $default = null)
{
if ($this->interactive) {
return Console::select($prompt, $options, $default);
}
return $default;
}
定義於: yii\base\Controller::setView()
設定此控制器要使用的視圖物件。
public void setView ( $view ) | ||
$view | yii\base\View|yii\web\View |
可用於渲染視圖或視圖檔案的視圖物件。 |
public function setView($view)
{
$this->_view = $view;
}
定義於: yii\base\Controller::setViewPath()
設定包含視圖檔案的目錄。
public void setViewPath ( $path ) | ||
$path | string |
視圖檔案的根目錄。 |
throws | yii\base\InvalidArgumentException |
如果目錄無效 |
---|
public function setViewPath($path)
{
$this->_viewPath = Yii::getAlias($path);
}
定義於: yii\console\Controller::stderr()
將字串列印到 STDERR。
您可以選擇性地使用 ANSI 代碼格式化字串,方法是使用 yii\helpers\Console 中定義的常數傳遞額外參數。
範例
$this->stderr('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public integer|boolean stderr ( $string ) | ||
$string | string |
要列印的字串 |
return | integer|boolean |
列印的位元組數,錯誤時為 false |
---|
public function stderr($string)
{
if ($this->isColorEnabled(\STDERR)) {
$args = func_get_args();
array_shift($args);
$string = Console::ansiFormat($string, $args);
}
return fwrite(\STDERR, $string);
}
定義於: yii\console\Controller::stdout()
將字串列印到 STDOUT。
您可以選擇性地使用 ANSI 代碼格式化字串,方法是使用 yii\helpers\Console 中定義的常數傳遞額外參數。
範例
$this->stdout('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public integer|boolean stdout ( $string ) | ||
$string | string |
要列印的字串 |
return | integer|boolean |
列印的位元組數,錯誤時為 false |
---|
public function stdout($string)
{
if ($this->isColorEnabled()) {
$args = func_get_args();
array_shift($args);
$string = Console::ansiFormat($string, $args);
}
return Console::stdout($string);
}
public void trigger ( $name, yii\base\Event $event = null ) | ||
$name | string |
事件名稱 |
$event | yii\base\Event|null |
事件實例。如果未設定,將會建立預設的 yii\base\Event 物件。 |
public function trigger($name, Event $event = null)
{
$this->ensureBehaviors();
$eventHandlers = [];
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (StringHelper::matchWildcard($wildcard, $name)) {
$eventHandlers[] = $handlers;
}
}
if (!empty($this->_events[$name])) {
$eventHandlers[] = $this->_events[$name];
}
if (!empty($eventHandlers)) {
$eventHandlers = call_user_func_array('array_merge', $eventHandlers);
if ($event === null) {
$event = new Event();
}
if ($event->sender === null) {
$event->sender = $this;
}
$event->handled = false;
$event->name = $name;
foreach ($eventHandlers as $handler) {
$event->data = $handler[1];
call_user_func($handler[0], $event);
// stop further handling if the event is handled
if ($event->handled) {
return;
}
}
}
// invoke class-level attached handlers
Event::trigger($this, $name, $event);
}
定義於: yii\test\FixtureTrait::unloadFixtures()
卸載指定的 fixture。
此方法將會為每個 fixture 物件呼叫 yii\test\Fixture::unload()。
public void unloadFixtures ( $fixtures = null ) | ||
$fixtures | yii\test\Fixture[]|null |
要載入的 fixture。如果未指定此參數,將會使用 getFixtures() 的傳回值。 |
public function unloadFixtures($fixtures = null)
{
if ($fixtures === null) {
$fixtures = $this->getFixtures();
}
/* @var $fixture Fixture */
foreach ($fixtures as $fixture) {
$fixture->beforeUnload();
}
$fixtures = array_reverse($fixtures);
foreach ($fixtures as $fixture) {
$fixture->unload();
}
foreach ($fixtures as $fixture) {
$fixture->afterUnload();
}
}
註冊 或 登入 以進行評論。