0 追蹤者

類別 yii\caching\WinCache

繼承關係yii\caching\WinCache » 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/WinCache.php

WinCache 提供了 Windows Cache 快取功能,以應用程式元件的形式呈現。

若要使用此應用程式元件,必須載入 WinCache PHP 擴充套件。另請注意,應在您的 php.ini 檔案中將 "wincache.ucenabled" 設定為 "On"。

請參閱 yii\caching\Cache 手冊,以了解 WinCache 支援的常見快取操作。

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

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$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\WinCache
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\WinCache
addValues() 將多個鍵值對新增到快取。 yii\caching\WinCache
deleteValue() 從快取中刪除具有指定鍵的值。這是父類別中宣告的方法的實作。 yii\caching\WinCache
flushValues() 從快取中刪除所有值。 yii\caching\WinCache
getValue() 使用指定的鍵從快取中檢索值。 yii\caching\WinCache
getValues() 使用指定的鍵從快取中檢索多個值。 yii\caching\WinCache
setValue() 在快取中儲存由鍵識別的值。 yii\caching\WinCache
setValues() 在快取中儲存多個鍵值對。 yii\caching\WinCache

方法詳情

隱藏繼承的方法

__call() 公開方法

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

呼叫指定的非類別方法。

這個方法會檢查是否有任何附加的行為具有指定名稱的方法,並在可用的情況下執行它。

請勿直接呼叫此方法,因為它是一個 PHP 魔術方法,當呼叫未知方法時會被隱式地呼叫。

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

方法名稱

$params 陣列

方法參數

回傳 mixed

方法回傳值

拋出 yii\base\UnknownMethodException

當呼叫未知方法時

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

            
__clone() 公開方法

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

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

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

public void __clone ( )

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

            
__construct() 公開方法

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

建構子。

預設實作會做兩件事

  • 使用給定的組態 $config 初始化物件。
  • 呼叫 init()

如果這個方法在子類別中被覆寫,建議:

  • 建構子的最後一個參數是一個組態陣列,就像這裡的 $config 一樣。
  • 在建構子的結尾呼叫父類別的實作。
public void __construct ( $config = [] )
$config 陣列

將用於初始化物件屬性的名稱-值配對

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() 公開方法

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

傳回元件屬性的值。

這個方法會依照以下順序檢查並採取相應的行動:

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

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

另請參閱 __set()

public mixed __get ( $name )
$name string

屬性名稱

回傳 mixed

屬性值或行為屬性的值

拋出 yii\base\UnknownPropertyException

如果屬性未定義

拋出 yii\base\InvalidCallException

如果屬性為唯寫。

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

            
__isset() 公開方法

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

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

這個方法會依照以下順序檢查並採取相應的行動:

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

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

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

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱

回傳 布林值

名稱的屬性是否已設定

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

            
__set() 公開方法

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

設定元件屬性的值。

這個方法會依照以下順序檢查並採取相應的行動:

  • 由 setter 定義的屬性:設定屬性值
  • 格式為 "on xyz" 的事件:將處理器附加到事件 "xyz"
  • 格式為 "as xyz" 的行為:附加名為 "xyz" 的行為
  • 行為的屬性:設定行為屬性值

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

另請參閱 __get()

public void __set ( $name, $value )
$name string

屬性名稱或事件名稱

$value mixed

屬性值

拋出 yii\base\UnknownPropertyException

如果屬性未定義

拋出 yii\base\InvalidCallException

如果屬性為唯讀。

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

            
__unset() 公開方法

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

將元件屬性設定為 null。

這個方法會依照以下順序檢查並採取相應的行動:

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

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

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

public void __unset ( $name )
$name string

屬性名稱

拋出 yii\base\InvalidCallException

如果屬性為唯讀。

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

            
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,則會忽略此參數。

回傳 布林值

值是否成功儲存到快取中

                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 mixed

要快取的值。通常它是一個字串。如果您已停用 $serializer,它可能是其他東西。

$duration integer

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

回傳 布林值

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

                protected function addValue($key, $value, $duration)
{
    return wincache_ucache_add($key, $value, $duration);
}

            
addValues() 受保護方法

將多個鍵值對新增到快取。

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

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

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

$duration integer

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

回傳 陣列

失敗的鍵陣列

                protected function addValues($data, $duration)
{
    return wincache_ucache_add($data, null, $duration);
}

            
attachBehavior() 公開方法

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

將行為附加到此元件。

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

另請參閱 detachBehavior()

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

行為的名稱。

$behavior string|array|yii\base\Behavior

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

回傳 yii\base\Behavior

行為物件

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

            
attachBehaviors() 公開方法

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

將行為列表附加到元件。

每個行為都以其名稱索引,並且應該是一個 yii\base\Behavior 物件、一個指定行為類別的字串,或一個用於建立行為的組態陣列。

另請參閱 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors 陣列

要附加到元件的行為列表

                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 ( )
回傳 陣列

行為組態。

                public function behaviors()
{
    return [];
}

            
buildKey() 公開方法

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

從給定的鍵建立正規化的快取鍵。

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

public string buildKey ( $key )
$key mixed

要正規化的鍵

回傳 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 布林值

是否將成員變數視為屬性

$checkBehaviors 布林值

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

回傳 布林值

屬性是否可以讀取

                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 布林值

是否將成員變數視為屬性

$checkBehaviors 布林值

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

回傳 布林值

屬性是否可以寫入

                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 ( )
回傳 string

這個類別的完整限定名稱。

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

            
delete() 公開方法

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

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

public boolean delete ( $key )
$key mixed

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

回傳 布林值

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

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

            
deleteValue() 受保護方法

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

