0 关注者

类 yii\log\Logger

继承yii\log\Logger » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/log/Logger.php

Logger 在内存中记录日志消息,如果 $dispatcher 设置,则将它们发送到不同的目标。

可以通过 Yii::getLogger() 访问 Logger 实例。您可以调用 log() 方法来记录单个日志消息。为了方便起见,提供了一组快捷方法,用于通过 Yii 类记录不同严重级别消息。

有关 Logger 的更多详细信息和用法信息,请参阅 关于日志记录的指南文章

当应用程序结束或 $flushInterval 到达时,Logger 将调用 flush() 将记录的日志消息发送到不同的日志目标,例如 文件电子邮件数据库,在 $dispatcher 的帮助下。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$dbEventNames array 用于获取数据库查询统计结果的事件名称。 yii\log\Logger
$dbProfiling array 第一个元素表示执行的 SQL 语句数量,第二个元素表示 SQL 执行的总时间。 yii\log\Logger
$dispatcher yii\log\Dispatcher 消息调度器。 yii\log\Logger
$elapsedTime float 当前请求的总耗时(秒)。 yii\log\Logger
$flushInterval integer 在将日志消息从内存刷新到目标之前应记录的消息数。 yii\log\Logger
$messages array 记录的日志消息。 yii\log\Logger
$profiling array 性能分析结果。 yii\log\Logger
$profilingAware boolean 是否应启用性能分析感知模式。 yii\log\Logger
$traceLevel integer 每个消息应记录的调用堆栈信息(文件名和行号)的量。 yii\log\Logger

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后调用。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即已定义且不为空。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应表现的行为列表。 yii\base\Component
calculateTimings() 计算给定日志消息的耗时。 yii\log\Logger
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
detachBehavior() 从组件分离行为。 yii\base\Component
detachBehaviors() 从组件分离所有行为。 yii\base\Component
ensureBehaviors() 确保 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
flush() 将日志消息从内存刷新到目标。 yii\log\Logger
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getDbProfiling() 返回数据库查询的统计结果。 yii\log\Logger
getElapsedTime() 返回从当前请求开始到现在的总耗时。 yii\log\Logger
getLevelName() 返回指定级别的文本显示。 yii\log\Logger
getProfiling() 返回性能分析结果。 yii\log\Logger
hasEventHandlers() 返回一个值,指示是否有名为 named 事件的任何处理程序附加到此组件。 yii\base\Component
hasMethod() 返回一个值,指示是否定义了方法。 yii\base\Component
hasProperty() 返回一个值,指示是否为此组件定义了属性。 yii\base\Component
init() 通过将 flush() 注册为关闭函数来初始化日志记录器。 yii\log\Logger
log() 使用给定的类型和类别记录消息。 yii\log\Logger
off() 从此组件分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
trigger() 触发事件。 yii\base\Component

常量

隐藏继承的常量

常量 描述 定义于
LEVEL_ERROR 0x1 错误消息级别。错误消息表示应用程序异常终止,可能需要开发人员处理。 yii\log\Logger
LEVEL_INFO 0x4 信息消息级别。信息消息表示包含开发人员需要查看的某些信息。 yii\log\Logger
LEVEL_PROFILE 0x40 性能分析消息级别。这表示消息用于性能分析目的。 yii\log\Logger
LEVEL_PROFILE_BEGIN 0x50 性能分析消息级别。这表示消息用于性能分析目的。它标记性能分析块的开始。 yii\log\Logger
LEVEL_PROFILE_END 0x60 性能分析消息级别。这表示消息用于性能分析目的。它标记性能分析块的结束。 yii\log\Logger
LEVEL_TRACE 0x8 跟踪消息级别。跟踪消息表示显示代码执行流程。 yii\log\Logger
LEVEL_WARNING 0x2 警告消息级别。警告消息表示发生了一些异常,但应用程序能够继续运行。开发人员应注意此消息。 yii\log\Logger

属性详细信息

隐藏继承的属性

