0 フォロワー

クラス yii\caching\TagDependency

全クラス | プロパティ | メソッド
継承yii\caching\TagDependency » yii\caching\Dependency » yii\base\BaseObject
実装yii\base\Configurable
利用可能バージョン2.0
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/caching/TagDependency.php

TagDependency は、キャッシュされたデータ項目を1つ以上の$tagsに関連付けます。

invalidate()を呼び出すことで、指定されたタグ名に関連付けられたすべてのキャッシュされたデータ項目を無効化できます。

// setting multiple cache keys to store data forever and tagging them with "user-123"
Yii::$app->cache->set('user_42_profile', '', 0, new TagDependency(['tags' => 'user-123']));
Yii::$app->cache->set('user_42_stats', '', 0, new TagDependency(['tags' => 'user-123']));

// invalidating all keys tagged with "user-123"
TagDependency::invalidate(Yii::$app->cache, 'user-123');

キャッシュの詳細と使用方法については、キャッシュに関するガイド記事を参照してください。

公開プロパティ

継承されたプロパティを非表示

プロパティ 型 説明 定義元
$data mixed キャッシュに保存され、後で最新の依存関係データと比較される依存関係データ。 yii\caching\Dependency
$reusable boolean この依存関係が再利用可能かどうか。 yii\caching\Dependency
$tags string|array この依存関係のタグ名のリスト。 yii\caching\TagDependency

公開メソッド

継承されたメソッドを非表示

メソッド 説明 定義元
__call() クラスメソッドではない、指定されたメソッドを呼び出します。 yii\base\BaseObject
__construct() コンストラクタ。 yii\base\BaseObject
__get() オブジェクトのプロパティの値を返します。 yii\base\BaseObject
__isset() プロパティが設定されているかどうか（定義されていてnullではないか）をチェックします。 yii\base\BaseObject
__set() オブジェクトのプロパティの値を設定します。 yii\base\BaseObject
__unset() オブジェクトのプロパティをnullに設定します。 yii\base\BaseObject
canGetProperty() プロパティを読み取ることができるかどうかを示す値を返します。 yii\base\BaseObject
canSetProperty() プロパティを設定できるかどうかを示す値を返します。 yii\base\BaseObject
className() このクラスの完全修飾名を返します。 yii\base\BaseObject
evaluateDependency() 依存関係に関連するデータを生成および保存することにより、依存関係を評価します。 yii\caching\Dependency
getHasChanged() 依存関係が変更されたかどうかを示す値を返します。 yii\caching\Dependency
hasMethod() メソッドが定義されているかどうかを示す値を返します。 yii\base\BaseObject
hasProperty() プロパティが定義されているかどうかを示す値を返します。 yii\base\BaseObject
init() オブジェクトを初期化します。 yii\base\BaseObject
invalidate() 指定された$tagsのいずれかに関連付けられているすべてのキャッシュされたデータ項目を無効にします。 yii\caching\TagDependency
isChanged() 依存関係が変更されたかどうかをチェックします。 yii\caching\TagDependency
resetReusableData() 再利用可能な依存関係のすべてのキャッシュされたデータをリセットします。 yii\caching\Dependency

保護メソッド

継承されたメソッドを非表示

メソッド 説明 定義元
generateDependencyData() 依存関係が変更されたかどうかを判断するために必要なデータを生成します。 yii\caching\TagDependency
generateReusableHash() 再利用可能な依存関係データの取得に使用できる一意のハッシュを生成します。 yii\caching\Dependency
getTimestamps() 指定されたタグのタイムスタンプを返します。 yii\caching\TagDependency
touchKeys() 指定されたキャッシュキーのタイムスタンプを生成します。 yii\caching\TagDependency

プロパティの詳細

継承されたプロパティを非表示

$tags public property

この依存関係のタグ名のリスト。単一のタグの場合は、文字列として指定できます。

public string|array $tags = []

メソッドの詳細

継承されたメソッドを非表示

__call() public method

定義元: yii\base\BaseObject::__call()

クラスメソッドではない、指定されたメソッドを呼び出します。

これはPHPのマジックメソッドであり、不明なメソッドが呼び出されたときに暗黙的に呼び出されるため、直接このメソッドを呼び出さないでください。

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

メソッド名
$params array

メソッドパラメータ
戻り値 mixed

メソッドの戻り値
例外 yii\base\UnknownMethodException

不明なメソッドを呼び出した場合

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() public method

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

コンストラクタ。

デフォルトの実装は2つのことを行います

  • 指定された構成$configを使用してオブジェクトを初期化します。
  • init()を呼び出します。

このメソッドを子クラスでオーバーライドする場合は、

  • コンストラクタの最後のパラメータが、ここで示すように$configのような構成配列であることをお勧めします。
  • コンストラクタの最後に親の実装を呼び出してください。
