0 追蹤者

類別 yii\caching\FileCache

繼承關係yii\caching\FileCache » yii\caching\Cache » yii\base\Component » yii\base\BaseObject
實作介面yii\base\Configurable, yii\caching\CacheInterface
自版本2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/caching/FileCache.php

FileCache 實作使用檔案的快取元件。

對於每個被快取的資料值,FileCache 將會把它儲存在個別的檔案中。快取檔案會被放置在 $cachePath 底下。FileCache 將會自動執行垃圾回收,以移除過期的快取檔案。

關於 FileCache 支援的常見快取操作,請參考 yii\caching\Cache

關於快取的更多詳細資訊和使用方式,請參閱 快取概觀指南文章

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$cacheFileSuffix string 快取檔案後綴。 yii\caching\FileCache
$cachePath string 儲存快取檔案的目錄。 yii\caching\FileCache
$defaultDuration integer 快取項目過期前的預設持續時間,以秒為單位。 yii\caching\Cache
$dirMode integer 為新建立的目錄設定的權限。 yii\caching\FileCache
$directoryLevel integer 儲存快取檔案的子目錄層級。 yii\caching\FileCache
$fileMode integer|null 為新建立的快取檔案設定的權限。 yii\caching\FileCache
$gcProbability integer 當在快取中儲存一筆資料時,執行垃圾回收 (GC) 的機率 (百萬分之一)。 yii\caching\FileCache
$keyPrefix string 附加到每個快取鍵的字串前綴。 yii\caching\FileCache
$serializer array|null|false 用於序列化和反序列化快取資料的函式。 yii\caching\Cache

公開方法

隱藏繼承的方法

方法 描述 定義於
__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
add() 若快取中不包含此鍵,則將由鍵識別的值儲存到快取中。 yii\caching\Cache
attachBehavior() 將行為附加到此元件。 yii\base\Component
attachBehaviors() 將行為列表附加到此元件。 yii\base\Component
behaviors() 回傳此元件應表現為的行為列表。 yii\base\Component
buildKey() 從給定的鍵建立標準化的快取鍵。 yii\caching\Cache
canGetProperty() 回傳一個值,指示屬性是否可以讀取。 yii\base\Component
canSetProperty() 回傳一個值,指示屬性是否可以設定。 yii\base\Component
className() 回傳此類別的完整限定名稱。 yii\base\BaseObject
delete() 從快取中刪除具有指定鍵的值。 yii\caching\Cache
detachBehavior() 從元件中分離行為。 yii\base\Component
detachBehaviors() 從元件中分離所有行為。 yii\base\Component
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此元件。 yii\base\Component
exists() 檢查快取中是否存在指定的鍵。 yii\caching\FileCache
flush() 從快取中刪除所有值。 yii\caching\Cache
gc() 移除過期的快取檔案。 yii\caching\FileCache
get() 使用指定的鍵從快取中檢索值。 yii\caching\Cache
getBehavior() 回傳指定的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此元件的所有行為。 yii\base\Component
getOrSet() 此方法結合了 set()get() 方法,以取回由 $key 識別的值,或在 $key 沒有可用的快取時,儲存 $callable 執行的結果。 yii\caching\Cache
hasEventHandlers() 傳回一個值,指出是否有任何處理常式附加到指定的事件。 yii\base\Component
hasMethod() 傳回一個值,指出是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指出是否為此元件定義了屬性。 yii\base\Component
init() 透過確保快取路徑的存在來初始化此元件。 yii\caching\FileCache
madd() 在快取中儲存多個項目。每個項目都包含一個由鍵值識別的值。 yii\caching\Cache
mget() 使用指定的鍵值從快取中取回多個值。 yii\caching\Cache
mset() 在快取中儲存多個項目。每個項目都包含一個由鍵值識別的值。 yii\caching\Cache
multiAdd() 在快取中儲存多個項目。每個項目都包含一個由鍵值識別的值。 yii\caching\Cache
multiGet() 使用指定的鍵值從快取中取回多個值。 yii\caching\Cache
multiSet() 在快取中儲存多個項目。每個項目都包含一個由鍵值識別的值。 yii\caching\Cache
off() 從此元件中分離現有的事件處理常式。 yii\base\Component
offsetExists() 傳回是否在快取中存在具有指定鍵值的項目。 yii\caching\Cache
offsetGet() 使用指定的鍵值從快取中取回值。 yii\caching\Cache
offsetSet() 將由鍵值識別的值儲存到快取中。 yii\caching\Cache
offsetUnset() 從快取中刪除具有指定鍵值的值。此方法為介面 ArrayAccess 所需。 yii\caching\Cache
on() 將事件處理常式附加到事件。 yii\base\Component
set() 將由鍵值識別的值儲存到快取中。 yii\caching\Cache
trigger() 觸發事件。 yii\base\Component

