0 關注者

類別 yii\log\DbTarget

繼承關係yii\log\DbTarget » yii\log\Target » yii\base\Component » yii\base\BaseObject
實作介面yii\base\Configurable
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/log/DbTarget.php

DbTarget 將日誌訊息儲存在資料庫表格中。

資料庫連線由 $db 指定。資料庫結構描述可以透過套用遷移來初始化

yii migrate --migrationPath=@yii/log/migrations/

如果您不想使用遷移,而是需要 SQL,則所有資料庫的檔案都位於 migrations 目錄中。

您可以透過設定 $logTable 來變更用於儲存資料的表格名稱。

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$categories array 此目標感興趣的訊息類別列表。 yii\log\Target
$db yii\db\Connection|array|string DB 連線物件或 DB 連線的應用程式組件 ID。 yii\log\DbTarget
$enabled boolean 指示是否啟用此日誌目標。 yii\log\Target
$except array 此目標不感興趣的訊息類別列表。 yii\log\Target
$exportInterval integer 在匯出之前應累積多少訊息。 yii\log\Target
$levels integer 此目標感興趣的訊息層級。 yii\log\Target
$logTable string 用於儲存快取內容的 DB 表格名稱。 yii\log\DbTarget
$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 callable,會傳回一個字串,作為每個匯出訊息的前綴。 yii\log\Target

Public Methods (公用方法)

Hide inherited methods (隱藏繼承的方法)

Method (方法) 描述 定義於
__call() 呼叫未定義為類別方法的具名方法。 yii\base\Component
__clone() 在透過複製現有物件建立物件後,會呼叫此方法。 yii\base\Component
__construct() 建構子。 yii\base\BaseObject
__get() 傳回元件屬性的值。 yii\base\Component
__isset() 檢查屬性是否已設定,亦即已定義且非 null。 yii\base\Component
__set() 設定元件屬性的值。 yii\base\Component
__unset() 將元件屬性設定為 null。 yii\base\Component
attachBehavior() 將行為附加到此元件。 yii\base\Component
attachBehaviors() 將行為清單附加到此元件。 yii\base\Component
behaviors() 傳回此元件應表現為哪些行為的清單。 yii\base\Component
canGetProperty() 傳回一個值,指出屬性是否可讀取。 yii\base\Component
canSetProperty() 傳回一個值,指出屬性是否可設定。 yii\base\Component
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
collect() 處理給定的記錄訊息。 yii\log\Target
detachBehavior() 從元件分離行為。 yii\base\Component
detachBehaviors() 從元件分離所有行為。 yii\base\Component
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此元件。 yii\base\Component
export() 將記錄訊息儲存到資料庫。 yii\log\DbTarget
filterMessages() 根據訊息的類別和層級篩選給定的訊息。 yii\log\Target
formatMessage() 格式化記錄訊息,以便顯示為字串。 yii\log\Target
getBehavior() 傳回具名的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此元件的所有行為。 yii\base\Component
getEnabled() 檢查記錄目標是否已啟用。 yii\log\Target
getLevels() yii\log\Target
getMessagePrefix() 傳回要作為給定訊息前綴的字串。 yii\log\Target
hasEventHandlers() 傳回一個值,指出是否已附加任何處理常式到具名事件。 yii\base\Component
hasMethod() 傳回一個值,指出是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指出是否已為此元件定義屬性。 yii\base\Component
init() 初始化 DbTarget 元件。 yii\log\DbTarget
off() 從此元件分離現有的事件處理常式。 yii\base\Component
on() 將事件處理常式附加到事件。 yii\base\Component
setEnabled() 設定一個值,指出是否已啟用此記錄目標。 yii\log\Target
setLevels() 設定此目標感興趣的訊息層級。 yii\log\Target
trigger() 觸發事件。 yii\base\Component

Protected Methods (受保護的方法)

Hide inherited methods (隱藏繼承的方法)

Method (方法) 描述 定義於
getContextMessage() 產生要記錄的內容資訊。 yii\log\Target
getTime() 傳回訊息的格式化時間戳記 ('Y-m-d H:i:s')。 yii\log\Target

Property Details (屬性詳細資訊)

隱藏繼承的屬性

$db public property (公用屬性)

DB 連線物件或 DB 連線的應用程式元件 ID。在建立 DbTarget 物件後,如果您想要變更此屬性,則應僅將 DB 連線物件指派給它。從 2.0.2 版開始,這也可以是建立物件的組態陣列。

$logTable public property (公用屬性)

用於儲存快取內容的 DB 資料表名稱。預設為 "log"。

public string $logTable '{{%log}}'

Method Details (方法詳細資訊)

Hide inherited methods (隱藏繼承的方法)