public void __construct ( $config = [] )
$config array

オブジェクトのプロパティを初期化するために使用される名前と値のペア

 

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

定義位置: yii\base\BaseObject::__get()

オブジェクトのプロパティの値を返します。

これはPHPのマジックメソッドであり、`$value = $object->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)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() publicメソッド

定義位置: yii\base\BaseObject::__isset()

プロパティが設定されているかどうか（定義されていてnullではないか）をチェックします。

これはPHPのマジックメソッドであり、`isset($object->property)`を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。

プロパティが定義されていない場合は、falseが返されることに注意してください。

こちらも参照: https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

プロパティ名またはイベント名
戻り値 boolean

指定されたプロパティが設定されているかどうか（nullでないかどうか）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() publicメソッド

定義位置: yii\base\BaseObject::__set()

オブジェクトのプロパティの値を設定します。

これはPHPのマジックメソッドであり、`$object->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)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() publicメソッド

定義位置: yii\base\BaseObject::__unset()

オブジェクトのプロパティをnullに設定します。

これはPHPのマジックメソッドであり、`unset($object->property)`を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。

プロパティが定義されていない場合、このメソッドは何もしません。プロパティが読み取り専用の場合は、例外をスローします。

こちらも参照: https://www.php.net/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);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
canGetProperty() publicメソッド

定義位置: yii\base\BaseObject::canGetProperty()

プロパティを読み取ることができるかどうかを示す値を返します。

プロパティは、以下の場合に読み取り可能です。

  • クラスが指定された名前に関連付けられたゲッターメソッドを持つ場合（この場合、プロパティ名はケースインセンシティブです）。
  • クラスが指定された名前のメンバ変数を持つ場合（`$checkVars`がtrueの場合）。

こちらも参照: canSetProperty().

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

プロパティ名
$checkVars boolean

メンバ変数をプロパティとして扱うかどうか
戻り値 boolean

プロパティを読み取ることができるかどうか

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() publicメソッド

定義位置: yii\base\BaseObject::canSetProperty()

プロパティを設定できるかどうかを示す値を返します。

プロパティは、以下の場合に書き込み可能です。

  • クラスが指定された名前に関連付けられたセッターメソッドを持つ場合（この場合、プロパティ名はケースインセンシティブです）。
  • クラスが指定された名前のメンバ変数を持つ場合（`$checkVars`がtrueの場合）。

こちらも参照: canGetProperty().

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

プロパティ名
$checkVars boolean

メンバ変数をプロパティとして扱うかどうか
戻り値 boolean

プロパティに書き込むことができるかどうか

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public staticメソッド
2.0.14以降非推奨。PHP >= 5.5では、代わりに`::class`を使用してください。

定義位置: yii\base\BaseObject::className()

このクラスの完全修飾名を返します。

public static string className ( )
戻り値 string

このクラスの完全修飾名。

 

                public static function className()
{
    return get_called_class();
}
evaluateDependency() publicメソッド

定義位置: yii\caching\Dependency::evaluateDependency()

依存関係に関連するデータを生成および保存することにより、依存関係を評価します。

このメソッドは、データがキャッシュに書き込まれる前にキャッシュによって呼び出されます。

public void evaluateDependency ( $cache )
$cache yii\caching\CacheInterface

現在この依存関係を評価しているキャッシュコンポーネント

 

                public function evaluateDependency($cache)
{
    if ($this->reusable) {
        $hash = $this->generateReusableHash();
        if (!array_key_exists($hash, self::$_reusableData)) {
            self::$_reusableData[$hash] = $this->generateDependencyData($cache);
        }
        $this->data = self::$_reusableData[$hash];
    } else {
        $this->data = $this->generateDependencyData($cache);
    }
}
generateDependencyData() protectedメソッド

依存関係が変更されたかどうかを判断するために必要なデータを生成します。

このクラスではこのメソッドは何もしません。

protected mixed generateDependencyData ( $cache )
$cache yii\caching\CacheInterface

現在この依存関係を評価しているキャッシュコンポーネント
戻り値 mixed

依存関係が変更されたかどうかを判断するために必要なデータ。

 

                protected function generateDependencyData($cache)
{
    $timestamps = $this->getTimestamps($cache, (array) $this->tags);
    $newKeys = [];
    foreach ($timestamps as $key => $timestamp) {
        if ($timestamp === false) {
            $newKeys[] = $key;
        }
    }
    if (!empty($newKeys)) {
        $timestamps = array_merge($timestamps, static::touchKeys($cache, $newKeys));
    }
    return $timestamps;
}
generateReusableHash() protectedメソッド

定義位置: yii\caching\Dependency::generateReusableHash()

再利用可能な依存関係データの取得に使用できる一意のハッシュを生成します。

こちらも参照してください $reusable。

protected string generateReusableHash ( )
戻り値 string

