1 位追蹤者

抽象類別 yii\caching\Cache

繼承yii\caching\Cache » yii\base\Component » yii\base\BaseObject
實作yii\base\Configurable, yii\caching\CacheInterface
子類別yii\caching\ApcCache, yii\caching\ArrayCache, yii\caching\DbCache, yii\caching\DummyCache, yii\caching\FileCache, yii\caching\MemCache, yii\caching\WinCache, yii\caching\XCache, yii\caching\ZendDataCache
起始版本2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/caching/Cache.php

Cache 是快取類別的基底類別,支援不同的快取儲存實作。

資料項目可以透過呼叫 set() 儲存在快取中,並在之後(在相同或不同的請求中)透過 get() 檢索回來。在這兩個操作中,都需要一個識別資料項目的鍵。在呼叫 set() 時,也可以指定過期時間和/或 dependency。如果在呼叫 get() 時資料項目過期或依賴性變更,快取將不會傳回任何資料。

快取的典型使用模式如下

$key = 'demo';
$data = $cache->get($key);
if ($data === false) {
    // ...generate $data here...
    $cache->set($key, $data, $duration, $dependency);
}

由於 Cache 實作了 ArrayAccess 介面,因此可以像陣列一樣使用。例如:

$cache['foo'] = 'some data';
echo $cache['foo'];

衍生類別應實作以下方法,這些方法執行實際的快取儲存操作

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

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$defaultDuration integer 快取條目過期前的預設持續時間(秒)。 yii\caching\Cache
$keyPrefix string 前綴於每個快取鍵的字串,使其在整個快取儲存區中全域唯一。 yii\caching\Cache
$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\Cache
flush() 從快取中刪除所有值。 yii\caching\Cache
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\Cache
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\Cache
addValues() 將多個鍵值對新增到快取。 yii\caching\Cache
deleteValue() 從快取中刪除具有指定鍵值的值。此方法應由子類別實作,以從實際快取儲存空間中刪除資料。 yii\caching\Cache
flushValues() 從快取中刪除所有值。 yii\caching\Cache
getValue() 從快取中檢索具有指定鍵的值。 yii\caching\Cache
getValues() 使用指定的鍵值從快取中檢索多個值。 yii\caching\Cache
setValue() 將由鍵值識別的值儲存在快取中。 yii\caching\Cache
setValues() 將多個鍵值對儲存在快取中。 yii\caching\Cache

屬性詳細資訊

隱藏繼承的屬性

$defaultDuration 公開屬性 (自版本 2.0.11 起可用)

快取項目過期前的預設持續時間,以秒為單位。預設值為 0,表示無限期。如果未明確給定持續時間,set() 會使用此值。

$keyPrefix 公開屬性

每個快取鍵值都會加上前綴字串,使其在整個快取儲存空間中全域唯一。如果不同的應用程式正在使用相同的快取儲存空間,建議您為每個應用程式設定唯一的快取鍵值前綴。

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

public string $keyPrefix null
$serializer 公開屬性

用於序列化和反序列化快取資料的函式。預設為 null,表示使用預設的 PHP serialize()unserialize() 函式。如果您想使用更有效率的序列化程式 (例如 igbinary),您可以將此屬性配置為包含兩個元素的陣列。第一個元素指定序列化函式,第二個元素指定反序列化函式。如果此屬性設定為 false,則資料將直接傳送到基礎快取組件並從中檢索,而無需任何序列化或反序列化。如果您使用 快取依賴,則不應關閉序列化,因為它依賴於資料序列化。此外,某些快取的實作可能無法正確儲存和檢索與字串類型不同的資料。

public array|null|false $serializer null

方法詳細資訊

隱藏繼承的方法

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

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

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

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 abstract boolean addValue ( $key, $value, $duration )
$key string

識別要快取之值的鍵值

$value mixed

要快取的值。通常是字串。如果您已停用 $serializer,則可能是其他內容。

$duration integer

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

return boolean

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

                abstract protected function addValue($key, $value, $duration);

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

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

如果給定的鍵值是僅包含英數字元且不超過 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() 公開方法

定義於: 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() 公開靜態方法
自 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 boolean delete ( $key )
$key mixed

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

return boolean

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

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

            
deleteValue() protected abstract method

從快取中刪除具有指定鍵值的值。此方法應由子類別實作,以從實際快取儲存空間中刪除資料。

protected abstract boolean deleteValue ( $key )
$key string

要刪除的值的鍵

return boolean

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

                abstract protected function deleteValue($key);

            
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)
{
    $key = $this->buildKey($key);
    $value = $this->getValue($key);
    return $value !== false;
}

            
flush() public method

從快取中刪除所有值。

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

public boolean flush ( )
return boolean

清除操作是否成功。

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

            
flushValues() protected abstract method

從快取中刪除所有值。

子類別可以實作此方法以實現清除操作。

protected abstract boolean flushValues ( )
return boolean

清除操作是否成功。

                abstract protected function flushValues();

            
get() public method

從快取中檢索具有指定鍵的值。

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

            
getOrSet() public method (available since version 2.0.11)

此方法結合了 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 abstract method

從快取中檢索具有指定鍵的值。

子類別應實作此方法,以從特定的快取儲存空間檢索資料。

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

用於識別快取值的唯一鍵

return mixed|false

儲存在快取中的值,如果值不在快取中或已過期則為 false。最常見的情況是值為字串。如果您停用了 $serializer,則可能是其他類型。

                abstract protected function getValue($key);

            
getValues() protected method

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

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

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->_igbinaryAvailable = \extension_loaded('igbinary');
}

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

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

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

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 版本中移除。

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

某些快取(例如 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 版本中移除。

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

如果快取已包含這樣的鍵,則現有的值和到期時間將分別被新的值和到期時間替換。

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)

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

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

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)

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

某些快取(例如 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)

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

如果快取已包含這樣的鍵,則現有的值和到期時間將分別被新的值和到期時間替換。

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

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

此方法是介面 ArrayAccess 所要求的。

public boolean offsetExists ( $key )
$key string

用於識別快取值的鍵

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

            
offsetGet() public method

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

此方法是介面 ArrayAccess 所要求的。

public mixed offsetGet ( $key )
$key string

用於識別快取值的鍵

return mixed

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

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

            
offsetSet() public method

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

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

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

識別要快取之值的鍵值

$value mixed

要快取的值

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

            
offsetUnset() public method

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

public void offsetUnset ( $key )
$key string

要刪除的值的鍵

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

            
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 可呼叫

事件處理器

$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

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

如果快取已包含這樣的鍵,則現有的值和到期時間將分別被新的值和到期時間替換。

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 abstract method

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

此方法應由子類別實作,以將資料儲存在特定的快取儲存空間中。

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

識別要快取之值的鍵值

$value mixed

要快取的值。通常是字串。如果您已停用 $serializer,則可能是其他內容。

$duration integer

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

return boolean

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

                abstract protected function setValue($key, $value, $duration);

            
setValues() protected method

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

預設實作多次呼叫 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

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