受保護的方法

隱藏繼承的方法

方法 描述 定義於
addValue() 若快取中不包含此鍵,則將由鍵識別的值儲存到快取中。 yii\caching\FileCache
addValues() 將多個鍵值對加入到快取中。 yii\caching\Cache
deleteValue() 從快取中刪除具有指定鍵值的值。這是父類別中宣告的方法的實作。 yii\caching\FileCache
flushValues() 從快取中刪除所有值。 yii\caching\FileCache
gcRecursive() 遞迴地移除目錄下過期的快取檔案。 yii\caching\FileCache
getCacheFile() 傳回給定正規化快取鍵的快取檔案路徑。 yii\caching\FileCache
getValue() 使用指定的鍵從快取中檢索值。 yii\caching\FileCache
getValues() 使用指定的鍵值從快取中取回多個值。 yii\caching\Cache
setValue() 將由鍵值識別的值儲存在快取中。 yii\caching\FileCache
setValues() 在快取中儲存多個鍵值對。 yii\caching\Cache

屬性詳細資訊

隱藏繼承的屬性

$cacheFileSuffix 公開屬性

快取檔案後綴。預設為 '.bin'。

public string $cacheFileSuffix '.bin'
$cachePath 公開屬性

儲存快取檔案的目錄。您可以在此處使用路徑別名。如果未設定,則將使用應用程式執行時期路徑下的 "cache" 子目錄。

public string $cachePath '@runtime/cache'
$dirMode 公開屬性

為新建立的目錄設定的權限。此值將由 PHP chmod() 函數使用。不會套用 umask。預設為 0775,表示目錄對於擁有者和群組是可讀寫的,但對於其他使用者是唯讀的。

public integer $dirMode 0775
$directoryLevel 公開屬性

儲存快取檔案的子目錄層級。預設為 1。如果系統有大量的快取檔案(例如一百萬個),您可以使用更大的值(通常不超過 3)。使用子目錄主要是為了確保檔案系統不會因為單一目錄中包含過多檔案而負擔過重。

$fileMode 公開屬性

為新建立的快取檔案設定的權限。此值將由 PHP chmod() 函數使用。不會套用 umask。如果未設定,則權限將由目前的環境決定。

public integer|null $fileMode null
$gcProbability 公開屬性

當在快取中儲存資料時,執行垃圾回收 (GC) 的機率(百萬分率)。預設為 10,表示 0.001% 的機率。此數字應介於 0 到 1000000 之間。值 0 表示完全不執行 GC。

public integer $gcProbability 10
$keyPrefix 公開屬性

前綴於每個快取鍵的字串。當您在相同的 $cachePath 下為不同的應用程式儲存快取資料時,需要此設定以避免衝突。

為了確保互通性,應僅使用字母數字字元。

public string $keyPrefix ''

方法詳細資訊

隱藏繼承的方法

__call() 公開方法

定義於: 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() 公開方法

定義於: 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

屬性名稱

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() 公開方法

定義於: 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() 公開方法

定義於: 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() 公開方法

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

            
add() 公開方法

定義於: yii\caching\Cache::add()

若快取中不包含此鍵,則將由鍵識別的值儲存到快取中。

如果快取已包含該鍵值,則不會執行任何操作。

public boolean add ( $key, $value, $duration 0, $dependency null )
$key mixed