__call() public method (公用方法)

Defined in: (定義於:) yii\base\Component::__call()

呼叫未定義為類別方法的具名方法。

此方法將檢查是否有任何附加的行為具有具名方法,並在可用的情況下執行它。

請勿直接呼叫此方法,因為它是 PHP 魔術方法,會在叫用未知方法時隱含地呼叫它。

public mixed __call ( $name, $params )
$name string

方法名稱

$params array

方法參數

return (傳回) mixed

方法傳回值

throws (拋出) yii\base\UnknownMethodException

當呼叫未知方法時

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() public method (公用方法)

Defined in: (定義於:) yii\base\Component::__clone()

在透過複製現有物件建立物件後,會呼叫此方法。

它會移除所有行為,因為這些行為附加到舊的物件。

public void __clone ( )

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

            
__construct() public method (公用方法)

Defined in: (定義於:) 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() public method (公用方法)

Defined in: (定義於:) yii\base\Component::__get()

傳回元件屬性的值。

此方法將依以下順序檢查並採取相應動作

  • getter 定義的屬性:傳回 getter 結果
  • 行為的屬性:傳回行為屬性值

請勿直接呼叫此方法,因為它是 PHP 魔術方法,會在執行 $value = $component->property; 時隱含地呼叫它。

另請參閱 __set()

public mixed __get ( $name )
$name string

屬性名稱

return (傳回) mixed

屬性值或行為屬性的值

throws (拋出) yii\base\UnknownPropertyException

如果未定義屬性

throws (拋出) 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() public method (公用方法)

Defined in: (定義於:) yii\base\Component::__isset()

檢查屬性是否已設定,亦即已定義且非 null。

此方法將依以下順序檢查並採取相應動作

  • setter 定義的屬性:傳回屬性是否已設定
  • 行為的屬性:傳回屬性是否已設定
  • 針對不存在的屬性傳回 false

請勿直接呼叫此方法,因為它是 PHP 魔術方法,會在執行 isset($component->property) 時隱含地呼叫它。

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱

return (傳回) 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() public method (公用方法)

Defined in: (定義於:) 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

屬性值

throws (拋出) yii\base\UnknownPropertyException

如果未定義屬性

throws (拋出) yii\base\InvalidCallException

如果屬性為唯讀。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() public method (公用方法)

Defined in: (定義於:) yii\base\Component::__unset()

將元件屬性設定為 null。

此方法將依以下順序檢查並採取相應動作

  • setter 定義的屬性:將屬性值設定為 null
  • 行為的屬性:將屬性值設定為 null

請勿直接呼叫此方法,因為它是 PHP 魔術方法,會在執行 unset($component->property) 時隱含地呼叫它。

另請參閱 https://php.dev.org.tw/manual/en/function.unset.php

public void __unset ( $name )
$name string

屬性名稱

throws (拋出) yii\base\InvalidCallException

如果屬性為唯讀。

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

            
attachBehavior() public method (公用方法)

Defined in: (定義於:) yii\base\Component::attachBehavior()

將行為附加到此元件。

此方法將根據給定的組態建立行為物件。之後,將透過呼叫 yii\base\Behavior::attach() 方法將行為物件附加到此元件。

另請參閱 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行為的名稱。

$behavior string|array|yii\base\Behavior

行為組態。這可以是下列其中之一

return (傳回) yii\base\Behavior

行為物件

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method (公用方法)

Defined in: (定義於:) 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() public method (公用方法)

Defined in: (定義於:) yii\base\Component::behaviors()

傳回此元件應表現為哪些行為的清單。

子類別可能會覆寫此方法,以指定它們想要表現為哪些行為。

此方法的傳回值應為行為物件或組態的陣列,以行為名稱編製索引。行為組態可以是指定行為類別的字串,或是以下結構的陣列

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

請注意,行為類別必須從 yii\base\Behavior 延伸。行為可以使用名稱或匿名方式附加。當使用名稱作為陣列索引鍵時,使用此名稱,稍後可以使用 getBehavior() 擷取行為,或使用 detachBehavior() 分離行為。匿名行為無法擷取或分離。

在此方法中宣告的行為將自動(依需求)附加到元件。

public array behaviors ( )
return (傳回) array

行為組態。

                public function behaviors()
{
    return [];
}

            
canGetProperty() public method (公用方法)

Defined in: (定義於:) yii\base\Component::canGetProperty()

傳回一個值,指出屬性是否可讀取。

如果符合以下條件,則屬性可以讀取

  • 類別具有與指定名稱關聯的 getter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可讀屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return (傳回) boolean

屬性是否可讀取

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() public method (公用方法)

Defined in: (定義於:) yii\base\Component::canSetProperty()

