クラス yii\web\Application
Applicationはすべてのウェブアプリケーションクラスの基本クラスです。
Applicationの詳細と使用方法については、アプリケーションに関するガイド記事を参照してください。
パブリックプロパティ
パブリックメソッド
保護されたメソッド
メソッド | 説明 | 定義元 |
---|---|---|
bootstrap() | 拡張機能を初期化し、ブートストラップコンポーネントを実行します。 | yii\web\Application |
defaultVersion() | デフォルトのモジュールバージョンを返します。 | yii\base\Module |
registerErrorHandler() | errorHandlerコンポーネントをPHPエラーハンドラーとして登録します。 | yii\base\Application |
イベント
イベント | 型 | 説明 | 定義元 |
---|---|---|---|
EVENT_AFTER_ACTION | yii\base\ActionEvent | コントローラーアクションの実行後に発生するイベント。 | yii\base\Module |
EVENT_AFTER_REQUEST | yii\base\Event | アプリケーションがリクエストを正常に処理した後(レスポンスが送信される前)に発生するイベント。 | yii\base\Application |
EVENT_BEFORE_ACTION | yii\base\ActionEvent | コントローラーアクションの実行前に発生するイベント。 | yii\base\Module |
EVENT_BEFORE_REQUEST | yii\base\Event | アプリケーションがリクエストの処理を開始する前に発生するイベント。 | yii\base\Application |
定数
定数 | 値 | 説明 | 定義元 |
---|---|---|---|
STATE_AFTER_REQUEST | 4 | $state で使用されるアプリケーションの状態: アプリケーションが EVENT_AFTER_REQUEST をトリガーしています。 。 | yii\base\Application |
STATE_BEFORE_REQUEST | 2 | $state で使用されるアプリケーションの状態: アプリケーションが EVENT_BEFORE_REQUEST をトリガーしています。 | yii\base\Application |
STATE_BEGIN | 0 | $state で使用されるアプリケーションの状態: アプリケーションが起動したばかりです。 | yii\base\Application |
STATE_END | 6 | $state で使用されるアプリケーションの状態: アプリケーションが終了しました。 | yii\base\Application |
STATE_HANDLING_REQUEST | 3 | $state で使用されるアプリケーションの状態: アプリケーションがリクエストを処理中です。 | yii\base\Application |
STATE_INIT | 1 | $state で使用されるアプリケーションの状態: アプリケーションが初期化中です。 | yii\base\Application |
STATE_SENDING_RESPONSE | 5 | $state で使用されるアプリケーションの状態: アプリケーションがレスポンスを送信しようとしています。 | yii\base\Application |
プロパティの詳細
すべてのユーザーリクエストを処理する必要があるコントローラーアクションを指定する構成。これは主に、アプリケーションがメンテナンスモードで、単一のアクションを介してすべての着信リクエストを処理する必要がある場合に使用されます。構成は、最初のエレメントがアクションのルートを指定する配列です。配列の残りのエレメント(キーと値のペア)は、アクションにバインドされるパラメーターを指定します。例:
[
'offline/notice',
'param1' => 'value1',
'param2' => 'value2',
]
デフォルトはnullで、キャッチオールは使用されないことを意味します。
このアプリケーションのデフォルトルート。デフォルトは 'site' です。
エラーハンドラーアプリケーションコンポーネント。
メソッドの詳細
定義元: yii\base\Component::__call()
クラスメソッドではない名前付きメソッドを呼び出します。
このメソッドは、アタッチされたビヘイビアが指定された名前のメソッドを持っているかどうかを確認し、もしあればそれを実行します。
このメソッドは、未知のメソッドが呼び出されたときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。
public mixed __call ( $name, $params ) | ||
$name | 文字列 |
メソッド名 |
$params | 配列 |
メソッドのパラメータ |
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()");
}
定義元: yii\base\Component::__clone()
このメソッドは、オブジェクトが既存のオブジェクトを複製して作成された後に呼び出されます。
古いオブジェクトにアタッチされているため、すべてのビヘイビアを削除します。
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
定義元: yii\base\Application::__construct()
コンストラクター。
public void __construct ( $config = [] ) | ||
$config | 配列 |
オブジェクトのプロパティを初期化するために使用される名前と値のペア。構成には、$idと$basePathの両方が含まれている必要があることに注意してください。 |
throws | yii\base\InvalidConfigException |
---|
public function __construct($config = [])
{
Yii::$app = $this;
static::setInstance($this);
$this->state = self::STATE_BEGIN;
$this->preInit($config);
$this->registerErrorHandler($config);
Component::__construct($config);
}
定義元: yii\di\ServiceLocator::__get()
ゲッターマジックメソッド。
このメソッドは、プロパティを読み取るようにコンポーネントにアクセスできるようにオーバーライドされています。
public mixed __get ( $name ) | ||
$name | 文字列 |
コンポーネントまたはプロパティの名前 |
return | mixed |
指定されたプロパティの値 |
---|
public function __get($name)
{
if ($this->has($name)) {
return $this->get($name);
}
return parent::__get($name);
}
定義元: yii\di\ServiceLocator::__isset()
プロパティの値がnullかどうかを確認します。
このメソッドは、指定されたコンポーネントがロードされているかどうかを確認することにより、親の実装をオーバーライドします。
public boolean __isset ( $name ) | ||
$name | 文字列 |
プロパティ名またはイベント名 |
return | boolean |
プロパティ値がnullかどうか |
---|
public function __isset($name)
{
if ($this->has($name)) {
return true;
}
return parent::__isset($name);
}
定義元: yii\base\Component::__set()
コンポーネントのプロパティの値を設定します。
このメソッドは、次の順序で確認し、それに応じて動作します
- セッターによって定義されたプロパティ:プロパティ値を設定
- "on xyz"の形式のイベント:イベント "xyz"にハンドラーをアタッチ
- "as xyz"の形式のビヘイビア:"xyz"という名前のビヘイビアをアタッチ
- ビヘイビアのプロパティ:ビヘイビアのプロパティ値を設定
このメソッドは、$component->property = $value;
を実行するときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。
__get()も参照してください。
public void __set ( $name, $value ) | ||
$name | 文字列 |
プロパティ名またはイベント名 |
$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に設定します。
このメソッドは、次の順序で確認し、それに応じて動作します
- セッターによって定義されたプロパティ:プロパティ値をnullに設定
- ビヘイビアのプロパティ:プロパティ値をnullに設定
このメソッドは、unset($component->property)
を実行するときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。
public void __unset ( $name ) | ||
$name | 文字列 |
プロパティ名 |
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);
}
定義元: yii\base\Module::afterAction()
このメソッドは、このモジュール内のアクションが実行された直後に呼び出されます。
このメソッドは、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;
}
定義元: yii\base\Component::attachBehavior()
このコンポーネントにビヘイビアをアタッチします。
このメソッドは、指定された構成に基づいてビヘイビアオブジェクトを作成します。その後、yii\base\Behavior::attach()メソッドを呼び出すことにより、ビヘイビアオブジェクトがこのコンポーネントにアタッチされます。
detachBehavior()も参照してください。
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | 文字列 |
ビヘイビアの名前。 |
$behavior | string|array|yii\base\Behavior |
ビヘイビアの設定。以下のいずれかになります。
|
return | 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 | 配列 |
コンポーネントにアタッチされるビヘイビアのリスト |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
定義元: yii\base\Module::beforeAction()
このメソッドは、このモジュール内のアクションが実行される直前に呼び出されます。
このメソッドは、EVENT_BEFORE_ACTION イベントをトリガーします。メソッドの戻り値は、アクションの実行を継続するかどうかを決定します。
アクションを実行しない場合、リクエストは必要な出力を提供するか、リクエストをリダイレクトすることで beforeAction
コード内で処理する必要があります。そうしないと、レスポンスは空になります。
このメソッドをオーバーライドする場合、コードは次のようになります
public function beforeAction($action)
{
if (!parent::beforeAction($action)) {
return false;
}
// your 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)
{
$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 ( ) | ||
return | 配列 |
ビヘイビアの設定。 |
---|
public function behaviors()
{
return [];
}
拡張機能を初期化し、ブートストラップコンポーネントを実行します。
このメソッドは、アプリケーションが完全に設定された後、init() によって呼び出されます。このメソッドをオーバーライドする場合は、必ず親の実装も呼び出してください。
protected void bootstrap ( ) |
protected function bootstrap()
{
$request = $this->getRequest();
Yii::setAlias('@webroot', dirname($request->getScriptFile()));
Yii::setAlias('@web', $request->getBaseUrl());
parent::bootstrap();
}
定義元: yii\base\Component::canGetProperty()
プロパティを読み取れるかどうかを示す値を返します。
プロパティは、以下の場合に読み取り可能です。
- クラスに、指定された名前に関連付けられたゲッターメソッドがある場合(この場合、プロパティ名は大文字と小文字を区別しません)。
- クラスに、指定された名前のメンバ変数がある場合(
$checkVars
が true の場合)。 - アタッチされたビヘイビアに、指定された名前の読み取り可能なプロパティがある場合(
$checkBehaviors
が true の場合)。
canSetProperty() も参照してください。
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | 文字列 |
プロパティ名 |
$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()
プロパティを設定できるかどうかを示す値を返します。
プロパティは、以下の場合に書き込み可能です。
- クラスに、指定された名前に関連付けられたセッターメソッドがある場合(この場合、プロパティ名は大文字と小文字を区別しません)。
- クラスに、指定された名前のメンバ変数がある場合(
$checkVars
が true の場合)。 - アタッチされたビヘイビアに、指定された名前の書き込み可能なプロパティがある場合(
$checkBehaviors
が true の場合)。
canGetProperty() も参照してください。
public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | 文字列 |
プロパティ名 |
$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()
このクラスの完全修飾名を返します。
public static string className ( ) | ||
return | 文字列 |
このクラスの完全修飾名。 |
---|
public static function className()
{
return get_called_class();
}
定義元: yii\di\ServiceLocator::clear()
ロケーターからコンポーネントを削除します。
public void clear ( $id ) | ||
$id | 文字列 |
コンポーネント ID |
public function clear($id)
{
unset($this->_definitions[$id], $this->_components[$id]);
}
コアアプリケーションコンポーネントの構成を返します。
public array coreComponents ( ) |
public function coreComponents()
{
return array_merge(parent::coreComponents(), [
'request' => ['class' => 'yii\web\Request'],
'response' => ['class' => 'yii\web\Response'],
'session' => ['class' => 'yii\web\Session'],
'user' => ['class' => 'yii\web\User'],
'errorHandler' => ['class' => 'yii\web\ErrorHandler'],
]);
}
定義元: yii\base\Module::createController()
指定されたルートに基づいてコントローラーのインスタンスを作成します。
ルートはこのモジュールに対する相対パスである必要があります。このメソッドは、指定されたルートを解決するために次のアルゴリズムを実装します。
- ルートが空の場合、$defaultRoute を使用します。
- ルートの最初のセグメントが$controllerMapで見つかった場合、$controllerMapにある対応する設定に基づいてコントローラーを作成します。
- ルートの最初のセグメントが$modulesで宣言されている有効なモジュールIDである場合、モジュールの
createController()
をルートの残りの部分で呼び出します。 - 指定されたルートは
abc/def/xyz
の形式です。コントローラー名前空間内で、abc\DefController
またはabc\def\XyzController
クラスを試します。
上記のいずれかのステップでコントローラーが解決されると、アクションIDとして扱われるルートの残りの部分とともに返されます。それ以外の場合は、false
が返されます。
public array|boolean createController ( $route ) | ||
$route | 文字列 |
モジュール、コントローラー、およびアクションIDで構成されるルート。 |
return | array|boolean |
コントローラーが正常に作成された場合は、要求されたアクションIDとともに返されます。それ以外の場合は、 |
---|---|---|
throws | yii\base\InvalidConfigException |
コントローラークラスとそのファイルが一致しない場合。 |
public function createController($route)
{
if ($route === '') {
$route = $this->defaultRoute;
}
// double slashes or leading/ending slashes may cause substr problem
$route = trim($route, '/');
if (strpos($route, '//') !== false) {
return false;
}
if (strpos($route, '/') !== false) {
list($id, $route) = explode('/', $route, 2);
} else {
$id = $route;
$route = '';
}
// module and controller map take precedence
if (isset($this->controllerMap[$id])) {
$controller = Yii::createObject($this->controllerMap[$id], [$id, $this]);
return [$controller, $route];
}
$module = $this->getModule($id);
if ($module !== null) {
return $module->createController($route);
}
if (($pos = strrpos($route, '/')) !== false) {
$id .= '/' . substr($route, 0, $pos);
$route = substr($route, $pos + 1);
}
$controller = $this->createControllerByID($id);
if ($controller === null && $route !== '') {
$controller = $this->createControllerByID($id . '/' . $route);
$route = '';
}
return $controller === null ? false : [$controller, $route];
}
定義元: yii\base\Module::createControllerByID()
指定されたコントローラーIDに基づいてコントローラーを作成します。
コントローラーIDは、このモジュールに対する相対的なものです。コントローラークラスは、$controllerNamespaceの下に名前空間が設定されている必要があります。
このメソッドは、$modulesまたは$controllerMapをチェックしないことに注意してください。
public yii\base\Controller|null createControllerByID ( $id ) | ||
$id | 文字列 |
コントローラーID。 |
return | yii\base\Controller|null |
新しく作成されたコントローラーインスタンス。コントローラーIDが無効な場合は |
---|---|---|
throws | yii\base\InvalidConfigException |
コントローラークラスとそのファイル名が一致しない場合。この例外は、デバッグモードの場合にのみスローされます。 |
public function createControllerByID($id)
{
$pos = strrpos($id, '/');
if ($pos === false) {
$prefix = '';
$className = $id;
} else {
$prefix = substr($id, 0, $pos + 1);
$className = substr($id, $pos + 1);
}
if ($this->isIncorrectClassNameOrPrefix($className, $prefix)) {
return null;
}
$className = preg_replace_callback('%-([a-z0-9_])%i', function ($matches) {
return ucfirst($matches[1]);
}, ucfirst($className)) . 'Controller';
$className = ltrim($this->controllerNamespace . '\\' . str_replace('/', '\\', $prefix) . $className, '\\');
if (strpos($className, '-') !== false || !class_exists($className)) {
return null;
}
if (is_subclass_of($className, 'yii\base\Controller')) {
$controller = Yii::createObject($className, [$id, $this]);
return get_class($controller) === $className ? $controller : null;
} elseif (YII_DEBUG) {
throw new InvalidConfigException('Controller class must extend from \\yii\\base\\Controller.');
}
return null;
}
定義元: yii\base\Module::defaultVersion()
デフォルトのモジュールバージョンを返します。
子クラスは、より具体的なバージョン検出を提供するためにこのメソッドをオーバーライドできます。
protected string defaultVersion ( ) | ||
return | 文字列 |
このモジュールのバージョン。 |
---|
protected function defaultVersion()
{
if ($this->module === null) {
return '1.0';
}
return $this->module->getVersion();
}
定義元: yii\base\Component::detachBehavior()
コンポーネントからビヘイビアをデタッチします。
ビヘイビアのyii\base\Behavior::detach()メソッドが呼び出されます。
public yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | 文字列 |
ビヘイビアの名前。 |
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()
コンポーネントからすべてのビヘイビアをデタッチします。
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定義元: yii\base\Application::end()
アプリケーションを終了します。
このメソッドは、アプリケーションのライフサイクルが終了する前に完了することを保証することにより、exit()
関数を置き換えます。
public void end ( $status = 0, $response = null ) | ||
$status | 整数 |
終了ステータス(値0は正常終了を意味し、他の値は異常終了を意味します)。 |
$response | yii\base\Response|null |
送信するレスポンス。設定されていない場合は、デフォルトのアプリケーション$responseコンポーネントが使用されます。 |
throws | yii\base\ExitException |
アプリケーションがテストモードの場合 |
---|
public function end($status = 0, $response = null)
{
if ($this->state === self::STATE_BEFORE_REQUEST || $this->state === self::STATE_HANDLING_REQUEST) {
$this->state = self::STATE_AFTER_REQUEST;
$this->trigger(self::EVENT_AFTER_REQUEST);
}
if ($this->state !== self::STATE_SENDING_RESPONSE && $this->state !== self::STATE_END) {
$this->state = self::STATE_END;
$response = $response ?: $this->getResponse();
$response->send();
}
if (YII_ENV_TEST) {
throw new ExitException($status);
}
exit($status);
}
定義元: 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);
}
}
}
指定されたIDを持つコンポーネントインスタンスを返します。
バージョン 2.0.13 以降では、モジュールでコンポーネントが定義されていない場合、親モジュールで検索されます。親モジュールはアプリケーションの場合があります。
public object|null get ( $id, $throwException = true ) | ||
$id | 文字列 |
コンポーネントID(例: |
$throwException | boolean |
|
return | object|null |
指定されたIDのコンポーネント。 |
---|---|---|
throws | yii\base\InvalidConfigException |
|
public function get($id, $throwException = true)
{
if (!isset($this->module)) {
return parent::get($id, $throwException);
}
$component = parent::get($id, false);
if ($component === null) {
$component = $this->module->get($id, $throwException);
}
return $component;
}
定義元: yii\base\Application::getAssetManager()
アセットマネージャーを返します。
public yii\web\AssetManager getAssetManager ( ) | ||
return | yii\web\AssetManager |
アセットマネージャーアプリケーションコンポーネント。 |
---|
public function getAssetManager()
{
return $this->get('assetManager');
}
定義元: yii\base\Application::getAuthManager()
このアプリケーションの認証マネージャーを返します。
public yii\rbac\ManagerInterface|null getAuthManager ( ) | ||
return | yii\rbac\ManagerInterface|null |
認証マネージャーアプリケーションコンポーネント、または設定されていない場合はnull。 |
---|
public function getAuthManager()
{
return $this->get('authManager', false);
}
public string getBasePath ( ) | ||
return | 文字列 |
モジュールのルートディレクトリ。 |
---|
public function getBasePath()
{
if ($this->_basePath === null) {
$class = new \ReflectionClass($this);
$this->_basePath = dirname($class->getFileName());
}
return $this->_basePath;
}
定義元: yii\base\Component::getBehavior()
指定された名前のビヘイビアオブジェクトを返します。
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | 文字列 |
ビヘイビアの名前 |
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()
このコンポーネントにアタッチされているすべてのビヘイビアを返します。
public yii\base\Behavior[] getBehaviors ( ) | ||
return | yii\base\Behavior[] |
このコンポーネントにアタッチされたビヘイビアのリスト |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
定義元: yii\base\Application::getCache()
キャッシュコンポーネントを返します。
public yii\caching\CacheInterface|null getCache ( ) | ||
return | yii\caching\CacheInterface|null |
キャッシュアプリケーションコンポーネント。コンポーネントが有効になっていない場合は Null。 |
---|
public function getCache()
{
return $this->get('cache', false);
}
定義元: yii\di\ServiceLocator::getComponents()
コンポーネント定義またはロードされたコンポーネントインスタンスのリストを返します。
public array getComponents ( $returnDefinitions = true ) | ||
$returnDefinitions | boolean |
ロードされたコンポーネントインスタンスの代わりにコンポーネント定義を返すかどうか。 |
return | 配列 |
コンポーネントの定義またはロードされたコンポーネントインスタンスのリスト(ID => 定義またはインスタンス)。 |
---|
public function getComponents($returnDefinitions = true)
{
return $returnDefinitions ? $this->_definitions : $this->_components;
}
定義元: yii\base\Module::getControllerPath()
$controllerNamespace に従ってコントローラークラスを含むディレクトリを返します。
このメソッドが値を返すためには、$controllerNamespace のルート名前空間にエイリアスを定義する必要があることに注意してください。
public string getControllerPath ( ) | ||
return | 文字列 |
コントローラークラスを含むディレクトリ。 |
---|---|---|
throws | yii\base\InvalidArgumentException |
$controllerNamespace のルート名前空間にエイリアスが定義されていない場合。 |
public function getControllerPath()
{
if ($this->_controllerPath === null) {
$this->_controllerPath = Yii::getAlias('@' . str_replace('\\', '/', $this->controllerNamespace));
}
return $this->_controllerPath;
}
定義元: yii\base\Application::getDb()
データベース接続コンポーネントを返します。
public yii\db\Connection getDb ( ) | ||
return | yii\db\Connection |
データベース接続。 |
---|
public function getDb()
{
return $this->get('db');
}
エラーハンドラーコンポーネントを返します。
public yii\web\ErrorHandler getErrorHandler ( ) | ||
return | yii\web\ErrorHandler |
エラーハンドラーアプリケーションコンポーネント。 |
---|
public function getErrorHandler()
{
return $this->get('errorHandler');
}
定義元: yii\base\Application::getFormatter()
フォーマッターコンポーネントを返します。
public yii\i18n\Formatter getFormatter ( ) | ||
return | yii\i18n\Formatter |
フォーマッターアプリケーションコンポーネント。 |
---|
public function getFormatter()
{
return $this->get('formatter');
}
public string getHomeUrl ( ) | ||
return | 文字列 |
ホームページの URL |
---|
public function getHomeUrl()
{
if ($this->_homeUrl === null) {
if ($this->getUrlManager()->showScriptName) {
return $this->getRequest()->getScriptUrl();
}
return $this->getRequest()->getBaseUrl() . '/';
}
return $this->_homeUrl;
}
定義元: yii\base\Application::getI18n()
国際化 (i18n) コンポーネントを返します。
public yii\i18n\I18N getI18n ( ) | ||
return | yii\i18n\I18N |
国際化アプリケーションコンポーネント。 |
---|
public function getI18n()
{
return $this->get('i18n');
}
定義元: yii\base\Module::getInstance()
現在リクエストされているこのモジュールクラスのインスタンスを返します。
モジュールクラスが現在リクエストされていない場合は、null
が返されます。このメソッドは、モジュール内のどこからでもモジュールインスタンスにアクセスできるようにするために提供されています。
public static static|null getInstance ( ) | ||
return | yii\base\Module|null |
現在リクエストされているこのモジュールクラスのインスタンス。モジュールクラスがリクエストされていない場合は、 |
---|
public static function getInstance()
{
$class = get_called_class();
return isset(Yii::$app->loadedModules[$class]) ? Yii::$app->loadedModules[$class] : null;
}
定義元: yii\base\Module::getLayoutPath()
このモジュールのレイアウトビューファイルを含むディレクトリを返します。
public string getLayoutPath ( ) | ||
return | 文字列 |
レイアウトファイルのルートディレクトリ。デフォルトは "$viewPath/layouts" です。 |
---|
public function getLayoutPath()
{
if ($this->_layoutPath === null) {
$this->_layoutPath = $this->getViewPath() . DIRECTORY_SEPARATOR . 'layouts';
}
return $this->_layoutPath;
}
定義元: yii\base\Application::getLog()
ログディスパッチャーコンポーネントを返します。
public yii\log\Dispatcher getLog ( ) | ||
return | yii\log\Dispatcher |
ログディスパッチャーアプリケーションコンポーネント。 |
---|
public function getLog()
{
return $this->get('log');
}
定義元: yii\base\Application::getMailer()
メーラーコンポーネントを返します。
public yii\mail\MailerInterface getMailer ( ) | ||
return | yii\mail\MailerInterface |
メーラーアプリケーションコンポーネント。 |
---|---|---|
throws | yii\base\InvalidConfigException |
このコンポーネントが設定されていない場合。 |
public function getMailer()
{
return $this->get('mailer');
}
定義元: yii\base\Module::getModule()
指定されたIDの子モジュールを取得します。
このメソッドは、子モジュールと孫モジュールの両方の取得をサポートします。
以下も参照してください hasModule()。
public yii\base\Module|null getModule ( $id, $load = true ) | ||
$id | 文字列 |
モジュールID(大文字と小文字を区別)。孫モジュールを取得するには、このモジュールからの相対IDパスを使用します(例: |
$load | boolean |
まだロードされていない場合にモジュールをロードするかどうか。 |
return | yii\base\Module|null |
モジュールインスタンス。モジュールが存在しない場合は |
---|
public function getModule($id, $load = true)
{
if (($pos = strpos($id, '/')) !== false) {
// sub-module
$module = $this->getModule(substr($id, 0, $pos));
return $module === null ? null : $module->getModule(substr($id, $pos + 1), $load);
}
if (isset($this->_modules[$id])) {
if ($this->_modules[$id] instanceof self) {
return $this->_modules[$id];
} elseif ($load) {
Yii::debug("Loading module: $id", __METHOD__);
/* @var $module Module */
$module = Yii::createObject($this->_modules[$id], [$id, $this]);
$module::setInstance($module);
return $this->_modules[$id] = $module;
}
}
return null;
}
定義元: yii\base\Module::getModules()
このモジュール内のサブモジュールを返します。
public array getModules ( $loadedOnly = false ) | ||
$loadedOnly | boolean |
ロード済みのサブモジュールのみを返すかどうか。これを |
return | 配列 |
(IDでインデックスされた)モジュール。 |
---|
public function getModules($loadedOnly = false)
{
if ($loadedOnly) {
$modules = [];
foreach ($this->_modules as $module) {
if ($module instanceof self) {
$modules[] = $module;
}
}
return $modules;
}
return $this->_modules;
}
リクエストコンポーネントを返します。
public yii\web\Request getRequest ( ) | ||
return | yii\web\Request |
リクエストコンポーネント。 |
---|
public function getRequest()
{
return $this->get('request');
}
レスポンスコンポーネントを返します。
public yii\web\Response getResponse ( ) | ||
return | yii\web\Response |
レスポンスコンポーネント。 |
---|
public function getResponse()
{
return $this->get('response');
}
定義元: yii\base\Application::getRuntimePath()
ランタイムファイルを格納するディレクトリを返します。
public string getRuntimePath ( ) | ||
return | 文字列 |
ランタイムファイルを格納するディレクトリ。デフォルトは、$basePathの下の "runtime" サブディレクトリです。 |
---|
public function getRuntimePath()
{
if ($this->_runtimePath === null) {
$this->setRuntimePath($this->getBasePath() . DIRECTORY_SEPARATOR . 'runtime');
}
return $this->_runtimePath;
}
定義元: yii\base\Application::getSecurity()
セキュリティコンポーネントを返します。
public yii\base\Security getSecurity ( ) | ||
return | yii\base\Security |
セキュリティアプリケーションコンポーネント。 |
---|
public function getSecurity()
{
return $this->get('security');
}
セッションコンポーネントを返します。
public yii\web\Session getSession ( ) | ||
return | yii\web\Session |
セッションコンポーネント。 |
---|
public function getSession()
{
return $this->get('session');
}
定義元: yii\base\Application::getTimeZone()
このアプリケーションで使用されるタイムゾーンを返します。
これはPHP関数のdate_default_timezone_get()の単純なラッパーです。php.iniまたはアプリケーション設定でタイムゾーンが設定されていない場合、デフォルトでUTCに設定されます。
以下も参照してください https://www.php.net/manual/en/function.date-default-timezone-get.php。
public string getTimeZone ( ) | ||
return | 文字列 |
このアプリケーションで使用されるタイムゾーン。 |
---|
public function getTimeZone()
{
return date_default_timezone_get();
}
定義元: yii\base\Application::getUniqueId()
現在のアプリケーション内のすべてのモジュールの中で、このモジュールを一意に識別するIDを返します。
これはアプリケーションインスタンスであるため、常に空の文字列を返します。
public string getUniqueId ( ) | ||
return | 文字列 |
モジュールの一意のID。 |
---|
public function getUniqueId()
{
return '';
}
定義元: yii\base\Application::getUrlManager()
このアプリケーションのURLマネージャーを返します。
public yii\web\UrlManager getUrlManager ( ) | ||
return | yii\web\UrlManager |
このアプリケーションのURLマネージャー。 |
---|
public function getUrlManager()
{
return $this->get('urlManager');
}
ユーザーコンポーネントを返します。
public yii\web\User getUser ( ) | ||
return | yii\web\User |
ユーザーコンポーネント。 |
---|
public function getUser()
{
return $this->get('user');
}
定義元: yii\base\Application::getVendorPath()
ベンダーファイルを格納するディレクトリを返します。
public string getVendorPath ( ) | ||
return | 文字列 |
ベンダーファイルを格納するディレクトリ。デフォルトは、$basePathの下の "vendor" ディレクトリです。 |
---|
public function getVendorPath()
{
if ($this->_vendorPath === null) {
$this->setVendorPath($this->getBasePath() . DIRECTORY_SEPARATOR . 'vendor');
}
return $this->_vendorPath;
}
定義元: yii\base\Module::getVersion()
現在のモジュールバージョンを返します。
バージョンが明示的に設定されていない場合、その値を決定するために defaultVersion() メソッドが使用されます。
public string getVersion ( ) | ||
return | 文字列 |
このモジュールのバージョン。 |
---|
public function getVersion()
{
if ($this->_version === null) {
$this->_version = $this->defaultVersion();
} else {
if (!is_scalar($this->_version)) {
$this->_version = call_user_func($this->_version, $this);
}
}
return $this->_version;
}
定義元: yii\base\Application::getView()
ビューオブジェクトを返します。
public yii\base\View|yii\web\View getView ( ) | ||
return | yii\base\View|yii\web\View |
さまざまなビューファイルをレンダリングするために使用されるビューアプリケーションコンポーネント。 |
---|
public function getView()
{
return $this->get('view');
}
定義元: yii\base\Module::getViewPath()
このモジュールのビューファイルを含むディレクトリを返します。
public string getViewPath ( ) | ||
return | 文字列 |
ビューファイルのルートディレクトリ。デフォルトは "$basePath/views" です。 |
---|
public function getViewPath()
{
if ($this->_viewPath === null) {
$this->_viewPath = $this->getBasePath() . DIRECTORY_SEPARATOR . 'views';
}
return $this->_viewPath;
}
指定されたリクエストを処理します。
public yii\web\Response handleRequest ( $request ) | ||
$request | yii\web\Request |
処理されるリクエスト |
return | yii\web\Response |
結果として得られるレスポンス |
---|---|---|
throws | yii\web\NotFoundHttpException |
リクエストされたルートが無効な場合 |
public function handleRequest($request)
{
if (empty($this->catchAll)) {
try {
list($route, $params) = $request->resolve();
} catch (UrlNormalizerRedirectException $e) {
$url = $e->url;
if (is_array($url)) {
if (isset($url[0])) {
// ensure the route is absolute
$url[0] = '/' . ltrim($url[0], '/');
}
$url += $request->getQueryParams();
}
return $this->getResponse()->redirect(Url::to($url, $e->scheme), $e->statusCode);
}
} else {
$route = $this->catchAll[0];
$params = $this->catchAll;
unset($params[0]);
}
try {
Yii::debug("Route requested: '$route'", __METHOD__);
$this->requestedRoute = $route;
$result = $this->runAction($route, $params);
if ($result instanceof Response) {
return $result;
}
$response = $this->getResponse();
if ($result !== null) {
$response->data = $result;
}
return $response;
} catch (InvalidRouteException $e) {
throw new NotFoundHttpException(Yii::t('yii', 'Page not found.'), $e->getCode(), $e);
}
}
ロケーターが指定されたコンポーネント定義を持っているか、コンポーネントをインスタンス化したかどうかを示す値を返します。
バージョン 2.0.13 以降では、モジュールでコンポーネントが定義されていない場合、親モジュールで検索されます。親モジュールはアプリケーションの場合があります。
このメソッドは、$checkInstance
の値によって異なる結果を返す場合があります。
$checkInstance
が false (デフォルト) の場合、このメソッドは、ロケーターが指定されたコンポーネント定義を持っているかどうかを示す値を返します。$checkInstance
が true の場合、このメソッドは、ロケーターが指定されたコンポーネントをインスタンス化しているかどうかを示す値を返します。
public boolean has ( $id, $checkInstance = false ) | ||
$id | 文字列 |
コンポーネントID(例: |
$checkInstance | boolean |
メソッドが、コンポーネントが共有され、インスタンス化されているかどうかを確認する必要があるかどうか。 |
return | boolean |
ロケーターが指定されたコンポーネント定義を持っているか、またはコンポーネントをインスタンス化しているかどうか。 |
---|
public function has($id, $checkInstance = false)
{
return parent::has($id, $checkInstance) || (isset($this->module) && $this->module->has($id, $checkInstance));
}
定義元: yii\base\Component::hasEventHandlers()
指定された名前のイベントにハンドラーがアタッチされているかどうかを示す値を返します。
public boolean hasEventHandlers ( $name ) | ||
$name | 文字列 |
イベント名 |
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 | 文字列 |
プロパティ名 |
$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\Module::hasModule()
指定されたIDの子モジュールが存在するかどうかを確認します。
このメソッドは、子モジュールと孫モジュールの両方の存在の確認をサポートします。
public boolean hasModule ( $id ) | ||
$id | 文字列 |
モジュール ID。孫モジュールの場合、このモジュールに対する相対的な ID パスを使用します (例: |
return | boolean |
名前付きモジュールが存在するかどうか。ロード済みとアンロード済みの両方のモジュールが考慮されます。 |
---|
public function hasModule($id)
{
if (($pos = strpos($id, '/')) !== false) {
// sub-module
$module = $this->getModule(substr($id, 0, $pos));
return $module === null ? false : $module->hasModule(substr($id, $pos + 1));
}
return isset($this->_modules[$id]);
}
定義元: yii\base\Component::hasProperty()
このコンポーネントにプロパティが定義されているかどうかを示す値を返します。
プロパティが定義されているのは、
- クラスが指定された名前に関連付けられた getter または setter メソッドを持っている場合 (この場合、プロパティ名は大小文字を区別しません)。
- クラスに、指定された名前のメンバ変数がある場合(
$checkVars
が true の場合)。 - アタッチされたビヘイビアが、指定された名前のプロパティを持っている場合 (
$checkBehaviors
が true の場合)。
参照
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | 文字列 |
プロパティ名 |
$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);
}
定義元: yii\base\Application::init()
モジュールを初期化します。
このメソッドは、モジュールが作成され、構成で与えられたプロパティ値で初期化された後に呼び出されます。デフォルトの実装では、$controllerNamespace が設定されていない場合に初期化します。
このメソッドをオーバーライドする場合は、親の実装を必ず呼び出してください。
public void init ( ) |
public function init()
{
$this->state = self::STATE_INIT;
$this->bootstrap();
}
定義元: yii\base\Component::off()
このコンポーネントから既存のイベントハンドラーをデタッチします。
このメソッドは on() の反対です。
注: イベント名にワイルドカードパターンが渡された場合、このワイルドカードで登録されたハンドラーのみが削除され、このワイルドカードに一致するプレーン名で登録されたハンドラーは残ります。
関連情報: on()。
public boolean off ( $name, $handler = null ) | ||
$name | 文字列 |
イベント名 |
$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 | 文字列 |
イベント名 |
$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\base\Application::preInit()
アプリケーションを事前初期化します。
このメソッドは、アプリケーションのコンストラクタの開始時に呼び出されます。いくつかの重要なアプリケーションプロパティを初期化します。このメソッドをオーバーライドする場合は、親の実装を必ず呼び出してください。
public void preInit ( &$config ) | ||
$config | 配列 |
アプリケーションの構成 |
throws | yii\base\InvalidConfigException |
---|
public function preInit(&$config)
{
if (!isset($config['id'])) {
throw new InvalidConfigException('The "id" configuration for the Application is required.');
}
if (isset($config['basePath'])) {
$this->setBasePath($config['basePath']);
unset($config['basePath']);
} else {
throw new InvalidConfigException('The "basePath" configuration for the Application is required.');
}
if (isset($config['vendorPath'])) {
$this->setVendorPath($config['vendorPath']);
unset($config['vendorPath']);
} else {
// set "@vendor"
$this->getVendorPath();
}
if (isset($config['runtimePath'])) {
$this->setRuntimePath($config['runtimePath']);
unset($config['runtimePath']);
} else {
// set "@runtime"
$this->getRuntimePath();
}
if (isset($config['timeZone'])) {
$this->setTimeZone($config['timeZone']);
unset($config['timeZone']);
} elseif (!ini_get('date.timezone')) {
$this->setTimeZone('UTC');
}
if (isset($config['container'])) {
$this->setContainer($config['container']);
unset($config['container']);
}
// merge core components with custom components
foreach ($this->coreComponents() as $id => $component) {
if (!isset($config['components'][$id])) {
$config['components'][$id] = $component;
} elseif (is_array($config['components'][$id]) && !isset($config['components'][$id]['class'])) {
$config['components'][$id]['class'] = $component['class'];
}
}
}
定義元: yii\base\Application::registerErrorHandler()
errorHandlerコンポーネントをPHPエラーハンドラーとして登録します。
protected void registerErrorHandler ( &$config ) | ||
$config | 配列 |
アプリケーション構成 |
protected function registerErrorHandler(&$config)
{
if (YII_ENABLE_ERROR_HANDLER) {
if (!isset($config['components']['errorHandler']['class'])) {
echo "Error: no errorHandler component is configured.\n";
exit(1);
}
$this->set('errorHandler', $config['components']['errorHandler']);
unset($config['components']['errorHandler']);
$this->getErrorHandler()->register();
}
}
public integer run ( ) | ||
return | 整数 |
終了ステータス (0 は正常、0 以外の値は異常を意味します) |
---|
public function run()
{
try {
$this->state = self::STATE_BEFORE_REQUEST;
$this->trigger(self::EVENT_BEFORE_REQUEST);
$this->state = self::STATE_HANDLING_REQUEST;
$response = $this->handleRequest($this->getRequest());
$this->state = self::STATE_AFTER_REQUEST;
$this->trigger(self::EVENT_AFTER_REQUEST);
$this->state = self::STATE_SENDING_RESPONSE;
$response->send();
$this->state = self::STATE_END;
return $response->exitStatus;
} catch (ExitException $e) {
$this->end($e->statusCode, isset($response) ? $response : null);
return $e->statusCode;
}
}
定義元: yii\base\Module::runAction()
ルートによって指定されたコントローラーアクションを実行します。
このメソッドは、指定されたルートを解析し、対応する子モジュール、コントローラ、アクションのインスタンスを作成します。次に、yii\base\Controller::runAction() を呼び出して、指定されたパラメータでアクションを実行します。ルートが空の場合、このメソッドは $defaultRoute を使用します。
public mixed runAction ( $route, $params = [] ) | ||
$route | 文字列 |
アクションを指定するルート。 |
$params | 配列 |
アクションに渡されるパラメータ |
return | mixed |
アクションの結果。 |
---|---|---|
throws | yii\base\InvalidRouteException |
要求されたルートがアクションに正常に解決できない場合。 |
public function runAction($route, $params = [])
{
$parts = $this->createController($route);
if (is_array($parts)) {
/* @var $controller Controller */
list($controller, $actionID) = $parts;
$oldController = Yii::$app->controller;
Yii::$app->controller = $controller;
$result = $controller->runAction($actionID, $params);
if ($oldController !== null) {
Yii::$app->controller = $oldController;
}
return $result;
}
$id = $this->getUniqueId();
throw new InvalidRouteException('Unable to resolve the request "' . ($id === '' ? $route : $id . '/' . $route) . '".');
}
定義元: yii\di\ServiceLocator::set()
このロケーターにコンポーネント定義を登録します。
例:
// a class name
$locator->set('cache', 'yii\caching\FileCache');
// a configuration array
$locator->set('db', [
'class' => 'yii\db\Connection',
'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
'username' => 'root',
'password' => '',
'charset' => 'utf8',
]);
// an anonymous function
$locator->set('cache', function ($params) {
return new \yii\caching\FileCache;
});
// an instance
$locator->set('cache', new \yii\caching\FileCache);
同じ ID のコンポーネント定義が既に存在する場合、上書きされます。
public void set ( $id, $definition ) | ||
$id | 文字列 |
コンポーネントID(例: |
$definition | mixed |
このロケータに登録するコンポーネント定義。以下のいずれかになります。 |
throws | yii\base\InvalidConfigException |
定義が無効な設定配列の場合 |
---|
public function set($id, $definition)
{
unset($this->_components[$id]);
if ($definition === null) {
unset($this->_definitions[$id]);
return;
}
if (is_object($definition) || is_callable($definition, true)) {
// an object, a class name, or a PHP callable
$this->_definitions[$id] = $definition;
} elseif (is_array($definition)) {
// a configuration array
if (isset($definition['__class'])) {
$this->_definitions[$id] = $definition;
$this->_definitions[$id]['class'] = $definition['__class'];
unset($this->_definitions[$id]['__class']);
} elseif (isset($definition['class'])) {
$this->_definitions[$id] = $definition;
} else {
throw new InvalidConfigException("The configuration for the \"$id\" component must contain a \"class\" element.");
}
} else {
throw new InvalidConfigException("Unexpected configuration type for the \"$id\" component: " . gettype($definition));
}
}
定義元: yii\base\Module::setAliases()
パスエイリアスを定義します。
このメソッドは、Yii::setAlias() を呼び出してパスエイリアスを登録します。このメソッドは、モジュールを構成するときにパスエイリアスを定義できるようにするために提供されています。
public void setAliases ( $aliases ) | ||
$aliases | 配列 |
定義するパスエイリアスのリスト。配列のキーはエイリアス名 (
|
public function setAliases($aliases)
{
foreach ($aliases as $name => $alias) {
Yii::setAlias($name, $alias);
}
}
定義元: yii\base\Application::setBasePath()
アプリケーションのルートディレクトリと @app エイリアスを設定します。
このメソッドは、コンストラクタの開始時にのみ呼び出すことができます。
public void setBasePath ( $path ) | ||
$path | 文字列 |
アプリケーションのルートディレクトリ。 |
throws | yii\base\InvalidArgumentException |
ディレクトリが存在しない場合。 |
---|
public function setBasePath($path)
{
parent::setBasePath($path);
Yii::setAlias('@app', $this->getBasePath());
}
定義元: yii\di\ServiceLocator::setComponents()
このロケーターにコンポーネント定義のセットを登録します。
これは set() の一括バージョンです。パラメータは、キーがコンポーネント ID で、値が対応するコンポーネント定義である配列である必要があります。
コンポーネント ID と定義の指定方法の詳細については、set() を参照してください。
同じ ID のコンポーネント定義が既に存在する場合、上書きされます。
以下は、2 つのコンポーネント定義を登録する例です。
[
'db' => [
'class' => 'yii\db\Connection',
'dsn' => 'sqlite:path/to/file.db',
],
'cache' => [
'class' => 'yii\caching\DbCache',
'db' => 'db',
],
]
public void setComponents ( $components ) | ||
$components | 配列 |
コンポーネント定義またはインスタンス |
public function setComponents($components)
{
foreach ($components as $id => $component) {
$this->set($id, $component);
}
}
定義元: yii\base\Application::setContainer()
Yii::$container を $config で構成します。
public void setContainer ( $config ) | ||
$config | 配列 |
名前と値のペアで与えられた値 |
public function setContainer($config)
{
Yii::configure(Yii::$container, $config);
}
定義元: yii\base\Module::setControllerPath()
コントローラークラスを含むディレクトリを設定します。
public void setControllerPath ( $path ) | ||
$path | 文字列 |
コントローラクラスが含まれるルートディレクトリ。 |
throws | yii\base\InvalidArgumentException |
ディレクトリが無効な場合。 |
---|
public function setControllerPath($path)
{
$this->_controllerPath = Yii::getAlias($path);
}
public void setHomeUrl ( $value ) | ||
$value | 文字列 |
ホームページの URL |
public function setHomeUrl($value)
{
$this->_homeUrl = $value;
}
定義元: yii\base\Module::setInstance()
現在リクエストされているこのモジュールクラスのインスタンスを設定します。
public static void setInstance ( $instance ) | ||
$instance | yii\base\Module|null |
このモジュールクラスの現在リクエストされているインスタンス。これが |
public static function setInstance($instance)
{
if ($instance === null) {
unset(Yii::$app->loadedModules[get_called_class()]);
} else {
Yii::$app->loadedModules[get_class($instance)] = $instance;
}
}
定義元: yii\base\Module::setLayoutPath()
レイアウトファイルを含むディレクトリを設定します。
public void setLayoutPath ( $path ) | ||
$path | 文字列 |
レイアウトファイルのルートディレクトリまたはパスエイリアス。 |
throws | yii\base\InvalidArgumentException |
ディレクトリが無効な場合 |
---|
public function setLayoutPath($path)
{
$this->_layoutPath = Yii::getAlias($path);
}
定義元: yii\base\Module::setModule()
このモジュールにサブモジュールを追加します。
public void setModule ( $id, $module ) | ||
$id | 文字列 |
モジュールID。 |
$module | yii\base\Module|配列|null |
このモジュールに追加されるサブモジュール。以下を指定できます。
|
public function setModule($id, $module)
{
if ($module === null) {
unset($this->_modules[$id]);
} else {
$this->_modules[$id] = $module;
if ($module instanceof self) {
$module->module = $this;
}
}
}
定義元: yii\base\Module::setModules()
現在のモジュールにサブモジュールを登録します。
各サブモジュールは、名前と値のペアとして指定する必要があります。名前はモジュールのIDを参照し、値はモジュール、またはモジュールの作成に使用できる設定配列です。後者の場合、Yii::createObject() がモジュールを作成するために使用されます。
新しいサブモジュールが既存のモジュールと同じIDを持つ場合、既存のモジュールはサイレントに上書きされます。
以下は2つのサブモジュールを登録する例です
[
'comment' => [
'class' => 'app\modules\comment\CommentModule',
'db' => 'db',
],
'booking' => ['class' => 'app\modules\booking\BookingModule'],
]
public void setModules ( $modules ) | ||
$modules | 配列 |
モジュール (id => モジュール構成またはインスタンス)。 |
public function setModules($modules)
{
foreach ($modules as $id => $module) {
$this->_modules[$id] = $module;
if ($module instanceof self) {
$module->module = $this;
}
}
}
定義元: yii\base\Application::setRuntimePath()
ランタイムファイルを格納するディレクトリを設定します。
public void setRuntimePath ( $path ) | ||
$path | 文字列 |
ランタイムファイルを格納するディレクトリ。 |
public function setRuntimePath($path)
{
$this->_runtimePath = Yii::getAlias($path);
Yii::setAlias('@runtime', $this->_runtimePath);
}
定義元: yii\base\Application::setTimeZone()
このアプリケーションで使用されるタイムゾーンを設定します。
これはPHP関数 date_default_timezone_set() の簡単なラッパーです。利用可能なタイムゾーンについては、php manualを参照してください。
https://www.php.net/manual/en/function.date-default-timezone-set.php も参照してください。
public void setTimeZone ( $value ) | ||
$value | 文字列 |
このアプリケーションで使用されるタイムゾーン。 |
public function setTimeZone($value)
{
date_default_timezone_set($value);
}
定義元: yii\base\Application::setVendorPath()
ベンダーファイルを格納するディレクトリを設定します。
public void setVendorPath ( $path ) | ||
$path | 文字列 |
ベンダーファイルを格納するディレクトリ。 |
public function setVendorPath($path)
{
$this->_vendorPath = Yii::getAlias($path);
Yii::setAlias('@vendor', $this->_vendorPath);
Yii::setAlias('@bower', $this->_vendorPath . DIRECTORY_SEPARATOR . 'bower');
Yii::setAlias('@npm', $this->_vendorPath . DIRECTORY_SEPARATOR . 'npm');
}
定義元: yii\base\Module::setVersion()
現在のモジュールバージョンを設定します。
public void setVersion ( $version ) | ||
$version | 文字列|callable|null |
このモジュールのバージョン。バージョンは、引数としてモジュールインスタンスを受け取り、実際のバージョンを返す必要があるPHPコールバックとして指定できます。例:
|
public function setVersion($version)
{
$this->_version = $version;
}
定義: yii\base\Module::setViewPath()
ビューファイルを含むディレクトリを設定します。
public void setViewPath ( $path ) | ||
$path | 文字列 |
ビューファイルのルートディレクトリ。 |
throws | 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 | 文字列 |
イベント名 |
$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);
}
サインアップ または ログイン してコメントしてください。