用於識別要快取的值的鍵值。這可以是簡單的字串,或是由代表鍵值的因素組成的複雜資料結構。

$value mixed

要快取的值

$duration integer

快取值將過期的秒數。0 表示永不過期。

$dependency yii\caching\Dependency|null

快取項目的依賴性。如果依賴性變更,則當透過 get() 擷取時,快取中的對應值將會失效。如果 $serializer 為 false,則會忽略此參數。

return boolean

值是否成功儲存到快取中

                public function add($key, $value, $duration = 0, $dependency = null)
{
    if ($dependency !== null && $this->serializer !== false) {
        $dependency->evaluateDependency($this);
    }
    if ($this->serializer === null) {
        $value = serialize([$value, $dependency]);
    } elseif ($this->serializer !== false) {
        $value = call_user_func($this->serializer[0], [$value, $dependency]);
    }
    $key = $this->buildKey($key);
    return $this->addValue($key, $value, $duration);
}

            
addValue() 受保護的方法

若快取中不包含此鍵,則將由鍵識別的值儲存到快取中。

這是父類別中宣告的方法的實作。

protected boolean addValue ( $key, $value, $duration )
$key string

用於識別要快取的值的鍵值

$value string

要快取的值。其他類型(如果您已停用 $serializer)在 getValue() 中可能無法正確取得。

$duration integer

快取值將過期的秒數。0 表示永不過期。

return boolean

如果值成功儲存到快取中,則為 True,否則為 false

                protected function addValue($key, $value, $duration)
{
    $cacheFile = $this->getCacheFile($key);
    if (@filemtime($cacheFile) > time()) {
        return false;
    }
    return $this->setValue($key, $value, $duration);
}

            
addValues() 受保護的方法

定義於: yii\caching\Cache::addValues()

將多個鍵值對加入到快取中。

預設實作會多次呼叫 addValue(),以逐一加入值。如果底層快取儲存支援多重加入,則應覆寫此方法以利用該功能。

protected array addValues ( $data, $duration )
$data array

陣列,其中鍵值對應於快取鍵值,而值是要儲存的值。

$duration integer

快取值將過期的秒數。0 表示永不過期。

return array

失敗的鍵值陣列

                protected function addValues($data, $duration)
{
    $failedKeys = [];
    foreach ($data as $key => $value) {
        if ($this->addValue($key, $value, $duration) === false) {
            $failedKeys[] = $key;
        }
    }
    return $failedKeys;
}

            
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

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

return 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 ( )
return array

行為組態。

                public function behaviors()
{
    return [];
}

            
buildKey() 公開方法

定義於: yii\caching\Cache::buildKey()

從給定的鍵建立標準化的快取鍵。

如果給定的鍵值是一個僅包含字母數字字元且不超過 32 個字元的字串,則該鍵值將在加上 $keyPrefix 前綴後傳回。否則,將透過序列化給定的鍵值、應用 MD5 雜湊,並加上 $keyPrefix 前綴來產生正規化的鍵值。

public string buildKey ( $key )
$key mixed

要正規化的鍵值

return string

產生的快取鍵值

                public function buildKey($key)
{
    if (is_string($key)) {
        $key = ctype_alnum($key) && StringHelper::byteLength($key) <= 32 ? $key : md5($key);
    } else {
        if ($this->_igbinaryAvailable) {
            $serializedKey = igbinary_serialize($key);
        } else {
            $serializedKey = serialize($key);
        }
        $key = md5($serializedKey);
    }
    return $this->keyPrefix . $key;
}

            
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

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

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

定義於: 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

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

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

public static string className ( )
return string

此類別的完整限定名稱。

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

            
delete() public method

定義於: yii\caching\Cache::delete()

從快取中刪除具有指定鍵的值。

public boolean delete ( $key )
$key mixed

用於識別要從快取中刪除的值的鍵。這可以是簡單的字串或由代表鍵的因素組成的複雜資料結構。

return boolean

如果在刪除期間沒有發生錯誤

                public function delete($key)
{
    $key = $this->buildKey($key);
    return $this->deleteValue($key);
}

            
deleteValue() protected method