このキャッシュ依存関係の一意のハッシュ値。

 

                protected function generateReusableHash()
{
    $clone = clone $this;
    $clone->data = null; // https://github.com/yiisoft/yii2/issues/3052
    try {
        $serialized = serialize($clone);
    } catch (\Exception $e) {
        // unserializable properties are nulled
        foreach ($clone as $name => $value) {
            if (is_object($value) && $value instanceof \Closure) {
                $clone->{$name} = null;
            }
        }
        $serialized = serialize($clone);
    }
    return sha1($serialized);
}
getHasChanged() publicメソッド
バージョン2.0.11から非推奨。バージョン2.1で削除されます。isChanged() を代わりに使用してください。

定義位置: yii\caching\Dependency::getHasChanged()

依存関係が変更されたかどうかを示す値を返します。

public boolean getHasChanged ( $cache )
$cache yii\caching\CacheInterface

現在この依存関係を評価しているキャッシュコンポーネント
戻り値 boolean

依存関係が変更されたかどうか。

 

                public function getHasChanged($cache)
{
    return $this->isChanged($cache);
}
getTimestamps() protectedメソッド

指定されたタグのタイムスタンプを返します。

protected array getTimestamps ( $cache, $tags )
$cache yii\caching\CacheInterface
$tags string[]
戻り値 array

指定されたタグでインデックスされたタイムスタンプ。

 

                protected function getTimestamps($cache, $tags)
{
    if (empty($tags)) {
        return [];
    }
    $keys = [];
    foreach ($tags as $tag) {
        $keys[] = $cache->buildKey([__CLASS__, $tag]);
    }
    return $cache->multiGet($keys);
}
hasMethod() publicメソッド

定義位置: yii\base\BaseObject::hasMethod()

メソッドが定義されているかどうかを示す値を返します。

デフォルトの実装は、PHP関数`method_exists()`の呼び出しです。PHPマジックメソッド`__call()`を実装した場合は、このメソッドをオーバーライドできます。

public boolean hasMethod ( $name )
$name string

メソッド名
戻り値 boolean

メソッドが定義されているかどうか。

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() publicメソッド

定義位置: yii\base\BaseObject::hasProperty()

プロパティが定義されているかどうかを示す値を返します。

プロパティは、以下の場合に定義されます。

  • クラスが、指定された名前と関連付けられたゲッターまたはセッターメソッドを持っている場合（この場合、プロパティ名はケースインセンシティブです）。
  • クラスが指定された名前のメンバ変数を持つ場合（`$checkVars`がtrueの場合）。

こちらも参照してください

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

プロパティ名
$checkVars boolean

メンバ変数をプロパティとして扱うかどうか
戻り値 boolean

プロパティが定義されているかどうか。

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() publicメソッド

定義位置: yii\base\BaseObject::init()

オブジェクトを初期化します。

このメソッドは、オブジェクトが指定された構成で初期化された後、コンストラクタの最後に呼び出されます。

public void init ( )

                public function init()
{
}
invalidate() public staticメソッド

指定された$tagsのいずれかに関連付けられているすべてのキャッシュされたデータ項目を無効にします。

public static void invalidate ( $cache, $tags )
$cache yii\caching\CacheInterface

データ項目をキャッシュするキャッシュコンポーネント。
$tags string|array 

                public static function invalidate($cache, $tags)
{
    $keys = [];
    foreach ((array) $tags as $tag) {
        $keys[] = $cache->buildKey([__CLASS__, $tag]);
    }
    static::touchKeys($cache, $keys);
}
isChanged() publicメソッド (バージョン2.0.11から利用可能)

依存関係が変更されたかどうかをチェックします。

public boolean isChanged ( $cache )
$cache yii\caching\CacheInterface

現在この依存関係を評価しているキャッシュコンポーネント
戻り値 boolean

依存関係が変更されたかどうか。

 

                public function isChanged($cache)
{
    $timestamps = $this->getTimestamps($cache, (array) $this->tags);
    return $timestamps !== $this->data;
}
resetReusableData() public staticメソッド

定義位置: yii\caching\Dependency::resetReusableData()

再利用可能な依存関係のすべてのキャッシュされたデータをリセットします。

public static void resetReusableData ( )

                public static function resetReusableData()
{
    self::$_reusableData = [];
}
touchKeys() protected staticメソッド

指定されたキャッシュキーのタイムスタンプを生成します。

protected static array touchKeys ( $cache, $keys )
$cache yii\caching\CacheInterface
$keys string[]
戻り値 array

キャッシュキーでインデックスされたタイムスタンプ。

 

                protected static function touchKeys($cache, $keys)
{
    $items = [];
    $time = microtime();
    foreach ($keys as $key) {
        $items[$key] = $time;
    }
    $cache->multiSet($items);
    return $items;
}