$dbEventNames 公共属性 (自版本 2.0.41 起可用)

用于获取数据库查询统计结果的事件名称。

public array $dbEventNames = [
    
'yii\db\Command::query',
    
'yii\db\Command::execute',
]
$dbProfiling 公共属性

第一个元素表示执行的 SQL 语句数量,第二个元素表示 SQL 执行的总时间。

public array $dbProfiling null
$dispatcher 公共属性

消息调度器。

$elapsedTime 公共属性

当前请求的总耗时(秒)。

public float $elapsedTime null
$flushInterval 公共属性

在将日志消息从内存中刷新并发送到目标之前,应记录多少条消息。默认为 1000,这意味着 flush() 方法将在每记录 1000 条消息后调用一次。如果不想在应用程序终止之前刷新消息,请将此属性设置为 0。此属性主要影响记录的消息占用多少内存。较小的值意味着更少的内存,但由于 flush() 的开销,将增加执行时间。

public integer $flushInterval 1000
$messages 公共属性

记录的消息。此属性由 log()flush() 管理。每条日志消息都具有以下结构

[
  [0] => message (mixed, can be a string or some complex data, such as an exception object)
  [1] => level (integer)
  [2] => category (string)
  [3] => timestamp (float, obtained by microtime(true))
  [4] => traces (array, debug backtrace, contains the application code call stacks)
  [5] => memory usage in bytes (int, obtained by memory_get_usage()), available since version 2.0.11.
]
public array $messages = []
$profiling 公共属性

性能分析结果。每个元素都是一个数组,包含以下元素:infocategorytimestamptraceleveldurationmemorymemoryDiffmemorymemoryDiff 值从版本 2.0.11 开始可用。

public array $profiling null
$profilingAware 公共属性 (从版本 2.0.43 开始可用)

是否应启用性能分析感知模式。如果启用,flush() 确保性能分析块成对刷新。如果检测到任何悬挂消息,则保留这些消息以用于下一个刷新间隔,以查找其配对消息。为了防止内存泄漏,当悬挂消息的数量达到 flushInterval 值时,记录器会立即刷新这些消息并触发警告。请记住,性能分析感知模式会消耗更多时间和内存。

public boolean $profilingAware false
$traceLevel 公共属性

应为每条消息记录多少调用堆栈信息(文件名和行号)。如果大于 0,则最多记录该数量的调用堆栈。请注意,只计算应用程序调用堆栈。

public integer $traceLevel 0

方法详情

隐藏继承的方法

__call() 公共方法

定义于: 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()");
}

            
__clone() 公共方法

定义于: yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后调用。

它会删除所有行为,因为它们附加到旧对象。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公共方法

定义于: 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();
}

            
__get() 公共方法

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按以下顺序检查并相应地执行

  • 由 getter 定义的属性:返回 getter 结果
  • 行为的属性:返回行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $value = $component->property; 时会隐式调用。

另请参见 __set()

public mixed __get ( $name )
$name string

属性名称

返回值 mixed

属性值或行为属性的值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 yii\base\InvalidCallException

如果属性是只写属性。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() 公共方法

定义于: yii\base\Component::__isset()

检查属性是否已设置,即已定义且不为空。

此方法将按以下顺序检查并相应地执行

  • 通过 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性返回 false

不要直接调用此方法,因为它是一个 PHP 魔术方法,会在执行 isset($component->property) 时被隐式调用。

另见 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

属性名或事件名

返回值 boolean

命名属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公共方法

定义于: 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);
}

            
__unset() 公共方法

定义于: yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按以下顺序检查并相应地执行

  • 通过 setter 定义的属性:将属性值设置为 null
  • 行为的属性:将属性值设置为 null

不要直接调用此方法,因为它是一个 PHP 魔术方法,会在执行 unset($component->property) 时被隐式调用。

另见 https://php.ac.cn/manual/en/function.unset.php.

public void __unset ( $name )
$name string

属性名称

抛出 yii\base\InvalidCallException