從快取中刪除具有指定鍵值的值。這是父類別中宣告的方法的實作。

protected boolean deleteValue ( $key )
$key string

要刪除的值的鍵

return boolean

如果在刪除期間沒有發生錯誤

                protected function deleteValue($key)
{
    $cacheFile = $this->getCacheFile($key);
    return @unlink($cacheFile);
}

            
detachBehavior() public method

定義於: 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

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

            
exists() public method

檢查快取中是否存在指定的鍵。

如果資料量很大,這可能比從快取中取得值更快。請注意,此方法不會檢查與快取資料相關聯的依賴項(如果有的話)是否已變更。因此,呼叫 get() 可能會傳回 false,而 exists 傳回 true。

public boolean exists ( $key )
$key mixed

用於識別快取值的鍵。這可以是簡單的字串或由代表鍵的因素組成的複雜資料結構。

return boolean

如果快取中存在值則為 True,如果值不在快取中或已過期則為 false。

                public function exists($key)
{
    $cacheFile = $this->getCacheFile($this->buildKey($key));
    return @filemtime($cacheFile) > time();
}

            
flush() public method

定義於: yii\caching\Cache::flush()

從快取中刪除所有值。

如果快取在多個應用程式之間共用,請小心執行此操作。

public boolean flush ( )
return boolean

清除操作是否成功。

                public function flush()
{
    return $this->flushValues();
}

            
flushValues() protected method

從快取中刪除所有值。

這是父類別中宣告的方法的實作。

protected boolean flushValues ( )
return boolean

清除操作是否成功。

                protected function flushValues()
{
    $this->gc(true, false);
    return true;
}

            
gc() public method

移除過期的快取檔案。

public void gc ( $force false, $expiredOnly true )
$force boolean

是否強制執行垃圾回收,無論 $gcProbability 為何。預設為 false,表示實際刪除發生的機率由 $gcProbability 指定。

$expiredOnly boolean

是否僅移除過期的快取檔案。如果為 false,則會移除 $cachePath 下的所有快取檔案。

                public function gc($force = false, $expiredOnly = true)
{
    if ($force || random_int(0, 1000000) < $this->gcProbability) {
        $this->gcRecursive($this->cachePath, $expiredOnly);
    }
}

            
gcRecursive() protected method

遞迴地移除目錄下過期的快取檔案。

此方法主要由 gc() 使用。

protected void gcRecursive ( $path, $expiredOnly )
$path string

將移除過期快取檔案的目錄。

$expiredOnly boolean

是否僅移除過期的快取檔案。如果為 false,則會移除 $path 下的所有檔案。

                protected function gcRecursive($path, $expiredOnly)
{
    if (($handle = opendir($path)) !== false) {
        while (($file = readdir($handle)) !== false) {
            if (strncmp($file, '.', 1) === 0) {
                continue;
            }
            $fullPath = $path . DIRECTORY_SEPARATOR . $file;
            if (is_dir($fullPath)) {
                $this->gcRecursive($fullPath, $expiredOnly);
                if (!$expiredOnly) {
                    if (!@rmdir($fullPath)) {
                        $error = error_get_last();
                        Yii::warning("Unable to remove directory '{$fullPath}': {$error['message']}", __METHOD__);
                    }
                }
            } elseif (!$expiredOnly || $expiredOnly && @filemtime($fullPath) < time()) {
                if (!@unlink($fullPath)) {
                    $error = error_get_last();
                    Yii::warning("Unable to remove file '{$fullPath}': {$error['message']}", __METHOD__);
                }
            }
        }
        closedir($handle);
    }
}

            
get() public method

定義於: yii\caching\Cache::get()

使用指定的鍵從快取中檢索值。

public mixed get ( $key )
$key mixed

用於識別快取值的鍵。這可以是簡單的字串或由代表鍵的因素組成的複雜資料結構。

return mixed