傳回一個值,指出屬性是否可設定。

如果符合以下條件,則屬性可以寫入

  • 類別具有與指定名稱關聯的 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可寫屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return (傳回) boolean

屬性是否可寫入

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() public static method (公用靜態方法)
自 2.0.14 版起已淘汰。在 PHP >=5.5 上,請改用 ::class

Defined in: (定義於:) yii\base\BaseObject::className()

傳回此類別的完整限定名稱。

public static string className ( )
return (傳回) string

此類別的完整限定名稱。

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

            
collect() public method (公用方法)

Defined in: (定義於:) yii\log\Target::collect()

處理給定的記錄訊息。

此方法將使用 $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 = [];
    }
}

            
detachBehavior() public method (公用方法)

Defined in: (定義於:) yii\base\Component::detachBehavior()

從元件分離行為。

將叫用行為的 yii\base\Behavior::detach() 方法。

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

行為的名稱。

return (傳回) yii\base\Behavior|null

已分離的行為。如果行為不存在,則為 Null。

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

            
detachBehaviors() public method (公用方法)

Defined in: (定義於:) yii\base\Component::detachBehaviors()

從元件分離所有行為。

public void detachBehaviors ( )

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

            
ensureBehaviors() public method (公用方法)

Defined in: (定義於:) 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);
        }
    }
}

            
export() public method (公用方法)

將記錄訊息儲存到資料庫。

從 2.0.14 版開始,如果無法匯出記錄,此方法會擲回 LogRuntimeException。

public void export ( )
throws (拋出) yii\db\Exception
throws (拋出) yii\log\LogRuntimeException

                public function export()
{
    if ($this->db->getTransaction()) {
        // create new database connection, if there is an open transaction
        // to ensure insert statement is not affected by a rollback
        $this->db = clone $this->db;
    }
    $tableName = $this->db->quoteTableName($this->logTable);
    $sql = "INSERT INTO $tableName ([[level]], [[category]], [[log_time]], [[prefix]], [[message]])
            VALUES (:level, :category, :log_time, :prefix, :message)";
    $command = $this->db->createCommand($sql);
    foreach ($this->messages as $message) {
        list($text, $level, $category, $timestamp) = $message;
        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);
            }
        }
        if (
            $command->bindValues([
                ':level' => $level,
                ':category' => $category,
                ':log_time' => $timestamp,
                ':prefix' => $this->getMessagePrefix($message),
                ':message' => $text,
            ])->execute() > 0
        ) {
            continue;
        }
        throw new LogRuntimeException('Unable to export log through database!');
    }
}

            
filterMessages() public static method (公用靜態方法)

Defined in: (定義於:) yii\log\Target::filterMessages()

根據訊息的類別和層級篩選給定的訊息。

public static array filterMessages ( $messages, $levels 0, $categories = [], $except = [] )
$messages array

要篩選的訊息。訊息結構遵循 yii\log\Logger::$messages 中的結構。

$levels integer

要依訊息層級篩選。這是層級值的位元遮罩。值 0 表示允許所有層級。

$categories array

要依訊息類別篩選。如果為空,則表示允許所有類別。

$except array

要排除的訊息類別。如果為空,則表示允許所有類別。

return (傳回) 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;
}

            
formatMessage() public method (公用方法)

Defined in: (定義於:) yii\log\Target::formatMessage()

格式化記錄訊息,以便顯示為字串。

public string formatMessage ( $message )
$message array

要格式化的記錄訊息。訊息結構遵循 yii\log\Logger::$messages 中的結構。

return (傳回) string

格式化後的訊息

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

            
getBehavior() public method

Defined in: yii\base\Component::getBehavior()

傳回具名的行為物件。

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

行為名稱

return (傳回) yii\base\Behavior|null

行為物件,如果行為不存在則為 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

Defined in: yii\base\Component::getBehaviors()

傳回附加到此元件的所有行為。

public yii\base\Behavior[] getBehaviors ( )
return (傳回) yii\base\Behavior[]

附加到此組件的行為列表

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

            
getContextMessage() protected method

Defined in: yii\log\Target::getContextMessage()

產生要記錄的內容資訊。

預設實作將會傾印使用者資訊、系統變數等等。

protected string getContextMessage ( )
return (傳回) string

上下文資訊。如果是空字串,表示沒有上下文資訊。

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

            
getEnabled() public method

Defined in: yii\log\Target::getEnabled()

檢查記錄目標是否已啟用。

public boolean getEnabled ( )
return (傳回) boolean

一個值,指示此日誌目標是否已啟用。

                public function getEnabled()
{
    if (is_callable($this->_enabled)) {
        return call_user_func($this->_enabled, $this);
    }
    return $this->_enabled;
}

            
getLevels() public method
public integer getLevels ( )
return (傳回) integer