如果属性是只读的。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
attachBehavior() 公共方法

定义于: 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);
}

            
attachBehaviors() 公共方法

定义于: 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);
    }
}

            
behaviors() 公共方法

定义于: yii\base\Component::behaviors()

返回此组件应表现的行为列表。

子类可以重写此方法以指定它们要执行的行为。

此方法的返回值应该是一个行为对象或配置的数组,这些对象或配置由行为名称索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意,行为类必须扩展自 yii\base\Behavior。行为可以使用名称或匿名方式附加。当使用名称作为数组键时,使用此名称,行为稍后可以使用 getBehavior() 检索,或使用 detachBehavior() 分离。匿名行为无法检索或分离。

在此方法中声明的行为将自动(按需)附加到组件。

public array behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
calculateTimings() 公共方法

计算给定日志消息的耗时。

public array calculateTimings ( $messages )
$messages array

从分析中获得的日志消息

返回值 array

计时。每个元素都是一个数组,包含以下元素:infocategorytimestamptraceleveldurationmemorymemoryDiffmemorymemoryDiff 值自版本 2.0.11 起可用。

                public function calculateTimings($messages)
{
    $timings = [];
    $stack = [];
    foreach ($messages as $i => $log) {
        list($token, $level, $category, $timestamp, $traces) = $log;
        $memory = isset($log[5]) ? $log[5] : 0;
        $log[6] = $i;
        $hash = md5(json_encode($token));
        if ($level == self::LEVEL_PROFILE_BEGIN) {
            $stack[$hash] = $log;
        } elseif ($level == self::LEVEL_PROFILE_END) {
            if (isset($stack[$hash])) {
                $timings[$stack[$hash][6]] = [
                    'info' => $stack[$hash][0],
                    'category' => $stack[$hash][2],
                    'timestamp' => $stack[$hash][3],
                    'trace' => $stack[$hash][4],
                    'level' => count($stack) - 1,
                    'duration' => $timestamp - $stack[$hash][3],
                    'memory' => $memory,
                    'memoryDiff' => $memory - (isset($stack[$hash][5]) ? $stack[$hash][5] : 0),
                ];
                unset($stack[$hash]);
            }
        }
    }
    ksort($timings);
    return array_values($timings);
}

            
canGetProperty() 公共方法

定义于: 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;
}

            
canSetProperty() 公共方法

定义于: yii\base\Component::canSetProperty()

返回一个值,指示是否可以设置属性。

如果属性可以写入

  • 该类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有具有指定名称的成员变量(当 $checkVars 为 true 时);
  • $checkBehaviors 为真时,附加的行为具有给定名称的可写属性。

另请参阅 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;
}

            
className() public static method
自 2.0.14 版开始弃用。在 PHP >=5.5 中,请使用 ::class 代替。

定义于: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

                public static function className()
{
    return get_called_class();
}

            
detachBehavior() public method

定义于: yii\base\Component::detachBehavior()

从组件分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。

返回值 yii\base\Behavior|null

已分离的行为。如果行为不存在,则为 null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public method

定义于: yii\base\Component::detachBehaviors()

从组件分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() public method

定义于: 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);
        }
    }
}

            
flush() public method

将日志消息从内存刷新到目标。

public void flush ( $final false )
$final boolean

这是否是请求期间的最终调用。

                public function flush($final = false)
{
    if ($this->profilingAware) {
        $keep = [];
        $messages = [];
        foreach ($this->messages as $index => $message) {
            if (is_int($index)) {
                $messages[] = $message;
            } else {
                if (strncmp($index, 'begin-', 6) === 0) {
                    $oppositeProfile = 'end-' . substr($index, 6);
                } else {
                    $oppositeProfile = 'begin-' . substr($index, 4);
                }
                if (array_key_exists($oppositeProfile, $this->messages)) {
                    $messages[] = $message;
                } else {
                    $keep[$index] = $message;
                }
            }
        }
        if ($this->flushInterval > 0 && count($keep) >= $this->flushInterval) {
            $this->messages = [];
            $this->log(
                'Number of dangling profiling block messages reached flushInterval value and therefore these were flushed. Please consider setting higher flushInterval value or making profiling blocks shorter.',
                self::LEVEL_WARNING
            );
            $messages = array_merge($messages, array_values($keep));
        } else {
            $this->messages = $keep;
        }
    } else {
        $messages = $this->messages;
        $this->messages = [];
    }
    if ($this->dispatcher instanceof Dispatcher) {
        $this->dispatcher->dispatch($messages, $final);
    }
}

            
getBehavior() public method

