クラス yii\base\Controller
Controllerは、コントローラーロジックを含むクラスの基底クラスです。
Controllerの詳細と使用方法については、コントローラーに関するガイド記事を参照してください。
公開プロパティ
プロパティ | 型 | 説明 | 定義元 |
---|---|---|---|
$action | yii\base\Action|null | 現在実行中のアクション。 | yii\base\Controller |
$behaviors | yii\base\Behavior[] | このコンポーネントにアタッチされているビヘイビアのリスト。 | yii\base\Component |
$defaultAction | string | リクエストでアクションIDが指定されていない場合に使用されるアクションのID。 | yii\base\Controller |
$id | string | このコントローラーのID。 | yii\base\Controller |
$layout | string|null|false | このコントローラーのビューに適用されるレイアウトの名前。 | yii\base\Controller |
$module | yii\base\Module | このコントローラーが属するモジュール。 | yii\base\Controller |
$modules | yii\base\Module[] | このコントローラーが存在するすべての祖先モジュール。 | yii\base\Controller |
$request | yii\base\Request|array|string | リクエスト。 | yii\base\Controller |
$response | yii\base\Response|array|string | レスポンス。 | yii\base\Controller |
$route | string | 現在のリクエストのルート(モジュールID、コントローラーID、アクションID)。 | yii\base\Controller |
$uniqueId | string | モジュールID(存在する場合)をプレフィックスとして付けたコントローラーID。 | yii\base\Controller |
$view | yii\base\View|yii\web\View | ビューまたはビューファイルをレンダリングするために使用できるビューオブジェクト。 | yii\base\Controller |
$viewPath | string | このコントローラーのビューファイルを含むディレクトリ。 | yii\base\Controller |
公開メソッド
保護されたメソッド
メソッド | 説明 | 定義元 |
---|---|---|
bindInjectedParams() | アクションメソッドのシグネチャ内の型と名前に基づいてパラメーターを設定します。 | yii\base\Controller |
イベント
イベント | 型 | 説明 | 定義元 |
---|---|---|---|
EVENT_AFTER_ACTION | yii\base\ActionEvent | コントローラーアクションの実行直後に発生するイベントです。 | yii\base\Controller |
EVENT_BEFORE_ACTION | yii\base\ActionEvent | コントローラーアクションの実行直前に発生するイベントです。 | yii\base\Controller |
プロパティの詳細
現在実行されているアクションです。このプロパティは、run() が yii\base\Application によってアクションを実行するために呼び出されたときに設定されます。
リクエストでアクションIDが指定されていない場合に使用されるアクションのIDです。デフォルトは 'index' です。
リクエスト。
レスポンス。
ビューまたはビューファイルをレンダリングするために使用できるビューオブジェクト。
メソッドの詳細
定義先: yii\base\Component::__call()
クラスメソッドではない名前付きメソッドを呼び出します。
このメソッドは、アタッチされたビヘイビアに指定されたメソッドが存在するかどうかをチェックし、存在する場合は実行します。
これはPHPのマジックメソッドであり、未知のメソッドが呼び出された際に暗黙的に呼び出されるため、直接呼び出さないでください。
public mixed __call ( $name, $params ) | ||
$name | string |
メソッド名 |
$params | array |
メソッドパラメータ |
戻り値 | mixed |
メソッドの戻り値 |
---|---|---|
例外 | 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()");
}
定義先: yii\base\Component::__clone()
既存のオブジェクトをクローンしてオブジェクトが作成された後、このメソッドが呼び出されます。
ビヘイビアは古いオブジェクトにアタッチされているため、すべてのビヘイビアを削除します。
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
public void __construct ( $id, $module, $config = [] ) | ||
$id | string |
このコントローラーのID。 |
$module | yii\base\Module |
このコントローラーが属するモジュール。 |
$config | array |
オブジェクトのプロパティを初期化するために使用される名前と値のペア。 |
public function __construct($id, $module, $config = [])
{
$this->id = $id;
$this->module = $module;
parent::__construct($config);
}
定義先: yii\base\Component::__get()
コンポーネントプロパティの値を返します。
このメソッドは、以下の順番でチェックし、それに応じて動作します。
- ゲッターで定義されたプロパティ: ゲッターの結果を返す
- ビヘイビアのプロパティ: ビヘイビアのプロパティ値を返す
これはPHPのマジックメソッドであり、`$value = $component->property;`を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。
こちらも参照してください __set().
public mixed __get ( $name ) | ||
$name | string |
プロパティ名 |
戻り値 | mixed |
プロパティ値またはビヘイビアのプロパティの値 |
---|---|---|
例外 | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
例外 | 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ではないかどうかを確認します。
このメソッドは、以下の順番でチェックし、それに応じて動作します。
- セッターで定義されたプロパティ: プロパティが設定されているかどうかを返す
- ビヘイビアのプロパティ: プロパティが設定されているかどうかを返す
- 存在しないプロパティには`false`を返す
これはPHPのマジックメソッドであり、`isset($component->property)`を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。
こちらも参照してください https://www.php.net/manual/en/function.isset.php.
public boolean __isset ( $name ) | ||
$name | string |
プロパティ名またはイベント名 |
戻り値 | 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()
コンポーネントプロパティの値を設定します。
このメソッドは、以下の順番でチェックし、それに応じて動作します。
- セッターで定義されたプロパティ: プロパティ値を設定する
- "on xyz"形式のイベント: "xyz"イベントにハンドラをアタッチする
- "as xyz"形式のビヘイビア: "xyz"という名前のビヘイビアをアタッチする
- ビヘイビアのプロパティ: ビヘイビアのプロパティ値を設定する
これはPHPのマジックメソッドであり、`$component->property = $value;`を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。
こちらも参照してください __get().
public void __set ( $name, $value ) | ||
$name | string |
プロパティ名またはイベント名 |
$value | mixed |
プロパティ値 |
例外 | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
---|---|---|
例外 | 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に設定します。
このメソッドは、以下の順番でチェックし、それに応じて動作します。
- セッターで定義されたプロパティ: プロパティ値をnullに設定する
- ビヘイビアのプロパティ: プロパティ値をnullに設定する
これはPHPのマジックメソッドであり、`unset($component->property)`を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。
こちらも参照してください https://www.php.net/manual/en/function.unset.php.
public void __unset ( $name ) | ||
$name | string |
プロパティ名 |
例外 | 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);
}
コントローラーの外部アクションを宣言します。
このメソッドは、コントローラーの外部アクションを宣言するためにオーバーライドすることを意図しています。アクションIDをキー、対応するアクションクラス名またはアクション設定配列を値とする配列を返す必要があります。例えば、
return [
'action1' => 'app\components\Action1',
'action2' => [
'class' => 'app\components\Action2',
'property1' => 'value1',
'property2' => 'value2',
],
];
Yii::createObject()は、後でここで提供された設定を使用して要求されたアクションを作成するために使用されます。
public array actions ( ) |
public function actions()
{
return [];
}
アクションが実行された直後にこのメソッドが呼び出されます。
このメソッドは、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 |
アクションの戻り値。 |
戻り値 | mixed |
処理されたアクションの結果。 |
---|
public function afterAction($action, $result)
{
$event = new ActionEvent($action);
$event->result = $result;
$this->trigger(self::EVENT_AFTER_ACTION, $event);
return $event->result;
}
定義先: yii\base\Component::attachBehavior()
このコンポーネントにビヘイビアをアタッチします。
このメソッドは、指定された設定に基づいてビヘイビアオブジェクトを作成します。その後、yii\base\Behavior::attach()メソッドを呼び出すことによって、ビヘイビアオブジェクトがこのコンポーネントにアタッチされます。
こちらも参照してください detachBehavior().
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | string |
ビヘイビアの名前。 |
$behavior | string|array|yii\base\Behavior |
ビヘイビアの設定。以下のいずれかになります。
|
戻り値 | yii\base\Behavior |
ビヘイビアオブジェクト |
---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
定義先: yii\base\Component::attachBehaviors()
コンポーネントにビヘイビアのリストをアタッチします。
各ビヘイビアは、その名前でインデックス付けされ、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);
}
}
アクションが実行される直前にこのメソッドが呼び出されます。
このメソッドは、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 |
実行されるアクション。 |
戻り値 | boolean |
アクションの実行を継続するかどうか。 |
---|
public function beforeAction($action)
{
$event = new ActionEvent($action);
$this->trigger(self::EVENT_BEFORE_ACTION, $event);
return $event->isValid;
}
定義先: yii\base\Component::behaviors()
このコンポーネントがビヘイビアとして動作するべきビヘイビアのリストを返します。
子クラスは、このメソッドをオーバーライドして、それらが振る舞うビヘイビアを指定できます。
このメソッドの戻り値は、ビヘイビア名でインデックス付けされたビヘイビアオブジェクトまたは設定の配列である必要があります。ビヘイビアの設定は、ビヘイビアクラスを指定する文字列、または以下の構造の配列のいずれかになります。
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
ビヘイビアクラスはyii\base\Behaviorを拡張する必要があることに注意してください。ビヘイビアは名前付きまたは匿名でアタッチできます。配列キーとして名前が使用されている場合、この名前を使用して、getBehavior() でビヘイビアを取得したり、detachBehavior() でビヘイビアをデタッチしたりできます。匿名ビヘイビアは取得またはデタッチできません。
このメソッドで宣言されたビヘイビアは、(オンデマンドで)自動的にコンポーネントにアタッチされます。
public array behaviors ( ) | ||
戻り値 | array |
ビヘイビアの設定。 |
---|
public function behaviors()
{
return [];
}
パラメーターをアクションにバインドします。
このメソッドは、指定されたパラメーターで実行を開始するときに、yii\base\Action によって呼び出されます。
public array bindActionParams ( $action, $params ) | ||
$action | yii\base\Action |
パラメーターとバインドされるアクション。 |
$params | array |
アクションにバインドされるパラメーター。 |
戻り値 | array |
アクションが実行できる有効なパラメーター。 |
---|
public function bindActionParams($action, $params)
{
return [];
}
アクションメソッドのシグネチャ内の型と名前に基づいてパラメーターを設定します。
protected void bindInjectedParams ( ReflectionType $type, $name, &$args, &$requestedParams ) | ||
$type | ReflectionType |
アクションパラメーターのリフレクションされた型。 |
$name | string |
パラメーターの名前。 |
$args | array |
アクションの引数の配列。この関数は、アイテムを追加する場合があります。 |
$requestedParams | array |
リクエストされたパラメーターを含む配列。この関数は、特定のキーを書き込む場合があります。 |
例外 | yii\base\ErrorException |
必要なサービスを読み込めなかった場合。 |
---|---|---|
例外 | yii\base\InvalidConfigException |
DI 設定にエラーがある場合にスローされます。 |
例外 | 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()
プロパティを読み取ることができるかどうかを示す値を返します。
プロパティは、以下の場合に読み取ることができます。
- クラスに、指定された名前と関連付けられたゲッターメソッドがある場合(この場合、プロパティ名はケースインセンシティブです)。
- クラスに、指定された名前のメンバー変数がある場合(`$checkVars` が true の場合)。
- アタッチされたビヘイビアに、指定された名前の読み取り可能なプロパティがある場合(`$checkBehaviors` が true の場合)。
こちらも参照してください canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
プロパティ名 |
$checkVars | boolean |
メンバー変数をプロパティとして扱うかどうか。 |
$checkBehaviors | boolean |
ビヘイビアのプロパティをこのコンポーネントのプロパティとして扱うかどうか。 |
戻り値 | 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()
プロパティを設定できるかどうかを示す値を返します。
プロパティは、以下の場合に書き込むことができます。
- クラスに、指定された名前と関連付けられたセッターメソッドがある場合(この場合、プロパティ名はケースインセンシティブです)。
- クラスに、指定された名前のメンバー変数がある場合(`$checkVars` が true の場合)。
- アタッチされたビヘイビアに、指定された名前の書き込み可能なプロパティがある場合(`$checkBehaviors` が true の場合)。
こちらも参照してください canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
プロパティ名 |
$checkVars | boolean |
メンバー変数をプロパティとして扱うかどうか。 |
$checkBehaviors | boolean |
ビヘイビアのプロパティをこのコンポーネントのプロパティとして扱うかどうか。 |
戻り値 | 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;
}
定義先: yii\base\BaseObject::className()
このクラスの完全修飾名を返します。
public static string className ( ) | ||
戻り値 | string |
このクラスの完全修飾名。 |
---|
public static function className()
{
return get_called_class();
}
指定されたアクションIDに基づいてアクションを作成します。
このメソッドはまず、アクションIDがactions()で宣言されているかどうかを確認します。宣言されている場合は、そこで宣言された設定を使用してアクションオブジェクトを作成します。宣言されていない場合は、アクションIDを`xyz`とした`actionXyz`形式の名前を持つコントローラーメソッドを探します。見つかった場合は、そのメソッドを表すyii\base\InlineActionが作成され、返されます。
public yii\base\Action|null createAction ( $id ) | ||
$id | string |
アクションID。 |
戻り値 | 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\base\Component::detachBehavior()
コンポーネントからビヘイビアをデタッチします。
ビヘイビアのyii\base\Behavior::detach()メソッドが呼び出されます。
public yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | string |
ビヘイビアの名前。 |
戻り値 | 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()
コンポーネントからすべてのビヘイビアをデタッチします。
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定義済み場所: yii\base\Component::ensureBehaviors()
behaviors()で宣言されたビヘイビアがこのコンポーネントにアタッチされていることを確認します。
public void ensureBehaviors ( ) |
public function ensureBehaviors()
{
if ($this->_behaviors === null) {
$this->_behaviors = [];
foreach ($this->behaviors() as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
}
適用可能なレイアウトファイルを見つけます。
public string|boolean findLayoutFile ( $view ) | ||
$view | yii\base\View |
レイアウトファイルを描画するビューオブジェクト。 |
戻り値 | string|boolean |
レイアウトファイルのパス、またはレイアウトが不要な場合はfalse。render()でこのパラメータの指定方法を参照してください。 |
---|---|---|
例外 | 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\base\Component::getBehavior()
名前付きビヘイビアオブジェクトを返します。
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string |
ビヘイビア名 |
戻り値 | yii\base\Behavior|null |
ビヘイビアオブジェクト、またはビヘイビアが存在しない場合はnull |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
定義済み場所: yii\base\Component::getBehaviors()
このコンポーネントにアタッチされているすべてのビヘイビアを返します。
public yii\base\Behavior[] getBehaviors ( ) | ||
戻り値 | yii\base\Behavior[] |
このコンポーネントにアタッチされているビヘイビアのリスト |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
このコントローラーのすべての祖先モジュールを返します。
配列の最初のモジュールは最も外側のモジュール(つまり、アプリケーションインスタンス)であり、最後は最も内側のモジュールです。
public yii\base\Module[] getModules ( ) | ||
戻り値 | yii\base\Module[] |
このコントローラーが存在するすべての祖先モジュール。 |
---|
public function getModules()
{
$modules = [$this->module];
$module = $this->module;
while ($module->module !== null) {
array_unshift($modules, $module->module);
$module = $module->module;
}
return $modules;
}
現在のリクエストのルートを返します。
public string getRoute ( ) | ||
戻り値 | string |
現在のリクエストのルート(モジュールID、コントローラーID、アクションID)。 |
---|
public function getRoute()
{
return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
}
コントローラーの一意のIDを返します。
public string getUniqueId ( ) | ||
戻り値 | string |
モジュールID(存在する場合)をプレフィックスとして付けたコントローラーID。 |
---|
public function getUniqueId()
{
return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
}
ビューまたはビューファイルをレンダリングするために使用できるビューオブジェクトを返します。
render()、renderPartial()、renderFile()メソッドは、このビューオブジェクトを使用して実際のビューレンダリングを実行します。設定されていない場合は、「view」アプリケーションコンポーネントがデフォルトになります。
public yii\base\View|yii\web\View getView ( ) | ||
戻り値 | yii\base\View|yii\web\View |
ビューまたはビューファイルをレンダリングするために使用できるビューオブジェクト。 |
---|
public function getView()
{
if ($this->_view === null) {
$this->_view = Yii::$app->getView();
}
return $this->_view;
}
このコントローラーのビューファイルを含むディレクトリを返します。
デフォルトの実装では、$moduleの$viewPathディレクトリの下にある、コントローラー$idという名前のディレクトリを返します。
public string getViewPath ( ) | ||
戻り値 | string |
このコントローラーのビューファイルを含むディレクトリ。 |
---|
public function getViewPath()
{
if ($this->_viewPath === null) {
$this->_viewPath = $this->module->getViewPath() . DIRECTORY_SEPARATOR . $this->id;
}
return $this->_viewPath;
}
定義済み場所: yii\base\Component::hasEventHandlers()
名前付きイベントにアタッチされているハンドラーがあるかどうかを示す値を返します。
public boolean hasEventHandlers ( $name ) | ||
$name | string |
イベント名 |
戻り値 | 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 |
ビヘイビアのメソッドをこのコンポーネントのメソッドとして扱うかどうか |
戻り値 | 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()
このコンポーネントのプロパティが定義されているかどうかを示す値を返します。
プロパティは、以下の場合に定義済みとみなされます。
- 指定された名前と関連付けられたゲッターまたはセッターメソッドがクラスに存在する場合(この場合、プロパティ名はケースインセンシティブです)。
- クラスに、指定された名前のメンバー変数がある場合(`$checkVars` が true の場合)。
- アタッチされたビヘイビアに、指定された名前のプロパティが存在する場合(`$checkBehaviors` が true の場合)。
参照
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
プロパティ名 |
$checkVars | boolean |
メンバー変数をプロパティとして扱うかどうか。 |
$checkBehaviors | boolean |
ビヘイビアのプロパティをこのコンポーネントのプロパティとして扱うかどうか。 |
戻り値 | 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\base\Component::off()
このコンポーネントから既存のイベントハンドラーをデタッチします。
このメソッドは、on() の反対の動作をします。
注記: イベント名にワイルドカードパターンが渡された場合、このワイルドカードで登録されたハンドラーのみが削除され、このワイルドカードと一致するプレーン名で登録されたハンドラーは残ります。
参照 on().
public boolean off ( $name, $handler = null ) | ||
$name | string |
イベント名 |
$handler | callable|null |
削除するイベントハンドラー。null の場合、指定されたイベントにアタッチされたすべてのハンドラーが削除されます。 |
戻り値 | 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;
}
定義場所: yii\base\Component::on()
イベントにイベントハンドラーをアタッチします。
イベントハンドラーは、有効な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]);
}
}
ビューをレンダリングし、レイアウトが利用可能な場合は適用します。
レンダリングされるビューは、以下のいずれかの形式で指定できます。
- パスエイリアス (例: "@app/views/site/index")。
- アプリケーション内の絶対パス (例: "//site/index"): ビュー名が二重スラッシュで始まる場合。実際のビューファイルは、アプリケーションの ビューパス で検索されます。
- モジュール内の絶対パス (例: "/site/index"): ビュー名が単一スラッシュで始まる場合。実際のビューファイルは、$module の ビューパス で検索されます。
- 相対パス (例: "index"): 実際のビューファイルは、$viewPath で検索されます。
適用するレイアウトを決定するために、以下の2つのステップを実行します。
- 最初のステップでは、レイアウト名とコンテキストモジュールを決定します。
- $layout が文字列として指定されている場合、それをレイアウト名として使用し、$module をコンテキストモジュールとして使用します。
- $layout が null の場合、このコントローラーのすべての祖先モジュールを検索し、layout が null でない最初のモジュールを見つけます。そのレイアウトとその対応するモジュールが、レイアウト名とコンテキストモジュールとしてそれぞれ使用されます。そのようなモジュールが見つからない場合、または対応するレイアウトが文字列でない場合、false を返し、適用可能なレイアウトがないことを意味します。
- 2番目のステップでは、事前に見つかったレイアウト名とコンテキストモジュールに従って、実際のレイアウトファイルを決定します。レイアウト名は、以下のいずれかになります。
- パスエイリアス (例: "@app/views/layouts/main")。
- 絶対パス (例: "/main"): レイアウト名がスラッシュで始まる場合。実際のレイアウトファイルは、アプリケーションの レイアウトパス で検索されます。
- 相対パス (例: "main"): 実際のレイアウトファイルは、コンテキストモジュールの レイアウトパス で検索されます。
レイアウト名にファイル拡張子が含まれていない場合、デフォルトの拡張子 `php` が使用されます。
public string render ( $view, $params = [] ) | ||
$view | string |
ビュー名。 |
$params | array |
ビューで使用可能にするパラメータ(名前と値のペア)。これらのパラメータはレイアウトでは使用できません。 |
戻り値 | string |
レンダリング結果。 |
---|---|---|
例外 | yii\base\InvalidArgumentException |
ビューファイルまたはレイアウトファイルが存在しない場合。 |
public function render($view, $params = [])
{
$content = $this->getView()->render($view, $params, $this);
return $this->renderContent($content);
}
レイアウトを適用して静的文字列をレンダリングします。
public string renderContent ( $content ) | ||
$content | string |
レンダリングされる静的文字列 |
戻り値 | string |
指定された静的文字列を `$content` 変数として持つレイアウトのレンダリング結果。レイアウトが無効になっている場合、文字列はそのまま返されます。 |
---|
public function renderContent($content)
{
$layoutFile = $this->findLayoutFile($this->getView());
if ($layoutFile !== false) {
return $this->getView()->renderFile($layoutFile, ['content' => $content], $this);
}
return $content;
}
ビューファイルをレンダリングします。
public string renderFile ( $file, $params = [] ) | ||
$file | string |
レンダリングするビューファイル。ファイルパスまたは パスエイリアス のいずれかです。 |
$params | array |
ビューで使用可能にするパラメーター(名前と値のペア)。 |
戻り値 | string |
レンダリング結果。 |
---|---|---|
例外 | yii\base\InvalidArgumentException |
ビューファイルが存在しない場合。 |
public function renderFile($file, $params = [])
{
return $this->getView()->renderFile($file, $params, $this);
}
レイアウトを適用せずにビューをレンダリングします。
このメソッドは、レイアウトを適用しないという点でrender()とは異なります。
public string renderPartial ( $view, $params = [] ) | ||
$view | string |
ビュー名。ビュー名の指定方法については、render()を参照してください。 |
$params | array |
ビューで使用可能にするパラメーター(名前と値のペア)。 |
戻り値 | string |
レンダリング結果。 |
---|---|---|
例外 | yii\base\InvalidArgumentException |
ビューファイルが存在しない場合。 |
public function renderPartial($view, $params = [])
{
return $this->getView()->render($view, $params, $this);
}
ルートで指定されたリクエストを実行します。
ルートは、このコントローラー内のアクションのID、またはモジュールID、コントローラーID、アクションIDからなる完全なルートのいずれかです。ルートがスラッシュ '/' で始まる場合、ルートの解析はアプリケーションから開始されます。それ以外の場合は、このコントローラーの親モジュールから開始されます。
runAction()も参照してください。
public mixed run ( $route, $params = [] ) | ||
$route | string |
処理するルート(例:'view'、'comment/view'、'/admin/comment/view')。 |
$params | array |
アクションに渡されるパラメーター。 |
戻り値 | 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);
}
指定されたアクションIDとパラメーターを使用して、このコントローラー内のアクションを実行します。
アクションIDが空の場合、このメソッドは$defaultActionを使用します。
createAction()も参照してください。
public mixed runAction ( $id, $params = [] ) | ||
$id | string |
実行するアクションのID。 |
$params | array |
アクションに渡されるパラメーター(名前と値のペア)。 |
戻り値 | mixed |
アクションの結果。 |
---|---|---|
例外 | yii\base\InvalidRouteException |
要求されたアクションIDをアクションに正常に解決できない場合。 |
public function runAction($id, $params = [])
{
$action = $this->createAction($id);
if ($action === null) {
throw new InvalidRouteException('Unable to resolve the request: ' . $this->getUniqueId() . '/' . $id);
}
Yii::debug('Route to run: ' . $action->getUniqueId(), __METHOD__);
if (Yii::$app->requestedAction === null) {
Yii::$app->requestedAction = $action;
}
$oldAction = $this->action;
$this->action = $action;
$modules = [];
$runAction = true;
// call beforeAction on modules
foreach ($this->getModules() as $module) {
if ($module->beforeAction($action)) {
array_unshift($modules, $module);
} else {
$runAction = false;
break;
}
}
$result = null;
if ($runAction && $this->beforeAction($action)) {
// run the action
$result = $action->runWithParams($params);
$result = $this->afterAction($action, $result);
// call afterAction on modules
foreach ($modules as $module) {
/* @var $module Module */
$result = $module->afterAction($action, $result);
}
}
if ($oldAction !== null) {
$this->action = $oldAction;
}
return $result;
}
このコントローラーで使用されるビューオブジェクトを設定します。
public void setView ( $view ) | ||
$view | yii\base\View|yii\web\View |
ビューまたはビューファイルをレンダリングするために使用できるビューオブジェクト。 |
public function setView($view)
{
$this->_view = $view;
}
ビューファイルを含むディレクトリを設定します。
public void setViewPath ( $path ) | ||
$path | string |
ビューファイルのルートディレクトリ。 |
例外 | yii\base\InvalidArgumentException |
ディレクトリが無効な場合 |
---|
public function setViewPath($path)
{
$this->_viewPath = Yii::getAlias($path);
}
定義先:yii\base\Component::trigger()
イベントをトリガーします。
このメソッドはイベントの発生を表します。クラスレベルのハンドラーを含む、イベントにアタッチされたすべてのハンドラーを呼び出します。
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\base\ActionEvent::$isValidをfalseに設定して、アクションの実行をキャンセルできます。
コメントするには、サインアップまたはログインしてください。