クラス yii\rest\Controller
Controller は、RESTful API コントローラークラスの基底クラスです。
Controller は、RESTful API リクエスト処理サイクルにおいて以下のステップを実装します。
- レスポンス形式の解決(yii\filters\ContentNegotiator を参照);
- リクエストメソッドの検証(verbs() を参照)。
- ユーザー認証(yii\filters\auth\AuthInterface を参照);
- レート制限(yii\filters\RateLimiter を参照);
- レスポンスデータのフォーマット(serializeData() を参照)。
Controller の詳細と使用方法については、REST コントローラーに関するガイド記事 を参照してください。
公開プロパティ
公開メソッド
保護されたメソッド
メソッド | 説明 | 定義元 |
---|---|---|
bindInjectedParams() | アクションメソッドのシグネチャにある型と名前に基づいてパラメーターを設定します。 | yii\base\Controller |
serializeData() | 指定されたデータをシリアライズします。 | yii\rest\Controller |
verbs() | 許可されたHTTPメソッドを宣言します。 | yii\rest\Controller |
イベント
イベント | 型 | 説明 | 定義元 |
---|---|---|---|
EVENT_AFTER_ACTION | yii\base\ActionEvent | コントローラーアクションの実行直後に発生するイベントです。 | yii\base\Controller |
EVENT_BEFORE_ACTION | yii\base\ActionEvent | コントローラーアクションの実行直前に発生するイベントです。 | yii\base\Controller |
プロパティの詳細
このコントローラーのアクションでCSRF検証を有効にするかどうか。このプロパティとyii\web\Request::$enableCsrfValidationの両方がtrueの場合にのみ、CSRF検証が有効になります。
レスポンスデータをフォーマットするシリアライザを作成するための設定。
メソッドの詳細
定義場所: 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)` を実行したときに暗黙的に呼び出されるため、直接呼び出さないでください。
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)` を実行したときに暗黙的に呼び出されるため、直接呼び出さないでください。
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);
}
定義場所: yii\base\Controller::actions()
コントローラーの外部アクションを宣言します。
このメソッドは、コントローラーの外部アクションを宣言するためにオーバーライドすることを目的としています。アクション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)
{
$result = parent::afterAction($action, $result);
return $this->serializeData($result);
}
定義されている場所: yii\web\Controller::asJson()
JSON形式でフォーマットされたデータを送信します。
このメソッドは、JSON形式でフォーマットされたデータを送信するためのショートカットです。response アプリケーションコンポーネントを返します。これは format を設定し、フォーマットするべき data を設定した後に返されます。一般的な使い方は次のとおりです。
return $this->asJson($data);
参照
public yii\web\Response asJson ( $data ) | ||
$data | mixed |
フォーマットするべきデータ。 |
戻り値 | yii\web\Response |
|
---|
public function asJson($data)
{
$this->response->format = Response::FORMAT_JSON;
$this->response->data = $data;
return $this->response;
}
定義されている場所: yii\web\Controller::asXml()
XML形式でフォーマットされたデータを送信します。
このメソッドは、XML形式でフォーマットされたデータを送信するためのショートカットです。response アプリケーションコンポーネントを返します。これは format を設定し、フォーマットするべき data を設定した後に返されます。一般的な使い方は次のとおりです。
return $this->asXml($data);
参照
public yii\web\Response asXml ( $data ) | ||
$data | mixed |
フォーマットするべきデータ。 |
戻り値 | yii\web\Response |
|
---|
public function asXml($data)
{
$this->response->format = Response::FORMAT_XML;
$this->response->data = $data;
return $this->response;
}
定義されている場所: 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);
}
}
定義されている場所: yii\web\Controller::beforeAction()
このメソッドは、アクションが実行される直前に呼び出されます。
このメソッドは、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)
{
if (parent::beforeAction($action)) {
if ($this->enableCsrfValidation && Yii::$app->getErrorHandler()->exception === null && !$this->request->validateCsrfToken()) {
throw new BadRequestHttpException(Yii::t('yii', 'Unable to verify your data submission.'));
}
return true;
}
return false;
}
このコンポーネントが動作するべき動作のリストを返します。
子クラスはこのメソッドをオーバーライドして、動作させたいビヘイビアを指定できます。
このメソッドの戻り値は、ビヘイビア名でインデックス付けされたビヘイビアオブジェクトまたは設定の配列である必要があります。ビヘイビア設定は、ビヘイビアクラスを指定する文字列、または次の構造の配列のいずれかになります。
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
ビヘイビアクラスは yii\base\Behavior から拡張する必要があることに注意してください。ビヘイビアは、名前付きまたは匿名でアタッチできます。配列キーとして名前を使用する場合、この名前を使用して、getBehavior() を使用して後でビヘイビアを取得するか、detachBehavior() を使用してデタッチできます。匿名ビヘイビアは取得またはデタッチできません。
このメソッドで宣言されたビヘイビアは、(オンデマンドで)自動的にコンポーネントにアタッチされます。
public array behaviors ( ) | ||
戻り値 | array |
ビヘイビアの設定。 |
---|
public function behaviors()
{
return [
'contentNegotiator' => [
'class' => ContentNegotiator::className(),
'formats' => [
'application/json' => Response::FORMAT_JSON,
'application/xml' => Response::FORMAT_XML,
],
],
'verbFilter' => [
'class' => VerbFilter::className(),
'actions' => $this->verbs(),
],
'authenticator' => [
'class' => CompositeAuth::className(),
],
'rateLimiter' => [
'class' => RateLimiter::className(),
],
];
}
定義されている場所: yii\web\Controller::bindActionParams()
パラメーターをアクションにバインドします。
このメソッドは、指定されたパラメータで実行を開始した際に、yii\base\Action によって呼び出されます。このメソッドは、アクションに必要なパラメータ名をチェックし、要件に応じて提供されたパラメータを返します。パラメータが不足している場合、例外がスローされます。
public array bindActionParams ( $action, $params ) | ||
$action | yii\base\Action |
パラメータをバインドするアクション |
$params | array |
アクションにバインドするパラメータ |
戻り値 | array |
アクションが実行できる有効なパラメータ。 |
---|---|---|
例外 | yii\web\BadRequestHttpException |
パラメータが不足しているか無効な場合。 |
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 $param) {
$name = $param->getName();
if (array_key_exists($name, $params)) {
$isValid = true;
if (PHP_VERSION_ID >= 80000) {
$isArray = ($type = $param->getType()) instanceof \ReflectionNamedType && $type->getName() === 'array';
} else {
$isArray = $param->isArray();
}
if ($isArray) {
$params[$name] = (array)$params[$name];
} elseif (is_array($params[$name])) {
$isValid = false;
} elseif (
PHP_VERSION_ID >= 70000
&& ($type = $param->getType()) !== null
&& method_exists($type, 'isBuiltin')
&& $type->isBuiltin()
&& ($params[$name] !== null || !$type->allowsNull())
) {
$typeName = PHP_VERSION_ID >= 70100 ? $type->getName() : (string)$type;
if ($params[$name] === '' && $type->allowsNull()) {
if ($typeName !== 'string') { // for old string behavior compatibility
$params[$name] = null;
}
} else {
switch ($typeName) {
case 'int':
$params[$name] = filter_var($params[$name], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE);
break;
case 'float':
$params[$name] = filter_var($params[$name], FILTER_VALIDATE_FLOAT, FILTER_NULL_ON_FAILURE);
break;
case 'bool':
$params[$name] = filter_var($params[$name], FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
break;
}
if ($params[$name] === null) {
$isValid = false;
}
}
}
if (!$isValid) {
throw new BadRequestHttpException(
Yii::t('yii', 'Invalid data received for parameter "{param}".', ['param' => $name])
);
}
$args[] = $actionParams[$name] = $params[$name];
unset($params[$name]);
} elseif (
PHP_VERSION_ID >= 70100
&& ($type = $param->getType()) !== null
&& $type instanceof \ReflectionNamedType
&& !$type->isBuiltin()
) {
try {
$this->bindInjectedParams($type, $name, $args, $requestedParams);
} catch (HttpException $e) {
throw $e;
} catch (Exception $e) {
throw new ServerErrorHttpException($e->getMessage(), 0, $e);
}
} elseif ($param->isDefaultValueAvailable()) {
$args[] = $actionParams[$name] = $param->getDefaultValue();
} else {
$missing[] = $name;
}
}
if (!empty($missing)) {
throw new BadRequestHttpException(
Yii::t('yii', 'Missing required parameters: {params}', ['params' => implode(', ', $missing)])
);
}
$this->actionParams = $actionParams;
// 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 $args;
}
定義先: yii\base\Controller::bindInjectedParams()
アクションメソッドのシグネチャにある型と名前に基づいてパラメーターを設定します。
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;
}
::class
を使用してください。
定義先: yii\base\BaseObject::className()
このクラスの完全修飾名を返します。
public static string className ( ) | ||
戻り値 | string |
このクラスの完全修飾名。 |
---|
public static function className()
{
return get_called_class();
}
定義先: yii\base\Controller::createAction()
指定されたアクションIDに基づいてアクションを作成します。
このメソッドはまず、アクション ID がactions()で宣言されているかどうかをチェックします。宣言されている場合、そこで宣言された設定を使用してアクションオブジェクトを作成します。宣言されていない場合、xyz
がアクションIDである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);
}
}
}
定義先: yii\base\Controller::findLayoutFile()
適用可能なレイアウトファイルを見つけます。
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;
}
定義位置: yii\base\Controller::getModules()
このコントローラーのすべての祖先モジュールを返します。
配列の最初のモジュールが最上位(つまり、アプリケーションインスタンス)、最後のモジュールが最下位です。
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;
}
定義位置: yii\base\Controller::getRoute()
現在のリクエストのルートを返します。
public string getRoute ( ) | ||
戻り値 | string |
現在のリクエストのルート(モジュールID、コントローラーID、アクションID)。 |
---|
public function getRoute()
{
return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
}
定義位置: yii\base\Controller::getUniqueId()
コントローラーの一意のIDを返します。
public string getUniqueId ( ) | ||
戻り値 | string |
モジュールID(もしあれば)を接頭辞として付けたコントローラーID。 |
---|
public function getUniqueId()
{
return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
}
定義位置: yii\base\Controller::getView()
ビューのレンダリングまたはビューファイルのレンダリングに使用できるビューオブジェクトを返します。
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;
}
定義位置: yii\base\Controller::getViewPath()
このコントローラーのビューファイルを含むディレクトリを返します。
デフォルトの実装では、$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\web\Controller::goBack()
ブラウザを最後に閲覧したページにリダイレクトします。
このメソッドは、アクションでyii\web\Responseを直接返すことで使用できます。
// stop executing this action and redirect to last visited page
return $this->goBack();
この関数が動作するには、事前に適切な場所でリターンURLを設定する必要があります。
yii\web\User::getReturnUrl()も参照してください。
public yii\web\Response goBack ( $defaultUrl = null ) | ||
$defaultUrl | string|array|null |
以前に設定されていない場合のデフォルトのリターンURL。これがnullで、以前にリターンURLが設定されていない場合、yii\web\Application::$homeUrlにリダイレクトされます。URLの許容形式については、yii\web\User::setReturnUrl()を参照してください。 |
戻り値 | yii\web\Response |
現在のレスポンスオブジェクト |
---|
public function goBack($defaultUrl = null)
{
return $this->response->redirect(Yii::$app->getUser()->getReturnUrl($defaultUrl));
}
定義位置: yii\web\Controller::goHome()
ブラウザをホームページにリダイレクトします。
このメソッドは、アクションでyii\web\Responseを直接返すことで使用できます。
// stop executing this action and redirect to home page
return $this->goHome();
public yii\web\Response goHome ( ) | ||
戻り値 | yii\web\Response |
現在のレスポンスオブジェクト |
---|
public function goHome()
{
return $this->response->redirect(Yii::$app->getHomeUrl());
}
定義位置: 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()
このコンポーネントに対してプロパティが定義されているかどうかを示す値を返します。
プロパティは、以下の場合に定義済みとみなされます。
- 指定された名前と関連付けられたgetterまたはsetterメソッドがクラスに存在する場合(この場合、プロパティ名はケースインセンシティブです)。
- クラスに、指定された名前のメンバ変数がある場合(
$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]);
}
}
定義位置: yii\web\Controller::redirect()
ブラウザを指定されたURLにリダイレクトします。
このメソッドは、yii\web\Response::redirect() のショートカットです。
アクション内で yii\web\Response を直接返すことで使用できます。
// stop executing this action and redirect to login page
return $this->redirect(['login']);
public yii\web\Response redirect ( $url, $statusCode = 302 ) | ||
$url | string|array |
リダイレクト先のURL。以下のいずれかの形式で指定できます。
単一のフォワードスラッシュ "/" で始まる相対URLは、現在のリクエストのホスト情報が先頭に付加されることで絶対URLに変換されます。 |
$statusCode | integer |
HTTPステータスコード。デフォルトは302。HTTPステータスコードの詳細については、https://tools.ietf.org/html/rfc2616#section-10 を参照してください。 |
戻り値 | yii\web\Response |
現在のレスポンスオブジェクト |
---|
public function redirect($url, $statusCode = 302)
{
// calling Url::to() here because Response::redirect() modifies route before calling Url::to()
return $this->response->redirect(Url::to($url), $statusCode);
}
定義位置: yii\web\Controller::refresh()
現在のページを更新します。
このメソッドは、yii\web\Response::refresh() のショートカットです。
アクション内で yii\web\Response を直接返すことで使用できます。
// stop executing this action and refresh the current page
return $this->refresh();
public yii\web\Response refresh ( $anchor = '' ) | ||
$anchor | string |
リダイレクトURLに追加するアンカー。デフォルトは空文字列。アンカーを指定する場合は"#"で始まるようにしてください。 |
戻り値 | yii\web\Response |
レスポンスオブジェクト自体 |
---|
public function refresh($anchor = '')
{
return $this->response->redirect($this->request->getUrl() . $anchor);
}
定義位置: yii\base\Controller::render()
ビューをレンダリングし、レイアウトがあれば適用します。
レンダリングするビューは、以下のいずれかの形式で指定できます。
- パスエイリアス (例: "@app/views/site/index")
- アプリケーション内の絶対パス (例: "//site/index"): ビュー名がダブルスラッシュで始まる場合。実際のビューファイルは、アプリケーションの view path で検索されます。
- モジュール内の絶対パス (例: "/site/index"): ビュー名がシングルスラッシュで始まる場合。実際のビューファイルは、view path の $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);
}
定義場所:yii\web\Controller::renderAjax()
AJAXリクエストに応答してビューをレンダリングします。
このメソッドはrenderPartial()と似ていますが、ビューに登録されているJS/CSSスクリプトとファイルをレンダリング結果に挿入する点が異なります。このため、AJAXリクエストに応答するためにビューをレンダリングする場合は、renderPartial()ではなく、このメソッドを使用する必要があります。
public string renderAjax ( $view, $params = [] ) | ||
$view | string |
ビュー名。render()でビュー名の指定方法を参照してください。 |
$params | array |
ビューで使用可能にするパラメータ(名前と値のペア)。 |
戻り値 | string |
レンダリング結果。 |
---|
public function renderAjax($view, $params = [])
{
return $this->getView()->renderAjax($view, $params, $this);
}
定義場所:yii\base\Controller::renderContent()
レイアウトを適用して静的な文字列をレンダリングします。
public string renderContent ( $content ) | ||
$content | string |
レンダリングされる静的な文字列。 |
戻り値 | 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 |
ビューで使用可能にするパラメータ(名前と値のペア)。 |
戻り値 | string |
レンダリング結果。 |
---|---|---|
例外 | yii\base\InvalidArgumentException |
ビューファイルが存在しない場合。 |
public function renderFile($file, $params = [])
{
return $this->getView()->renderFile($file, $params, $this);
}
定義場所:yii\base\Controller::renderPartial()
レイアウトを適用せずにビューをレンダリングします。
このメソッドは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);
}
定義場所:yii\base\Controller::run()
ルートで指定されたリクエストを実行します。
ルートは、このコントローラ内のアクションの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);
}
定義場所:yii\base\Controller::runAction()
指定されたアクション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;
}
指定されたデータをシリアライズします。
$serializerで指定された設定に基づいてシリアライザを作成します。その後、シリアライザを使用して指定されたデータをシリアライズします。
protected mixed serializeData ( $data ) | ||
$data | mixed |
シリアライズするデータ。 |
戻り値 | mixed |
シリアライズされたデータ。 |
---|
protected function serializeData($data)
{
return Yii::createObject($this->serializer)->serialize($data);
}
定義場所: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 |
ビューファイルのルートディレクトリ。 |
例外 | 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);
}
許可されたHTTPメソッドを宣言します。
許可される動詞の宣言方法については、yii\filters\VerbFilter::$actions を参照してください。
protected array verbs ( ) | ||
戻り値 | array |
許可されたHTTP動詞。 |
---|
protected function verbs()
{
return [];
}
コメントするには サインアップ または ログイン してください。