定义于: 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;
}

            
getBehaviors() public method

定义于: yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getDbProfiling() public method

返回数据库查询的统计结果。

返回的结果包括执行的 SQL 语句数量和花费的总时间。

public array getDbProfiling ( )
返回值 array

第一个元素表示执行的 SQL 语句数量,第二个元素表示 SQL 执行的总时间。

                public function getDbProfiling()
{
    $timings = $this->getProfiling($this->dbEventNames);
    $count = count($timings);
    $time = 0;
    foreach ($timings as $timing) {
        $time += $timing['duration'];
    }
    return [$count, $time];
}

            
getElapsedTime() public method

返回从当前请求开始到现在的总耗时。

此方法计算现在与由常量 YII_BEGIN_TIME 定义的时间戳之间的差值,该时间戳在 yii\BaseYii 类文件开头进行评估。

public float getElapsedTime ( )
返回值 float

当前请求的总耗时(秒)。

                public function getElapsedTime()
{
    return microtime(true) - YII_BEGIN_TIME;
}

            
getLevelName() public static method

返回指定级别的文本显示。

public static string getLevelName ( $level )
$level integer

消息级别,例如 LEVEL_ERRORLEVEL_WARNING

返回值 string

级别的文本显示

                public static function getLevelName($level)
{
    static $levels = [
        self::LEVEL_ERROR => 'error',
        self::LEVEL_WARNING => 'warning',
        self::LEVEL_INFO => 'info',
        self::LEVEL_TRACE => 'trace',
        self::LEVEL_PROFILE_BEGIN => 'profile begin',
        self::LEVEL_PROFILE_END => 'profile end',
        self::LEVEL_PROFILE => 'profile',
    ];
    return isset($levels[$level]) ? $levels[$level] : 'unknown';
}

            
getProfiling() public method

返回性能分析结果。

默认情况下,将返回所有性能分析结果。您可以提供 $categories$excludeCategories 作为参数来检索您感兴趣的结果。

public array getProfiling ( $categories = [], $excludeCategories = [] )
$categories array

您感兴趣的类别列表。您可以在类别末尾使用星号进行前缀匹配。例如,'yii\db*' 将匹配以 'yii\db\' 开头的类别,例如 'yii\db\Connection'。

$excludeCategories array

您要排除的类别列表

返回值 array

性能分析结果。每个元素都是一个数组,包含以下元素:infocategorytimestamptraceleveldurationmemorymemoryDiffmemorymemoryDiff 值从版本 2.0.11 开始可用。

                public function getProfiling($categories = [], $excludeCategories = [])
{
    $timings = $this->calculateTimings($this->messages);
    if (empty($categories) && empty($excludeCategories)) {
        return $timings;
    }
    foreach ($timings as $outerIndex => $outerTimingItem) {
        $currentIndex = $outerIndex;
        $matched = empty($categories);
        foreach ($categories as $category) {
            $prefix = rtrim($category, '*');
            if (
                ($outerTimingItem['category'] === $category || $prefix !== $category)
                && strpos($outerTimingItem['category'], $prefix) === 0
            ) {
                $matched = true;
                break;
            }
        }
        if ($matched) {
            foreach ($excludeCategories as $category) {
                $prefix = rtrim($category, '*');
                foreach ($timings as $innerIndex => $innerTimingItem) {
                    $currentIndex = $innerIndex;
                    if (
                        ($innerTimingItem['category'] === $category || $prefix !== $category)
                        && strpos($innerTimingItem['category'], $prefix) === 0
                    ) {
                        $matched = false;
                        break;
                    }
                }
            }
        }
        if (!$matched) {
            unset($timings[$currentIndex]);
        }
    }
    return array_values($timings);
}

            
hasEventHandlers() public method