此目標感興趣的訊息層級。這是一個層級值的位元圖。預設為 0,表示所有可用的層級。

                public function getLevels()
{
    return $this->_levels;
}

            
getMessagePrefix() public method

Defined in: yii\log\Target::getMessagePrefix()

傳回要作為給定訊息前綴的字串。

如果設定了 $prefix,它將返回回呼的結果。預設實作將返回使用者 IP、使用者 ID 和 session ID 作為前綴。

public string getMessagePrefix ( $message )
$message array

正在匯出的訊息。訊息結構遵循 yii\log\Logger::$messages 中的結構。

return (傳回) string

前綴字串

                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]";
}

            
getTime() protected method (available since version 2.0.13)

Defined in: yii\log\Target::getTime()

傳回訊息的格式化時間戳記 ('Y-m-d H:i:s')。

如果 $microtime 設定為 true,它將返回 'Y-m-d H:i:s.u' 格式。

protected string getTime ( $timestamp )
$timestamp float

                protected function getTime($timestamp)
{
    $parts = explode('.', sprintf('%F', $timestamp));
    return date('Y-m-d H:i:s', $parts[0]) . ($this->microtime ? ('.' . $parts[1]) : '');
}

            
hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

傳回一個值,指出是否已附加任何處理常式到具名事件。

public boolean hasEventHandlers ( $name )
$name string

事件名稱

return (傳回) boolean

是否有任何處理程序附加到事件。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

Defined in: yii\base\Component::hasMethod()

傳回一個值,指出是否已定義方法。

如果滿足以下條件,則定義方法

  • 類別具有指定名稱的方法
  • 附加的行為具有給定名稱的方法 (當 $checkBehaviors 為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

屬性名稱

$checkBehaviors boolean

是否將行為的方法視為此組件的方法

return (傳回) boolean

方法是否已定義

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

Defined in: yii\base\Component::hasProperty()

傳回一個值,指出是否已為此元件定義屬性。

如果滿足以下條件,則定義屬性

  • 類別具有與指定名稱相關聯的 getter 或 setter 方法 (在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的屬性 (當 $checkBehaviors 為 true 時)。

另請參閱

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return (傳回) boolean

屬性是否已定義

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method

初始化 DbTarget 元件。

此方法將初始化 $db 屬性,以確保它引用有效的 DB 連線。

public void init ( )
throws (拋出) yii\base\InvalidConfigException

如果 $db 無效。

                public function init()
{
    parent::init();
    $this->db = Instance::ensure($this->db, Connection::className());
}

            
off() public method

Defined in: yii\base\Component::off()

從此元件分離現有的事件處理常式。

此方法與 on() 相反。

注意:如果為事件名稱傳遞了萬用字元模式,則只會移除使用此萬用字元註冊的處理程序,而使用符合此萬用字元的一般名稱註冊的處理程序將會保留。

另請參閱 on()

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

事件名稱

$handler callable|null

要移除的事件處理程序。如果為 null,則將移除附加到命名事件的所有處理程序。

return (傳回) boolean

如果找到並分離了處理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

Defined in: 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]);
    }
}

            
setEnabled() public method

Defined in: yii\log\Target::setEnabled()

設定一個值,指出是否已啟用此記錄目標。

public void setEnabled ( $value )
$value boolean|callable

一個布林值或一個可呼叫的項目,用於從中取得值。可呼叫的值自 2.0.13 版本起可用。

可呼叫的項目可用於動態決定是否應啟用日誌目標。例如,若要僅在目前使用者登入時才啟用日誌,您可以如下設定目標

'enabled' => function() {
    return !Yii::$app->user->isGuest;
}

                public function setEnabled($value)
{
    $this->_enabled = $value;
}

            
setLevels() public method

Defined in: yii\log\Target::setLevels()

設定此目標感興趣的訊息層級。

參數可以是感興趣的層級名稱陣列,或是一個整數,表示感興趣的層級值的位元圖。有效的層級名稱包括:'error'、'warning'、'info'、'trace' 和 'profile';有效的層級值包括:yii\log\Logger::LEVEL_ERRORyii\log\Logger::LEVEL_WARNINGyii\log\Logger::LEVEL_INFOyii\log\Logger::LEVEL_TRACEyii\log\Logger::LEVEL_PROFILE

例如,

['error', 'warning']
// which is equivalent to:
Logger::LEVEL_ERROR | Logger::LEVEL_WARNING
public void setLevels ( $levels )
$levels array|integer

此目標感興趣的訊息層級。

throws (拋出) 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;
    }
}

            
trigger() public method

Defined in: 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);
}