protected boolean deleteValue ( $key )
$key string

要刪除的值的鍵

回傳 布林值

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

                protected function deleteValue($key)
{
    return wincache_ucache_delete($key);
}

            
detachBehavior() 公開方法

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

從元件中分離行為。

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

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

行為的名稱。

回傳 yii\base\Behavior|null

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

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

            
detachBehaviors() 公開方法

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

從元件中分離所有行為。

public void detachBehaviors ( )

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

            
ensureBehaviors() 公開方法

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

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

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

public boolean exists ( $key )
$key mixed

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

回傳 布林值

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

                public function exists($key)
{
    $key = $this->buildKey($key);
    return wincache_ucache_exists($key);
}

            
flush() 公開方法

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

從快取中刪除所有值。

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

public boolean flush ( )
回傳 布林值

清除操作是否成功。

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

            
flushValues() 受保護方法

從快取中刪除所有值。

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

protected boolean flushValues ( )
回傳 布林值

清除操作是否成功。

                protected function flushValues()
{
    return wincache_ucache_clear();
}

            
get() 公開方法

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

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

public mixed get ( $key )
$key mixed

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

回傳 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 方法

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

傳回指定的行為物件。

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

行為名稱

回傳 yii\base\Behavior|null

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

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

            
getBehaviors() public 方法

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

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

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

附加到此元件的行為列表

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

            
getOrSet() public 方法 (自版本 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

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

$duration integer|null

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

$dependency yii\caching\Dependency|null

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

回傳 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 方法

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

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

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

識別快取值的唯一鍵

回傳 string|boolean

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

                protected function getValue($key)
{
    return wincache_ucache_get($key);
}

            
getValues() protected 方法

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

protected array getValues ( $keys )
$keys 陣列

識別快取值的鍵列表

回傳 陣列

依鍵索引的快取值列表

                protected function getValues($keys)
{
    return wincache_ucache_get($keys);
}

            
hasEventHandlers() public 方法

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

傳回一個值,指示是否有名稱事件附加任何處理常式。

public boolean hasEventHandlers ( $name )
$name string

事件名稱

回傳 布林值

是否有任何處理常式附加到事件。

                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 方法

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

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

如果符合以下條件,則定義方法:

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

屬性名稱

$checkBehaviors 布林值

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

回傳 布林值

方法是否已定義

                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 方法

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

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

如果符合以下條件,則定義屬性:

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

另請參閱

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

屬性名稱

$checkVars 布林值

是否將成員變數視為屬性

$checkBehaviors 布林值

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

回傳 布林值

屬性是否已定義

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

            
init() public 方法

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

初始化物件。

在物件使用給定組態初始化後,此方法會在建構函式的結尾被呼叫。

public void init ( )

                public function init()
{
    parent::init();
    $this->_igbinaryAvailable = \extension_loaded('igbinary');
}

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

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

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

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

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

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

$duration integer

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

$dependency yii\caching\Dependency|null

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

回傳 陣列

失敗的鍵陣列

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

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

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

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

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

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

識別快取值的字串鍵列表

回傳 陣列

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

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

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

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

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

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

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

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

$duration integer|null

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

$dependency yii\caching\Dependency|null

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

回傳 陣列

失敗的鍵陣列

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

            
multiAdd() public 方法 (自版本 2.0.7 起可用)

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

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

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

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

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

$duration integer

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

$dependency yii\caching\Dependency|null

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

回傳 陣列

失敗的鍵陣列

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

            
multiGet() public 方法 (自版本 2.0.7 起可用)

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

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

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

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

識別快取值的字串鍵列表

回傳 陣列

與指定鍵對應的快取值列表。傳回的陣列以(鍵,值)對的形式呈現。如果值未快取或已過期,則對應的陣列值將為 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 方法 (自版本 2.0.7 起可用)

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

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

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

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

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

$duration integer|null

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

$dependency yii\caching\Dependency|null

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

回傳 陣列

失敗的鍵陣列

                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 方法

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

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

此方法與 on() 相反。

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

另請參閱 on()

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

事件名稱

$handler callable|null

要移除的事件處理常式。如果為 null,則會移除附加到具名事件的所有處理常式。

回傳 布林值

如果找到並分離處理常式

                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 方法

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

傳回是否具有指定鍵的快取項目。

此方法為介面 ArrayAccess 所需。

public boolean offsetExists ( $key )
$key string

識別快取值的鍵

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

            
offsetGet() public 方法

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

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

此方法為介面 ArrayAccess 所需。

public mixed offsetGet ( $key )
$key string

識別快取值的鍵

回傳 mixed

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

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

            
offsetSet() public 方法

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

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

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

public void offsetUnset ( $key )
$key string

要刪除的值的鍵

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

            
on() public 方法

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

將事件處理常式附加到事件。

事件處理常式必須是有效的 PHP 回呼。以下是一些範例:

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

事件處理常式必須使用以下簽章 (signature) 定義:

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 布林值

是否將新的事件處理常式附加到現有處理常式列表的末尾。如果為 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 方法

定義於: 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,則會忽略此參數。

回傳 布林值

值是否成功儲存到快取中

                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 方法

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

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

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

識別要快取的值的鍵

$value mixed

要快取的值。通常它是一個字串。如果您已停用 $serializer,它可能是其他東西。

$duration integer

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

回傳 布林值

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

                protected function setValue($key, $value, $duration)
{
    return wincache_ucache_set($key, $value, $duration);
}

            
setValues() protected 方法

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

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

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

$duration integer

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

回傳 陣列

失敗的鍵陣列

                protected function setValues($data, $duration)
{
    return wincache_ucache_set($data, null, $duration);
}

            
trigger() public 方法

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