定义于: yii\base\Component::hasEventHandlers()

返回一个值,指示是否有名为 named 事件的任何处理程序附加到此组件。

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);
}

            
hasMethod() 公共方法

定义于: 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;
}

            
hasProperty() 公共方法

定义于: 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);
}

            
init() 公共方法

通过将 flush() 注册为关闭函数来初始化日志记录器。

public void init ( )

                public function init()
{
    parent::init();
    register_shutdown_function(function () {
        // make regular flush before other shutdown functions, which allows session data collection and so on
        $this->flush();
        // make sure log entries written by shutdown functions are also flushed
        // ensure "flush()" is called last when there are multiple shutdown functions
        register_shutdown_function([$this, 'flush'], true);
    });
}

            
log() 公共方法

使用给定的类型和类别记录消息。

如果 $traceLevel 大于 0,则会记录有关应用程序代码的其他调用堆栈信息。

public void log ( $message, $level, $category 'application' )
$message string|array

要记录的消息。这可以是一个简单的字符串或一个更复杂的数据结构,它将由 日志目标 处理。

$level integer

消息的级别。这必须是以下之一:Logger::LEVEL_ERRORLogger::LEVEL_WARNINGLogger::LEVEL_INFOLogger::LEVEL_TRACELogger::LEVEL_PROFILELogger::LEVEL_PROFILE_BEGINLogger::LEVEL_PROFILE_END

$category string

消息的类别。

                public function log($message, $level, $category = 'application')
{
    $time = microtime(true);
    $traces = [];
    if ($this->traceLevel > 0) {
        $count = 0;
        $ts = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
        array_pop($ts); // remove the last trace since it would be the entry script, not very useful
        foreach ($ts as $trace) {
            if (isset($trace['file'], $trace['line']) && strpos($trace['file'], YII2_PATH) !== 0) {
                unset($trace['object'], $trace['args']);
                $traces[] = $trace;
                if (++$count >= $this->traceLevel) {
                    break;
                }
            }
        }
    }
    $data = [$message, $level, $category, $time, $traces, memory_get_usage()];
    if ($this->profilingAware && in_array($level, [self::LEVEL_PROFILE_BEGIN, self::LEVEL_PROFILE_END])) {
        $this->messages[($level == self::LEVEL_PROFILE_BEGIN ? 'begin-' : 'end-') . md5(json_encode($message))] = $data;
    } else {
        $this->messages[] = $data;
    }
    if ($this->flushInterval > 0 && count($this->messages) >= $this->flushInterval) {
        $this->flush();
    }
}

            
off() 公共方法

定义于: yii\base\Component::off()

从此组件分离现有的事件处理程序。

此方法与 on() 相反。

注意:如果为事件名称传递了通配符模式,则只会删除使用此通配符注册的处理程序,而使用与此通配符匹配的普通名称注册的处理程序将保留。

另见 on().

public boolean off ( $name, $handler null )
$name string

事件名称

$handler callable|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;
}

            
on() 公共方法

定义于: yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是一个有效的 PHP 回调。以下是一些示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义,

function ($event)

其中 $event 是一个 yii\base\Event 对象,其中包含与事件关联的参数。

从 2.0.14 开始,您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另见 off().

public void on ( $name, $handler, $data null, $append true )
$name string

事件名称

$handler callable

事件处理程序

$data mixed

触发事件时要传递给事件处理程序的数据。当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append boolean

是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 false,则新的处理程序将被插入到现有处理程序列表的开头。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序,包括类级别处理程序。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名称

$event yii\base\Event|null

事件实例。如果未设置,将创建一个默认的 yii\base\Event 对象。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}