儲存在快取中的值;如果值不在快取中、已過期,或與快取資料相關聯的依賴項已變更,則為 false。

                public function get($key)
{
    $key = $this->buildKey($key);
    $value = $this->getValue($key);
    if ($value === false || $this->serializer === false) {
        return $value;
    } elseif ($this->serializer === null) {
        $value = unserialize((string)$value);
    } else {
        $value = call_user_func($this->serializer[1], $value);
    }
    if (is_array($value) && !($value[1] instanceof Dependency && $value[1]->isChanged($this))) {
        return $value[0];
    }
    return false;
}

            
getBehavior() public method

定義於: 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

定義於: yii\base\Component::getBehaviors()

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

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

附加到此組件的行為列表

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

            
getCacheFile() protected method

傳回給定正規化快取鍵的快取檔案路徑。

protected string getCacheFile ( $normalizedKey )
$normalizedKey string

buildKey() 方法正規化的快取鍵

return string

快取檔案路徑

                protected function getCacheFile($normalizedKey)
{
    $cacheKey = $normalizedKey;
    if ($this->keyPrefix !== '') {
        // Remove key prefix to avoid generating constant directory levels
        $lenKeyPrefix = strlen($this->keyPrefix);
        $cacheKey = substr_replace($normalizedKey, '', 0, $lenKeyPrefix);
    }
    $cachePath = $this->cachePath;
    if ($this->directoryLevel > 0) {
        for ($i = 0; $i < $this->directoryLevel; ++$i) {
            if (($subDirectory = substr($cacheKey, $i + $i, 2)) !== false) {
                $cachePath .= DIRECTORY_SEPARATOR . $subDirectory;
            }
        }
    }
    return $cachePath . DIRECTORY_SEPARATOR . $normalizedKey . $this->cacheFileSuffix;
}

            
getOrSet() public method (available since version 2.0.11)

定義於: yii\caching\Cache::getOrSet()

此方法結合了 set()get() 方法,以取回由 $key 識別的值,或在 $key 沒有可用的快取時,儲存 $callable 執行的結果。

使用範例

public function getTopProducts($count = 10) {
    $cache = $this->cache; // Could be Yii::$app->cache
    return $cache->getOrSet(['top-n-products', 'n' => $count], function () use ($count) {
        return Products::find()->mostPopular()->limit($count)->all();
    }, 1000);
}
public mixed getOrSet ( $key, $callable, $duration null, $dependency null )
$key mixed

用於識別要快取的值的鍵值。這可以是簡單的字串,或是由代表鍵值的因素組成的複雜資料結構。

$callable callable|Closure

將用於產生要快取的值的可呼叫函式或閉包。如果您使用的 $callable 可能會傳回 false,請記住 getOrSet() 的工作效率可能會降低,因為 yii\caching\Cache::get() 方法使用 false 傳回值來指示在快取中找不到資料項目。因此,快取 false 值將導致不必要的內部呼叫。

$duration integer|null

快取過期前的預設持續時間(秒)。如果未設定,將使用 $defaultDuration 值。

$dependency yii\caching\Dependency|null

快取項目的依賴項。如果依賴項變更,則在透過 get() 擷取時,快取中的對應值將失效。如果 $serializerfalse,則會忽略此參數。

return mixed

$callable 執行的結果

                public function getOrSet($key, $callable, $duration = null, $dependency = null)
{
    if (($value = $this->get($key)) !== false) {
        return $value;
    }
    $value = call_user_func($callable, $this);
    if (!$this->set($key, $value, $duration, $dependency)) {
        Yii::warning('Failed to set cache value for key ' . json_encode($key), __METHOD__);
    }
    return $value;
}

            
getValue() protected method

使用指定的鍵從快取中檢索值。

這是父類別中宣告的方法的實作。

protected string|false getValue ( $key )
$key string

用於識別快取值的唯一鍵

return string|false

儲存在快取中的值;如果值不在快取中或已過期,則為 false。

                protected function getValue($key)
{
    $cacheFile = $this->getCacheFile($key);
    if (@filemtime($cacheFile) > time()) {
        $fp = @fopen($cacheFile, 'r');
        if ($fp !== false) {
            @flock($fp, LOCK_SH);
            $cacheValue = @stream_get_contents($fp);
            @flock($fp, LOCK_UN);
            @fclose($fp);
            return $cacheValue;
        }
    }
    return false;
}

            
getValues() protected method

