類別 yii\base\InlineAction
繼承 | yii\base\InlineAction » yii\base\Action » yii\base\Component » yii\base\BaseObject |
---|---|
實作 | yii\base\Configurable |
自版本 | 2.0 |
原始碼 | https://github.com/yiisoft/yii2/blob/master/framework/base/InlineAction.php |
InlineAction 代表一個被定義為控制器方法的操作。
控制器方法的名稱可透過 $actionMethod 取得,此屬性由建立此操作的 $controller 設定。
如需更多關於 InlineAction 的詳細資訊和用法,請參閱關於 action 的指南文章。
公共屬性
屬性 | 類型 | 描述 | 定義於 |
---|---|---|---|
$actionMethod | string (字串) | 此行內 action 關聯的控制器方法 | yii\base\InlineAction |
$behaviors | yii\base\Behavior[] | 附加到此元件的 behavior 列表。 | yii\base\Component |
$controller | yii\base\Controller|yii\web\Controller|yii\console\Controller | 擁有此 action 的控制器 | yii\base\Action |
$id | string (字串) | Action 的 ID | yii\base\Action |
$uniqueId | string (字串) | 此 action 在整個應用程式中的唯一 ID。 | yii\base\Action |
公共方法
保護方法
方法 | 描述 | 定義於 |
---|---|---|
afterRun() | 此方法會在 run() 執行後立即呼叫。 |
yii\base\Action |
beforeRun() | 此方法會在 run() 執行前立即呼叫。 |
yii\base\Action |
屬性詳細資訊
方法詳細資訊
定義於: yii\base\Component::__call()
呼叫非類別方法的具名方法。
此方法將檢查是否有任何附加的 behavior 具有具名方法,並在可用時執行它。
請勿直接呼叫此方法,因為它是 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;
}
public void (無返回值) __construct ( $id, $controller, $actionMethod, $config = [] ) | ||
$id | string (字串) |
此 action 的 ID |
$controller | yii\base\Controller |
擁有此 action 的控制器 |
$actionMethod | string (字串) |
此行內 action 關聯的控制器方法 |
$config | array (陣列) |
將用於初始化物件屬性的名稱-值 pairs (鍵值對) |
public function __construct($id, $controller, $actionMethod, $config = [])
{
$this->actionMethod = $actionMethod;
parent::__construct($id, $controller, $config);
}
定義於: yii\base\Component::__get()
傳回元件屬性的值。
此方法將依以下順序檢查並採取相應行動
- getter 定義的屬性:傳回 getter 結果
- behavior 的屬性:傳回 behavior 屬性值
請勿直接呼叫此方法,因為它是 PHP 魔術方法,當執行 $value = $component->property;
時,將會隱含地呼叫它。
另請參閱 __set()。
public mixed (混合) __get ( $name ) | ||
$name | string (字串) |
屬性名稱 |
return (傳回) | mixed (混合) |
屬性值或 behavior 屬性的值 |
---|---|---|
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);
}
定義於: yii\base\Component::__isset()
檢查屬性是否已設定,即已定義且非 null。
此方法將依以下順序檢查並採取相應行動
- setter 定義的屬性:傳回屬性是否已設定
- behavior 的屬性:傳回屬性是否已設定
- 針對不存在的屬性傳回
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;
}
定義於: yii\base\Component::__set()
設定元件屬性的值。
此方法將依以下順序檢查並採取相應行動
- setter 定義的屬性:設定屬性值
- 格式為 "on xyz" 的事件:將處理器附加到事件 "xyz"
- 格式為 "as xyz" 的 behavior:附加名為 "xyz" 的 behavior
- behavior 的屬性:設定 behavior 屬性值
請勿直接呼叫此方法,因為它是 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);
}
定義於: yii\base\Component::__unset()
將元件屬性設定為 null。
此方法將依以下順序檢查並採取相應行動
- setter 定義的屬性:將屬性值設定為 null
- behavior 的屬性:將屬性值設定為 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);
}
protected void (無返回值) afterRun ( ) |
protected function afterRun()
{
}
定義於: yii\base\Component::attachBehavior()
將 behavior 附加到此元件。
此方法將根據給定的組態建立 behavior 物件。之後,將透過呼叫 yii\base\Behavior::attach() 方法將 behavior 物件附加到此元件。
另請參閱 detachBehavior()。
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | string (字串) |
behavior 的名稱。 |
$behavior | string (字串)|array (陣列)|yii\base\Behavior |
behavior 組態。這可以是下列其中之一
|
return (傳回) | yii\base\Behavior |
behavior 物件 |
---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
定義於: yii\base\Component::attachBehaviors()
將 behavior 列表附加到元件。
每個 behavior 都依其名稱編製索引,並且應為 yii\base\Behavior 物件、指定 behavior 類別的字串,或用於建立 behavior 的組態陣列。
另請參閱 attachBehavior()。
public void (無返回值) attachBehaviors ( $behaviors ) | ||
$behaviors | array (陣列) |
要附加到元件的 behavior 列表 |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
定義於: yii\base\Action::beforeRun()
此方法會在 run()
執行前立即呼叫。
您可以覆寫此方法,為 action 執行準備工作。如果此方法傳回 false,它將取消 action。
protected boolean (布林值) beforeRun ( ) | ||
return (傳回) | boolean (布林值) |
是否執行 action。 |
---|
protected function beforeRun()
{
return true;
}
定義於: yii\base\Component::behaviors()
傳回此元件應作為的 behavior 列表。
子類別可以覆寫此方法,以指定它們想要作為的 behavior。
此方法的傳回值應為 behavior 物件或依 behavior 名稱編製索引的組態陣列。 behavior 組態可以是指定 behavior 類別的字串,或具有以下結構的陣列
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
請注意,behavior 類別必須從 yii\base\Behavior 擴展。 Behavior 可以使用名稱或匿名方式附加。當名稱用作陣列索引鍵時,使用此名稱,稍後可以使用 getBehavior() 檢索 behavior,或使用 detachBehavior() 分離 behavior。 匿名 behavior 無法檢索或分離。
在此方法中宣告的 Behavior 將自動(按需)附加到元件。
public array (陣列) behaviors ( ) | ||
return (傳回) | array (陣列) |
Behavior 組態。 |
---|
public function behaviors()
{
return [];
}
定義於: yii\base\Component::canGetProperty()
傳回表示屬性是否可讀取的值。
如果滿足以下條件,則可以讀取屬性
- 類別具有與指定名稱關聯的 getter 方法(在這種情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時); - 附加的 behavior 具有給定名稱的可讀屬性(當
$checkBehaviors
為 true 時)。
另請參閱 canSetProperty()。
public boolean (布林值) canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string (字串) |
屬性名稱 |
$checkVars | boolean (布林值) |
是否將成員變數視為屬性 |
$checkBehaviors | boolean (布林值) |
是否將 behavior 的屬性視為此元件的屬性 |
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 時); - 附加的 behavior 具有給定名稱的可寫屬性(當
$checkBehaviors
為 true 時)。
另請參閱 canGetProperty()。
public boolean (布林值) canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string (字串) |
屬性名稱 |
$checkVars | boolean (布林值) |
是否將成員變數視為屬性 |
$checkBehaviors | boolean (布林值) |
是否將 behavior 的屬性視為此元件的屬性 |
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()
傳回此類別的完整限定名稱。
public static string (字串) className ( ) | ||
return (傳回) | string (字串) |
此類別的完整限定名稱。 |
---|
public static function className()
{
return get_called_class();
}
定義於: yii\base\Component::detachBehavior()
從元件分離 behavior。
將會調用 behavior 的 yii\base\Behavior::detach() 方法。
public yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | string (字串) |
behavior 的名稱。 |
return (傳回) | yii\base\Behavior|null |
已分離的 behavior。如果 behavior 不存在,則為 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。
public void (無返回值) detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定義於: yii\base\Component::ensureBehaviors()
確保在behaviors()中宣告的 behavior 已附加到此元件。
public void (無返回值) ensureBehaviors ( ) |
public function ensureBehaviors()
{
if ($this->_behaviors === null) {
$this->_behaviors = [];
foreach ($this->behaviors() as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
}
定義於: yii\base\Component::getBehavior()
傳回具名的 behavior 物件。
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string (字串) |
behavior 名稱 |
return (傳回) | yii\base\Behavior|null |
behavior 物件,如果 behavior 不存在,則為 null |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
定義於: yii\base\Component::getBehaviors()
傳回附加到此元件的所有 behavior。
public yii\base\Behavior[] getBehaviors ( ) | ||
return (傳回) | yii\base\Behavior[] |
附加到此元件的 behavior 列表 |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
定義於: yii\base\Action::getUniqueId()
傳回此 action 在整個應用程式中的唯一 ID。
public string (字串) getUniqueId ( ) | ||
return (傳回) | string (字串) |
此 action 在整個應用程式中的唯一 ID。 |
---|
public function getUniqueId()
{
return $this->controller->getUniqueId() . '/' . $this->id;
}
定義於: 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()
傳回表示是否已定義方法的值。
如果滿足以下條件,則定義了方法
- 類別具有具有指定名稱的方法
- 附加的 behavior 具有給定名稱的方法(當
$checkBehaviors
為 true 時)。
public boolean (布林值) hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string (字串) |
屬性名稱 |
$checkBehaviors | boolean (布林值) |
是否將 behavior 的方法視為此元件的方法 |
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 時); - 附加的 behavior 具有給定名稱的屬性(當
$checkBehaviors
為 true 時)。
另請參閱
public boolean (布林值) hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string (字串) |
屬性名稱 |
$checkVars | boolean (布林值) |
是否將成員變數視為屬性 |
$checkBehaviors | boolean (布林值) |
是否將 behavior 的屬性視為此元件的屬性 |
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()
{
}
定義於: 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 callback (回呼)。以下是一些範例
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]);
}
}
使用指定的參數執行此 action。
此方法主要由控制器調用。
public mixed runWithParams ( $params ) | ||
$params | array (陣列) |
動作參數 |
return (傳回) | mixed (混合) |
動作的結果 |
---|
public function runWithParams($params)
{
$args = $this->controller->bindActionParams($this, $params);
Yii::debug('Running action: ' . get_class($this->controller) . '::' . $this->actionMethod . '()', __METHOD__);
if (Yii::$app->requestedParams === null) {
Yii::$app->requestedParams = $args;
}
return call_user_func_array([$this->controller, $this->actionMethod], $args);
}
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);
}
註冊 或 登入 以發表評論。