类 yii\web\Application
Application 是所有 Web 应用类的基类。
有关 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,表示不使用 catch-all。
方法详情
定义于: 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()");
}
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
定义于: yii\base\Application::__construct()
构造函数。
public void __construct ( $config = [] ) | ||
$config | array | |
抛出异常 | 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);
}
public mixed __get ( $name ) | ||
$name | string |
组件或属性名称 |
返回值 | mixed |
指定的属性值 |
---|
public function __get($name)
{
if ($this->has($name)) {
return $this->get($name);
}
return parent::__get($name);
}
public boolean __isset ( $name ) | ||
$name | string |
属性名称或事件名称 |
返回值 | boolean |
属性值是否为 null |
---|
public function __isset($name)
{
if ($this->has($name)) {
return true;
}
return parent::__isset($name);
}
定义于: yii\base\Component::__set()
设置组件属性的值。
此方法将按以下顺序检查并相应地采取措施
- 由 setter 定义的属性:设置属性值
- “on xyz”格式的事件:将处理程序附加到“xyz”事件
- “as xyz”格式的行为:附加名为“xyz”的行为
- 行为的属性:设置行为属性值
不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $component->property = $value;
时会隐式调用。
另请参见 __get()。
public void __set ( $name, $value ) | ||
$name | string |
属性名称或事件名称 |
$value | mixed |
属性值 |
抛出异常 | 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。
此方法将按以下顺序检查并相应地采取措施
- 由 setter 定义的属性:将属性值设置为 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\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 |
操作的返回结果。 |
返回值 | 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);
}
}
定义于: 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 |
要执行的操作。 |
返回值 | 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 [];
}
初始化扩展并执行引导组件。
此方法由 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()
返回一个值,指示是否可以读取属性。
如果可以读取属性
- 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$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()
返回一个值,指示是否可以设置属性。
如果可以写入属性
- 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$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\di\ServiceLocator::clear()
从定位器中移除组件。
public void clear ( $id ) | ||
$id | string |
组件 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 | string |
由模块、控制器和操作 ID 组成的路由。 |
返回值 | array|boolean |
如果控制器创建成功,则将其与请求的操作 ID 一起返回。否则将返回 |
---|---|---|
抛出异常 | 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 | string |
控制器 ID。 |
返回值 | yii\base\Controller|null |
新创建的控制器实例,如果控制器 ID 无效则为 |
---|---|---|
抛出异常 | 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;
}
protected string defaultVersion ( ) | ||
返回值 | string |
此模块的版本。 |
---|
protected function defaultVersion()
{
if ($this->module === null) {
return '1.0';
}
return $this->module->getVersion();
}
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);
}
}
public void end ( $status = 0, $response = null ) | ||
$status | integer |
退出状态(值 0 表示正常退出,其他值表示异常退出)。 |
$response | yii\base\Response|null |
要发送的响应。如果未设置,将使用默认应用程序 $response 组件。 |
抛出异常 | 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);
}
}
}
public object|null get ( $id, $throwException = true ) | ||
$id | string |
组件 ID(例如 |
$throwException | boolean |
如果 |
返回值 | object|null |
指定 ID 的组件。如果 |
---|---|---|
抛出异常 | 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 ( ) | ||
返回值 | yii\web\AssetManager |
资产管理器应用组件。 |
---|
public function getAssetManager()
{
return $this->get('assetManager');
}
定义于: yii\base\Application::getAuthManager()
返回此应用程序的授权管理器。
public yii\rbac\ManagerInterface|null getAuthManager ( ) | ||
返回值 | yii\rbac\ManagerInterface|null |
授权管理器应用组件,如果未配置则为 null。 |
---|
public function getAuthManager()
{
return $this->get('authManager', false);
}
public string getBasePath ( ) | ||
返回值 | string |
模块的根目录。 |
---|
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 | 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\Application::getCache()
返回缓存组件。
public yii\caching\CacheInterface|null getCache ( ) | ||
返回值 | yii\caching\CacheInterface|null |
缓存应用程序组件。如果组件未启用,则为 null。 |
---|
public function getCache()
{
return $this->get('cache', false);
}
定义于: yii\di\ServiceLocator::getComponents()
返回组件定义或已加载的组件实例列表。
public array getComponents ( $returnDefinitions = true ) | ||
$returnDefinitions | boolean |
是否返回组件定义而不是加载的组件实例。 |
返回值 | array |
组件定义或已加载的组件实例列表(ID => 定义或实例)。 |
---|
public function getComponents($returnDefinitions = true)
{
return $returnDefinitions ? $this->_definitions : $this->_components;
}
定义于: yii\base\Module::getControllerPath()
根据 $controllerNamespace 返回包含控制器类的目录。
请注意,为了使此方法返回值,必须为 $controllerNamespace 的根命名空间定义一个别名。
public string getControllerPath ( ) | ||
返回值 | string |
包含控制器类的目录。 |
---|---|---|
抛出异常 | 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 ( ) | ||
返回值 | yii\db\Connection |
数据库连接。 |
---|
public function getDb()
{
return $this->get('db');
}
返回错误处理程序组件。
public yii\web\ErrorHandler getErrorHandler ( ) | ||
返回值 | yii\web\ErrorHandler |
错误处理程序应用组件。 |
---|
public function getErrorHandler()
{
return $this->get('errorHandler');
}
定义于: yii\base\Application::getFormatter()
返回格式化程序组件。
public yii\i18n\Formatter getFormatter ( ) | ||
返回值 | yii\i18n\Formatter |
格式化程序应用组件。 |
---|
public function getFormatter()
{
return $this->get('formatter');
}
public string getHomeUrl ( ) | ||
返回值 | string |
主页 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 ( ) | ||
返回值 | yii\i18n\I18N |
国际化应用组件。 |
---|
public function getI18n()
{
return $this->get('i18n');
}
public static static|null getInstance ( ) | ||
返回值 | 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 ( ) | ||
返回值 | string |
布局文件的根目录。默认为 "$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 ( ) | ||
返回值 | yii\log\Dispatcher |
日志调度程序应用组件。 |
---|
public function getLog()
{
return $this->get('log');
}
定义于: yii\base\Application::getMailer()
返回邮件发送器组件。
public yii\mail\MailerInterface getMailer ( ) | ||
返回值 | yii\mail\MailerInterface |
邮件发送器应用组件。 |
---|---|---|
抛出异常 | yii\base\InvalidConfigException |
如果此组件未配置。 |
public function getMailer()
{
return $this->get('mailer');
}
public yii\base\Module|null getModule ( $id, $load = true ) | ||
$id | string |
模块 ID(区分大小写)。要检索孙子模块,请使用相对于此模块的 ID 路径(例如 |
$load | boolean |
如果模块尚未加载,是否加载模块。 |
返回值 | 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 数组 getModules ( $loadedOnly = false ) | ||
$loadedOnly | boolean |
是否只返回已加载的子模块。如果设置为 |
返回值 | array |
模块(按其 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 ( ) | ||
返回值 | yii\web\Request |
请求组件。 |
---|
public function getRequest()
{
return $this->get('request');
}
返回响应组件。
public yii\web\Response getResponse ( ) | ||
返回值 | yii\web\Response |
响应组件。 |
---|
public function getResponse()
{
return $this->get('response');
}
定义于: yii\base\Application::getRuntimePath()
返回存储运行时文件的目录。
public 字符串 getRuntimePath ( ) | ||
返回值 | string |
存储运行时文件的目录。默认为 $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 ( ) | ||
返回值 | yii\base\Security |
安全应用组件。 |
---|
public function getSecurity()
{
return $this->get('security');
}
返回会话组件。
public yii\web\Session getSession ( ) | ||
返回值 | yii\web\Session |
会话组件。 |
---|
public function getSession()
{
return $this->get('session');
}
定义于: yii\base\Application::getTimeZone()
返回此应用程序使用的时间区域。
这是 PHP 函数 date_default_timezone_get() 的简单包装器。如果在 php.ini 或应用程序配置中未配置时区,则默认将其设置为 UTC。
另请参阅 https://php.ac.cn/manual/en/function.date-default-timezone-get.php。
public 字符串 getTimeZone ( ) | ||
返回值 | string |
此应用程序使用的时区。 |
---|
public function getTimeZone()
{
return date_default_timezone_get();
}
定义于: yii\base\Application::getUniqueId()
返回一个 ID,该 ID 在当前应用程序中的所有模块中唯一标识此模块。
由于这是一个应用程序实例,因此它将始终返回空字符串。
public 字符串 getUniqueId ( ) | ||
返回值 | string |
模块的唯一 ID。 |
---|
public function getUniqueId()
{
return '';
}
定义于: yii\base\Application::getUrlManager()
返回此应用程序的 URL 管理器。
public yii\web\UrlManager getUrlManager ( ) | ||
返回值 | yii\web\UrlManager |
此应用程序的 URL 管理器。 |
---|
public function getUrlManager()
{
return $this->get('urlManager');
}
返回用户组件。
public yii\web\User getUser ( ) | ||
返回值 | yii\web\User |
用户组件。 |
---|
public function getUser()
{
return $this->get('user');
}
定义于: yii\base\Application::getVendorPath()
返回存储供应商文件的目录。
public 字符串 getVendorPath ( ) | ||
返回值 | string |
存储供应商文件的目录。默认为 $basePath 下的 "vendor" 目录。 |
---|
public function getVendorPath()
{
if ($this->_vendorPath === null) {
$this->setVendorPath($this->getBasePath() . DIRECTORY_SEPARATOR . 'vendor');
}
return $this->_vendorPath;
}
public 字符串 getVersion ( ) | ||
返回值 | string |
此模块的版本。 |
---|
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 ( ) | ||
返回值 | yii\base\View|yii\web\View |
用于呈现各种视图文件的视图应用组件。 |
---|
public function getView()
{
return $this->get('view');
}
定义于: yii\base\Module::getViewPath()
返回包含此模块视图文件的目录。
public 字符串 getViewPath ( ) | ||
返回值 | string |
视图文件的根目录。默认为 "$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 |
要处理的请求 |
返回值 | yii\web\Response |
生成的响应 |
---|---|---|
抛出异常 | 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 | string |
组件 ID(例如 |
$checkInstance | boolean |
该方法是否应该检查组件是否已共享和实例化。 |
返回值 | 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 | 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;
}
public boolean hasModule ( $id ) | ||
$id | string |
模块 ID。对于孙子模块,请使用相对于此模块的 ID 路径(例如 |
返回值 | 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 | 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);
}
定义于: 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 | 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;
}
将事件处理程序附加到事件。
事件处理程序必须是有效的 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\base\Application::preInit()
预初始化应用程序。
此方法在应用程序构造函数开始时调用。它初始化几个重要的应用程序属性。如果覆盖此方法,请确保调用父类的实现。
public void preInit ( &$config ) | ||
$config | array |
应用程序配置 |
抛出异常 | 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 | array |
应用程序配置 |
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 ( ) | ||
返回值 | integer |
退出状态(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 | string |
指定操作的路由。 |
$params | array |
要传递给操作的参数 |
返回值 | mixed |
操作的结果。 |
---|---|---|
抛出异常 | 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 | string |
组件 ID(例如 |
$definition | mixed |
要与此定位器注册的组件定义。它可以是以下之一 |
抛出异常 | 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));
}
}
public void setAliases ( $aliases ) | ||
$aliases | array |
要定义的路径别名列表。数组键是别名名称(必须以
|
public function setAliases($aliases)
{
foreach ($aliases as $name => $alias) {
Yii::setAlias($name, $alias);
}
}
public void setBasePath ( $path ) | ||
$path | string |
应用程序的根目录。 |
抛出异常 | yii\base\InvalidArgumentException |
如果目录不存在。 |
---|
public function setBasePath($path)
{
parent::setBasePath($path);
Yii::setAlias('@app', $this->getBasePath());
}
定义于: yii\di\ServiceLocator::setComponents()
在此定位器中注册一组组件定义。
这是 set() 的批量版本。参数应为一个数组,其键为组件 ID,值对应组件定义。
有关如何指定组件 ID 和定义的更多详细信息,请参阅 set()。
如果已经存在具有相同 ID 的组件定义,它将被覆盖。
以下是注册两个组件定义的示例
[
'db' => [
'class' => 'yii\db\Connection',
'dsn' => 'sqlite:path/to/file.db',
],
'cache' => [
'class' => 'yii\caching\DbCache',
'db' => 'db',
],
]
public void setComponents ( $components ) | ||
$components | array |
组件定义或实例 |
public function setComponents($components)
{
foreach ($components as $id => $component) {
$this->set($id, $component);
}
}
定义于: yii\base\Application::setContainer()
使用 $config 配置 Yii::$container。
public void setContainer ( $config ) | ||
$config | array |
以名称-值对形式给出的值 |
public function setContainer($config)
{
Yii::configure(Yii::$container, $config);
}
定义于: yii\base\Module::setControllerPath()
设置包含控制器类的目录。
public void setControllerPath ( $path ) | ||
$path | string |
包含控制器类的根目录。 |
抛出异常 | yii\base\InvalidArgumentException |
如果目录无效。 |
---|
public function setControllerPath($path)
{
$this->_controllerPath = Yii::getAlias($path);
}
public void setHomeUrl ( $value ) | ||
$value | string |
主页 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 | string |
布局文件的根目录或路径别名。 |
抛出异常 | yii\base\InvalidArgumentException |
如果目录无效 |
---|
public function setLayoutPath($path)
{
$this->_layoutPath = Yii::getAlias($path);
}
定义于: yii\base\Module::setModule()
向此模块添加子模块。
public void setModule ( $id, $module ) | ||
$id | string |
模块 ID。 |
$module | yii\base\Module|数组|空 |
要添加到此模块的子模块。可以是以下之一:
|
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,则现有子模块将被静默覆盖。
以下是如何注册两个子模块的示例:
[
'comment' => [
'class' => 'app\modules\comment\CommentModule',
'db' => 'db',
],
'booking' => ['class' => 'app\modules\booking\BookingModule'],
]
public void setModules ( $modules ) | ||
$modules | array |
模块(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 | string |
存储运行时文件的目录。 |
public function setRuntimePath($path)
{
$this->_runtimePath = Yii::getAlias($path);
Yii::setAlias('@runtime', $this->_runtimePath);
}
定义于: yii\base\Application::setTimeZone()
设置此应用程序使用的时间区域。
这是 PHP 函数 date_default_timezone_set() 的简单包装器。有关可用时区的详细信息,请参阅PHP 手册。
另请参阅https://php.ac.cn/manual/en/function.date-default-timezone-set.php。
public void setTimeZone ( $value ) | ||
$value | string |
此应用程序使用的时区。 |
public function setTimeZone($value)
{
date_default_timezone_set($value);
}
定义于: yii\base\Application::setVendorPath()
设置存储供应商文件的目录。
public void setVendorPath ( $path ) | ||
$path | string |
存储供应商文件的目录。 |
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 | 字符串|可调用|空 |
此模块的版本。版本可以指定为 PHP 回调,它可以接受模块实例作为参数,并应返回实际版本。例如:
|
public function setVersion($version)
{
$this->_version = $version;
}
定义于: yii\base\Module::setViewPath()
设置包含视图文件的目录。
public void setViewPath ( $path ) | ||
$path | string |
视图文件的根目录。 |
抛出异常 | yii\base\InvalidArgumentException |
如果目录无效。 |
---|
public function setViewPath($path)
{
$this->_viewPath = Yii::getAlias($path);
}
public void trigger ( $name, yii\base\Event $event = null ) | ||
$name | string |
事件名称 |
$event | yii\base\Event|空 |
事件实例。如果未设置,将创建一个默认的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);
}
注册或登录以发表评论。