定義於: yii\caching\Cache::getValues()

使用指定的鍵值從快取中取回多個值。

預設實作多次呼叫 getValue(),以逐一擷取快取值。如果底層快取儲存體支援 multiget,則應覆寫此方法以利用該功能。

protected array getValues ( $keys )
$keys array

用於識別快取值的鍵列表

return array

由鍵索引的快取值列表

                protected function getValues($keys)
{
    $results = [];
    foreach ($keys as $key) {
        $results[$key] = $this->getValue($key);
    }
    return $results;
}

            
hasEventHandlers() public method

定義於: 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

定義於: 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

定義於: 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

透過確保快取路徑的存在來初始化此元件。

public void init ( )

                public function init()
{
    parent::init();
    $this->cachePath = Yii::getAlias($this->cachePath);
    if (!is_dir($this->cachePath)) {
        FileHelper::createDirectory($this->cachePath, $this->dirMode, true);
    }
}

            
madd() public method
已過時。此方法是 multiAdd() 的別名,將在 2.1.0 版本中移除。

定義於: yii\caching\Cache::madd()

在快取中儲存多個項目。每個項目都包含一個由鍵值識別的值。

如果快取已包含此鍵,則現有的值和過期時間將會被保留。

public array madd ( $items, $duration 0, $dependency null )
$items array

要快取的項目,以鍵值對的形式呈現。

$duration integer

快取值將過期的預設秒數。0 表示永不過期。

$dependency yii\caching\Dependency|null

快取項目的依賴項。如果依賴項變更,則在透過 get() 擷取時,快取中的對應值將失效。如果 $serializer 為 false,則會忽略此參數。

return array

失敗的鍵值陣列

                public function madd($items, $duration = 0, $dependency = null)
{
    return $this->multiAdd($items, $duration, $dependency);
}

            
mget() public method
已過時。此方法是 multiGet() 的別名,將在 2.1.0 版本中移除。

定義於: yii\caching\Cache::mget()

使用指定的鍵值從快取中取回多個值。

某些快取(例如 memcache、apc)允許同時擷取多個快取值,這可能會提高效能。如果快取本身不支援此功能,則此方法將嘗試模擬它。

public array mget ( $keys )
$keys string[]

用於識別快取值的字串鍵列表

return array

對應於指定鍵的快取值列表。陣列以 (鍵, 值) 對的形式傳回。如果值未快取或已過期,則對應的陣列值將為 false。

                public function mget($keys)
{
    return $this->multiGet($keys);
}

            
mset() public method
已過時。此方法是 multiSet() 的別名,將在 2.1.0 版本中移除。

定義於: yii\caching\Cache::mset()

在快取中儲存多個項目。每個項目都包含一個由鍵值識別的值。

如果快取已包含此鍵,則現有的值和過期時間將分別被新值取代。

public array mset ( $items, $duration null, $dependency null )
$items array

要快取的項目,以鍵值對的形式呈現。

$duration integer|null

快取過期前的預設持續時間(秒)。如果未設定,則使用預設的 $defaultDuration 值。

$dependency yii\caching\Dependency|null

快取項目的依賴項。如果依賴項變更,則在透過 get() 擷取時,快取中的對應值將失效。如果 $serializer 為 false,則會忽略此參數。

return array

失敗的鍵值陣列

                public function mset($items, $duration = null, $dependency = null)
{
    return $this->multiSet($items, $duration, $dependency);
}

            
multiAdd() public method (available since version 2.0.7)

定義於: yii\caching\Cache::multiAdd()

在快取中儲存多個項目。每個項目都包含一個由鍵值識別的值。

如果快取已包含此鍵,則現有的值和過期時間將會被保留。

public array multiAdd ( $items, $duration 0, $dependency null )
$items array

要快取的項目,以鍵值對的形式呈現。

$duration integer

快取值將過期的預設秒數。0 表示永不過期。

$dependency yii\caching\Dependency|null

