抽象类 yii\log\Target
Target 是所有日志目标类的基类。
日志目标对象将根据其 $levels 和 $categories 属性过滤 yii\log\Logger 记录的消息。它还可以将过滤后的消息导出到目标定义的特定目的地,例如电子邮件、文件。
级别过滤器和类别过滤器是组合的,即只有满足这两个过滤条件的消息才会被处理。此外,您可以指定 $except 来排除某些类别的消息。
公有属性
属性 | 类型 | 描述 | 定义于 |
---|---|---|---|
$behaviors | yii\base\Behavior[] | 附加到此组件的行为列表。 | yii\base\Component |
$categories | array | 此目标感兴趣的消息类别列表。 | yii\log\Target |
$enabled | boolean | 指示此日志目标是否启用。 | yii\log\Target |
$except | array | 此目标**不**感兴趣的消息类别列表。 | yii\log\Target |
$exportInterval | integer | 在导出之前应累积多少条消息。 | yii\log\Target |
$levels | integer | 此目标感兴趣的消息级别。 | yii\log\Target |
$logVars | array | 应在消息中记录的 PHP 预定义变量列表。 | yii\log\Target |
$maskVars | array | 在记录时,应**不**以原样记录并应始终替换为掩码 *** 的 PHP 预定义变量列表(如果存在)。 |
yii\log\Target |
$messages | array | 迄今为止此日志目标从记录器检索到的消息。 | yii\log\Target |
$microtime | boolean | 是否以微秒记录时间。 | yii\log\Target |
$prefix | callable|null | 一个 PHP 可调用函数,返回要添加到每个导出消息之前的字符串。 | yii\log\Target |
公有方法
受保护方法
方法 | 描述 | 定义于 |
---|---|---|
getContextMessage() | 生成要记录的上下文信息。 | yii\log\Target |
getTime() | 返回消息的格式化('Y-m-d H:i:s')时间戳。 | yii\log\Target |
属性详情
此目标感兴趣的消息类别列表。默认为空,表示所有类别。您可以在类别的末尾使用星号,以便该类别可用于匹配共享相同公共前缀的那些类别。例如,'yii\db*' 将匹配以 'yii\db\' 开头的类别,例如 'yii\db\Connection'。
指示此日志目标是否已启用。默认为 true。请注意,此属性在 getter 和 setter 中的类型不同。有关详细信息,请参阅 getEnabled() 和 setEnabled()。
此目标**不感兴趣**的消息类别列表。默认为空,表示没有不感兴趣的消息。如果此属性不为空,则此处列出的任何类别都将从$categories中排除。您可以在类别的末尾使用星号,以便该类别可用于匹配共享相同公共前缀的那些类别。例如,'yii\db*' 将匹配以 'yii\db\' 开头的类别,例如 'yii\db\Connection'。
另请参阅 $categories。
在导出消息之前应累积的消息数。默认为 1000。请注意,应用程序终止时始终会导出消息。如果不想在应用程序终止之前导出消息,请将此属性设置为 0。
此目标感兴趣的消息级别。这是级别值的位图。默认为 0,表示所有可用级别。请注意,此属性在 getter 和 setter 中的类型不同。有关详细信息,请参见 getLevels() 和 setLevels()。
有关 Target 的更多详细信息和使用信息,请参阅 关于日志记录和目标的指南文章。
应在消息中记录的 PHP 预定义变量列表。请注意,必须可以通过 $GLOBALS
访问变量。否则不会记录。
默认为 ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION', '_SERVER']
。
从 2.0.9 版本开始,可以使用其他语法:每个元素可以指定为以下之一
var
- 将记录var
。var.key
- 只会记录var[key]
键。!var.key
- 将排除var[key]
键。
请注意,如果您需要记录 $_SESSION,无论是否使用了会话,您都必须在请求的开始处立即打开它。
在记录时,应**不**以原样记录并应始终替换为掩码 ***
的 PHP 预定义变量列表(如果存在)。
默认为 [ '_SERVER.HTTP_AUTHORIZATION', '_SERVER.PHP_AUTH_USER', '_SERVER.PHP_AUTH_PW']
每个元素可以指定为以下之一
var
-var
将记录为***
var.key
- 只有var[key]
将记录为***
到目前为止,此日志目标从记录器中检索到的消息。有关消息结构的详细信息,请参阅 yii\log\Logger::$messages。
一个 PHP 可调用函数,返回要添加到每个导出消息之前的字符串。
如果未设置,则将使用 getMessagePrefix(),它会在消息前加上上下文信息,例如用户 IP、用户 ID 和会话 ID。
可调用的签名应为 function ($message)
。
方法详情
定义于: yii\base\Component::__call()
调用不是类方法的命名方法。
此方法将检查任何附加的行为是否具有命名方法,如果可用,将执行它。
不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用它。
public 混合 __call ( $name, $params ) | ||
$name | 字符串 |
方法名称 |
$params | array |
方法参数 |
返回值 | 混合 |
方法返回值 |
---|---|---|
抛出 | 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 空 __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
定义于: yii\base\BaseObject::__construct()
构造函数。
默认实现执行两件事
- 使用给定的配置
$config
初始化对象。 - 调用 init()。
如果在子类中覆盖此方法,建议
- 构造函数的最后一个参数是一个配置数组,就像这里的
$config
一样。 - 在构造函数的末尾调用父实现。
public void __construct ( $config = [] ) | ||
$config | array |
用于初始化对象属性的键值对 |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定义于: yii\base\Component::__get()
返回组件属性的值。
此方法将按以下顺序检查并相应地执行
- 由 getter 定义的属性:返回 getter 的结果
- 行为的属性:返回行为属性的值
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $value = $component->property;
时会隐式调用。
另请参阅 __set()。
public mixed __get ( $name ) | ||
$name | 字符串 |
属性名称 |
返回值 | 混合 |
属性值或行为属性的值 |
---|---|---|
抛出 | 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。
此方法将按以下顺序检查并相应地执行
- 由 setter 定义的属性:返回属性是否已设置
- 行为的属性:返回属性是否已设置
- 对于不存在的属性,返回
false
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 isset($component->property)
时会隐式调用。
public boolean __isset ( $name ) | ||
$name | 字符串 |
属性名称或事件名称 |
返回值 | boolean |
命名的属性是否已设置 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name !== null;
}
}
return false;
}
定义于: yii\base\Component::__set()
设置组件属性的值。
此方法将按以下顺序检查并相应地执行
- 由 setter 定义的属性:设置属性值
- “on xyz”格式的事件:将处理程序附加到“xyz”事件
- “as xyz”格式的行为:附加名为“xyz”的行为
- 行为的属性:设置行为属性的值
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $component->property = $value;
时会隐式调用。
另请参阅 __get()。
public void __set ( $name, $value ) | ||
$name | 字符串 |
属性名称或事件名称 |
$value | 混合 |
属性值 |
抛出 | 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 | 字符串 |
属性名称 |
抛出 | 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\Component::attachBehavior()
将行为附加到此组件。
此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。
另请参阅 detachBehavior()。
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | 字符串 |
行为的名称。 |
$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\Component::behaviors()
返回此组件应表现为的行为列表。
子类可以重写此方法以指定它们想要表现为的行为。
此方法的返回值应为行为对象或配置的数组,这些对象或配置按行为名称索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
请注意,行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当使用名称作为数组键时,可以使用此名称,以后可以使用 getBehavior() 检索行为或使用 detachBehavior() 分离行为。无法检索或分离匿名行为。
在此方法中声明的行为将自动附加到组件(按需)。
public array behaviors ( ) | ||
返回值 | array |
行为配置。 |
---|
public function behaviors()
{
return [];
}
定义于: yii\base\Component::canGetProperty()
返回一个值,指示属性是否可读。
如果满足以下条件,则可以读取属性
- 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时); - 附加的行为具有给定名称的可读属性(当
$checkBehaviors
为 true 时)。
另请参阅 canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | 字符串 |
属性名称 |
$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 布尔型 canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | 字符串 |
属性名称 |
$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 字符串 className ( ) | ||
返回值 | 字符串 |
此类的完全限定名称。 |
---|
public static function className()
{
return get_called_class();
}
处理给定的日志消息。
此方法将使用 $levels 和 $categories 过滤给定的消息。如果需要,它还会将过滤结果导出到特定的媒介(例如电子邮件)。
public void collect ( $messages, $final ) | ||
$messages | array |
要处理的日志消息。有关每条消息的结构,请参见 yii\log\Logger::$messages。 |
$final | boolean |
此方法是否在当前应用程序结束时调用 |
public function collect($messages, $final)
{
$this->messages = array_merge($this->messages, static::filterMessages($messages, $this->getLevels(), $this->categories, $this->except));
$count = count($this->messages);
if ($count > 0 && ($final || $this->exportInterval > 0 && $count >= $this->exportInterval)) {
if (($context = $this->getContextMessage()) !== '') {
$this->messages[] = [$context, Logger::LEVEL_INFO, 'application', YII_BEGIN_TIME, [], 0];
}
// set exportInterval to 0 to avoid triggering export again while exporting
$oldExportInterval = $this->exportInterval;
$this->exportInterval = 0;
$this->export();
$this->exportInterval = $oldExportInterval;
$this->messages = [];
}
}
public yii\base\Behavior|空 detachBehavior ( $name ) | ||
$name | 字符串 |
行为的名称。 |
返回值 | yii\base\Behavior|空 |
已分离的行为。如果行为不存在,则为 null。 |
---|
public function detachBehavior($name)
{
$this->ensureBehaviors();
if (isset($this->_behaviors[$name])) {
$behavior = $this->_behaviors[$name];
unset($this->_behaviors[$name]);
$behavior->detach();
return $behavior;
}
return null;
}
定义于: yii\base\Component::detachBehaviors()
从组件中分离所有行为。
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);
}
}
}
将日志 $messages 导出到特定目的地。
子类必须实现此方法。
public abstract void export ( ) |
abstract public function export();
根据类别和级别过滤给定的消息。
public static 数组 filterMessages ( $messages, $levels = 0, $categories = [], $except = [] ) | ||
$messages | array |
要过滤的消息。消息结构遵循 yii\log\Logger::$messages 中的结构。 |
$levels | integer |
要按其过滤的消息级别。这是级别值的位图。值 0 表示允许所有级别。 |
$categories | array |
要按其过滤的消息类别。如果为空,则表示允许所有类别。 |
$except | array |
要排除的消息类别。如果为空,则表示允许所有类别。 |
返回值 | array |
已过滤的消息。 |
---|
public static function filterMessages($messages, $levels = 0, $categories = [], $except = [])
{
foreach ($messages as $i => $message) {
if ($levels && !($levels & $message[1])) {
unset($messages[$i]);
continue;
}
$matched = empty($categories);
foreach ($categories as $category) {
if ($message[2] === $category || !empty($category) && substr_compare($category, '*', -1, 1) === 0 && strpos($message[2], rtrim($category, '*')) === 0) {
$matched = true;
break;
}
}
if ($matched) {
foreach ($except as $category) {
$prefix = rtrim($category, '*');
if (($message[2] === $category || $prefix !== $category) && strpos($message[2], $prefix) === 0) {
$matched = false;
break;
}
}
}
if (!$matched) {
unset($messages[$i]);
}
}
return $messages;
}
格式化日志消息以显示为字符串。
public 字符串 formatMessage ( $message ) | ||
$message | array |
要格式化的日志消息。消息结构遵循 yii\log\Logger::$messages 中的结构。 |
返回值 | 字符串 |
已格式化的消息 |
---|
public function formatMessage($message)
{
list($text, $level, $category, $timestamp) = $message;
$level = Logger::getLevelName($level);
if (!is_string($text)) {
// exceptions may not be serializable if in the call stack somewhere is a Closure
if ($text instanceof \Exception || $text instanceof \Throwable) {
$text = (string) $text;
} else {
$text = VarDumper::export($text);
}
}
$traces = [];
if (isset($message[4])) {
foreach ($message[4] as $trace) {
$traces[] = "in {$trace['file']}:{$trace['line']}";
}
}
$prefix = $this->getMessagePrefix($message);
return $this->getTime($timestamp) . " {$prefix}[$level][$category] $text"
. (empty($traces) ? '' : "\n " . implode("\n ", $traces));
}
定义于: yii\base\Component::getBehavior()
返回命名的行为对象。
public yii\base\Behavior|空 getBehavior ( $name ) | ||
$name | 字符串 |
行为名称 |
返回值 | yii\base\Behavior|空 |
行为对象,如果行为不存在,则为 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;
}
生成要记录的上下文信息。
默认实现将转储用户信息、系统变量等。
protected 字符串 getContextMessage ( ) | ||
返回值 | 字符串 |
上下文信息。如果为空字符串,则表示没有上下文信息。 |
---|
protected function getContextMessage()
{
$context = ArrayHelper::filter($GLOBALS, $this->logVars);
foreach ($this->maskVars as $var) {
if (ArrayHelper::getValue($context, $var) !== null) {
ArrayHelper::setValue($context, $var, '***');
}
}
$result = [];
foreach ($context as $key => $value) {
$result[] = "\${$key} = " . VarDumper::dumpAsString($value);
}
return implode("\n\n", $result);
}
检查日志目标是否已启用。
public 布尔型 getEnabled ( ) | ||
返回值 | boolean |
一个值,指示此日志目标是否已启用。 |
---|
public function getEnabled()
{
if (is_callable($this->_enabled)) {
return call_user_func($this->_enabled, $this);
}
return $this->_enabled;
}
public integer getLevels ( ) | ||
返回值 | integer |
此目标感兴趣的消息级别。这是一个级别值的位图。默认为 0,表示所有可用级别。 |
---|
public function getLevels()
{
return $this->_levels;
}
返回要添加到给定消息之前的字符串。
如果配置了$prefix,它将返回回调的结果。默认实现将返回用户 IP、用户 ID 和会话 ID 作为前缀。
public string getMessagePrefix ( $message ) | ||
$message | array |
正在导出的消息。消息结构遵循yii\log\Logger::$messages中的结构。 |
返回值 | 字符串 |
前缀字符串 |
---|
public function getMessagePrefix($message)
{
if ($this->prefix !== null) {
return call_user_func($this->prefix, $message);
}
if (Yii::$app === null) {
return '';
}
$request = Yii::$app->getRequest();
$ip = $request instanceof Request ? $request->getUserIP() : '-';
/* @var $user \yii\web\User */
$user = Yii::$app->has('user', true) ? Yii::$app->get('user') : null;
if ($user && ($identity = $user->getIdentity(false))) {
$userID = $identity->getId();
} else {
$userID = '-';
}
/* @var $session \yii\web\Session */
$session = Yii::$app->has('session', true) ? Yii::$app->get('session') : null;
$sessionID = $session && $session->getIsActive() ? $session->getId() : '-';
return "[$ip][$userID][$sessionID]";
}
返回消息的格式化('Y-m-d H:i:s')时间戳。
如果将$microtime配置为 true,它将返回格式“Y-m-d H:i:s.u”。
protected string getTime ( $timestamp ) | ||
$timestamp | 浮点数 |
protected function getTime($timestamp)
{
$parts = explode('.', sprintf('%F', $timestamp));
return date('Y-m-d H:i:s', $parts[0]) . ($this->microtime ? ('.' . $parts[1]) : '');
}
定义于: yii\base\Component::hasEventHandlers()
返回一个值,指示是否有任何处理程序附加到命名的事件。
public boolean hasEventHandlers ( $name ) | ||
$name | 字符串 |
事件名称 |
返回值 | 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 |
是否将行为的方法视为此组件的方法 |
返回值 | 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 | 字符串 |
属性名称 |
$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()
{
}
定义于: yii\base\Component::off()
从此组件中分离现有的事件处理程序。
此方法与on()相反。
注意:如果为事件名称传递了通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。
另请参阅 on()。
public boolean off ( $name, $handler = null ) | ||
$name | 字符串 |
事件名称 |
$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 | 字符串 |
事件名称 |
$handler | 可调用 |
事件处理程序 |
$data | 混合 |
触发事件时要传递给事件处理程序的数据。当调用事件处理程序时,可以通过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]);
}
}
设置一个值,指示此日志目标是否已启用。
public void setEnabled ( $value ) | ||
$value | boolean|callable |
布尔值或用于获取值的回调函数。回调函数自版本 2.0.13 起可用。 可以使用回调函数以动态方式确定是否应启用日志目标。例如,要仅在当前用户登录时启用日志,您可以按如下方式配置目标
|
public function setEnabled($value)
{
$this->_enabled = $value;
}
设置此目标感兴趣的消息级别。
该参数可以是感兴趣的级别名称数组,也可以是表示感兴趣级别值的位图的整数。有效的级别名称包括:'error'、'warning'、'info'、'trace' 和 'profile';有效的级别值包括:yii\log\Logger::LEVEL_ERROR、yii\log\Logger::LEVEL_WARNING、yii\log\Logger::LEVEL_INFO、yii\log\Logger::LEVEL_TRACE 和 yii\log\Logger::LEVEL_PROFILE。
例如,
['error', 'warning']
// which is equivalent to:
Logger::LEVEL_ERROR | Logger::LEVEL_WARNING
public void setLevels ( $levels ) | ||
$levels | 数组|整数 |
此目标感兴趣的消息级别。 |
抛出 | yii\base\InvalidConfigException |
如果 $levels 值不正确。 |
---|
public function setLevels($levels)
{
static $levelMap = [
'error' => Logger::LEVEL_ERROR,
'warning' => Logger::LEVEL_WARNING,
'info' => Logger::LEVEL_INFO,
'trace' => Logger::LEVEL_TRACE,
'profile' => Logger::LEVEL_PROFILE,
];
if (is_array($levels)) {
$this->_levels = 0;
foreach ($levels as $level) {
if (isset($levelMap[$level])) {
$this->_levels |= $levelMap[$level];
} else {
throw new InvalidConfigException("Unrecognized level: $level");
}
}
} else {
$bitmapValues = array_reduce($levelMap, function ($carry, $item) {
return $carry | $item;
});
if (!($bitmapValues & $levels) && $levels !== 0) {
throw new InvalidConfigException("Incorrect $levels value");
}
$this->_levels = $levels;
}
}
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);
}
为了发表评论,请注册或登录。