快取項目的依賴項。如果依賴項變更,則在透過 get() 擷取時,快取中的對應值將失效。如果 $serializer 為 false,則會忽略此參數。

return array

失敗的鍵值陣列

                public function multiAdd($items, $duration = 0, $dependency = null)
{
    $data = $this->prepareCacheData($items, $dependency);
    return $this->addValues($data, $duration);
}

            
multiGet() public method (available since version 2.0.7)

定義於: yii\caching\Cache::multiGet()

使用指定的鍵值從快取中取回多個值。

某些快取(例如 memcache、apc)允許同時擷取多個快取值,這可能會提高效能。如果快取本身不支援此功能,則此方法將嘗試模擬它。

public array multiGet ( $keys )
$keys string[]

用於識別快取值的字串鍵列表

return array

對應於指定鍵的快取值列表。陣列以 (鍵, 值) 對的形式傳回。如果值未快取或已過期,則對應的陣列值將為 false。

                public function multiGet($keys)
{
    $keyMap = [];
    foreach ($keys as $key) {
        $keyMap[$key] = $this->buildKey($key);
    }
    $values = $this->getValues(array_values($keyMap));
    $results = [];
    foreach ($keyMap as $key => $newKey) {
        $results[$key] = false;
        if (isset($values[$newKey])) {
            if ($this->serializer === false) {
                $results[$key] = $values[$newKey];
            } else {
                $value = $this->serializer === null ? unserialize($values[$newKey])
                    : call_user_func($this->serializer[1], $values[$newKey]);
                if (is_array($value) && !($value[1] instanceof Dependency && $value[1]->isChanged($this))) {
                    $results[$key] = $value[0];
                }
            }
        }
    }
    return $results;
}

            
multiSet() public method (available since version 2.0.7)

定義於: yii\caching\Cache::multiSet()

在快取中儲存多個項目。每個項目都包含一個由鍵值識別的值。

如果快取已包含此鍵,則現有的值和過期時間將分別被新值取代。

public array multiSet ( $items, $duration null, $dependency null )
$items array

要快取的項目,以鍵值對的形式呈現。

$duration integer|null

快取過期前的預設持續時間(秒)。如果未設定,則使用預設的 $defaultDuration 值。

$dependency yii\caching\Dependency|null

快取項目的依賴項。如果依賴項變更,則在透過 get() 擷取時,快取中的對應值將失效。如果 $serializer 為 false,則會忽略此參數。

return array

失敗的鍵值陣列

                public function multiSet($items, $duration = null, $dependency = null)
{
    if ($duration === null) {
        $duration = $this->defaultDuration;
    }
    $data = $this->prepareCacheData($items, $dependency);
    return $this->setValues($data, $duration);
}

            
off() public method

定義於: 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;
}

            
offsetExists() public method

定義於: yii\caching\Cache::offsetExists()

傳回是否在快取中存在具有指定鍵值的項目。

此方法為介面 ArrayAccess 所要求。

public boolean offsetExists ( $key )
$key string

識別快取值的鍵

                #[\ReturnTypeWillChange]
public function offsetExists($key)
{
    return $this->get($key) !== false;
}

            
offsetGet() public method

定義於: yii\caching\Cache::offsetGet()

使用指定的鍵值從快取中取回值。

此方法為介面 ArrayAccess 所要求。

public mixed offsetGet ( $key )
$key string

識別快取值的鍵

return mixed

儲存在快取中的值;如果值不在快取中或已過期,則為 false。

                #[\ReturnTypeWillChange]
public function offsetGet($key)
{
    return $this->get($key);
}

            
offsetSet() public method

定義於: yii\caching\Cache::offsetSet()

將由鍵值識別的值儲存到快取中。

如果快取已包含此鍵,則現有值將被新值取代。若要新增過期時間和相依性,請使用 set() 方法。此方法為介面 ArrayAccess 所要求。

public void offsetSet ( $key, $value )
$key string

用於識別要快取的值的鍵值

$value mixed

要快取的值

                #[\ReturnTypeWillChange]
public function offsetSet($key, $value)
{
    $this->set($key, $value);
}

            
offsetUnset() public method

定義於: yii\caching\Cache::offsetUnset()

從快取中刪除具有指定鍵值的值。此方法為介面 ArrayAccess 所需。

public void offsetUnset ( $key )
$key string

要刪除的值的鍵

                #[\ReturnTypeWillChange]
public function offsetUnset($key)
{
    $this->delete($key);
}

            
on() public method

定義於: 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 可呼叫

事件處理器

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

            
set() public method

定義於: yii\caching\Cache::set()

將由鍵值識別的值儲存到快取中。

如果快取已包含此鍵,則現有的值和過期時間將分別被新值取代。

public boolean set ( $key, $value, $duration null, $dependency null )
$key mixed

用於識別要快取的值的鍵值。這可以是簡單的字串,或是由代表鍵值的因素組成的複雜資料結構。

$value mixed

要快取的值

$duration integer|null

快取過期前的預設持續時間(秒)。如果未設定,則使用預設的 $defaultDuration 值。

$dependency yii\caching\Dependency|null

快取項目的依賴性。如果依賴性變更,則當透過 get() 擷取時,快取中的對應值將會失效。如果 $serializer 為 false,則會忽略此參數。

return boolean

值是否成功儲存到快取中

                public function set($key, $value, $duration = null, $dependency = null)
{
    if ($duration === null) {
        $duration = $this->defaultDuration;
    }
    if ($dependency !== null && $this->serializer !== false) {
        $dependency->evaluateDependency($this);
    }
    if ($this->serializer === null) {
        $value = serialize([$value, $dependency]);
    } elseif ($this->serializer !== false) {
        $value = call_user_func($this->serializer[0], [$value, $dependency]);
    }
    $key = $this->buildKey($key);
    return $this->setValue($key, $value, $duration);
}

            
setValue() protected method

將由鍵值識別的值儲存在快取中。

這是父類別中宣告的方法的實作。

protected boolean setValue ( $key, $value, $duration )
$key string

用於識別要快取的值的鍵值

$value string

要快取的值。其他類型(如果您已停用 $serializer)可能無法在 getValue() 中正確取得。

$duration integer

快取值將過期的秒數。小於或等於 0 表示 1 年的過期時間。

return boolean

如果值成功儲存到快取中,則為 True,否則為 false

                protected function setValue($key, $value, $duration)
{
    $this->gc();
    $cacheFile = $this->getCacheFile($key);
    if ($this->directoryLevel > 0) {
        @FileHelper::createDirectory(dirname($cacheFile), $this->dirMode, true);
    }
    // If ownership differs the touch call will fail, so we try to
    // rebuild the file from scratch by deleting it first
    // https://github.com/yiisoft/yii2/pull/16120
    if (is_file($cacheFile) && function_exists('posix_geteuid') && fileowner($cacheFile) !== posix_geteuid()) {
        @unlink($cacheFile);
    }
    if (@file_put_contents($cacheFile, $value, LOCK_EX) !== false) {
        if ($this->fileMode !== null) {
            @chmod($cacheFile, $this->fileMode);
        }
        if ($duration <= 0) {
            $duration = 31536000; // 1 year
        }
        return @touch($cacheFile, $duration + time());
    }
    $error = error_get_last();
    Yii::warning("Unable to write cache file '{$cacheFile}': {$error['message']}", __METHOD__);
    return false;
}

            
setValues() protected method

定義於: yii\caching\Cache::setValues()

在快取中儲存多個鍵值對。

預設實作多次呼叫 setValue() 以逐一儲存值。如果底層快取儲存支援多重設定,則應覆寫此方法以利用該功能。

protected array setValues ( $data, $duration )
$data array

陣列,其中鍵對應於快取鍵,而值是儲存的值

$duration integer

快取值將過期的秒數。0 表示永不過期。

return array

失敗的鍵值陣列

                protected function setValues($data, $duration)
{
    $failedKeys = [];
    foreach ($data as $key => $value) {
        if ($this->setValue($key, $value, $duration) === false) {
            $failedKeys[] = $key;
        }
    }
    return $failedKeys;
}

            
trigger() public method

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