Final Class Yiisoft\Db\Cache\SchemaCache

All Classes | Methods

Inheritance	Yiisoft\Db\Cache\SchemaCache

Implements a cache for the database schema information.

The {@see \Yiisoft\Db\Schema\AbstractSchema} retrieves information about the database schema from the database server and stores it in the cache for faster access. When the {@see \Yiisoft\Db\Schema\AbstractSchema} needs to retrieve information about the database schema, it first checks the cache using {@see \Yiisoft\Db\Cache\SchemaCache}. If the information is not in the cache, the Schema retrieves it from the database server and stores it in the cache using the {@see \Yiisoft\Db\Cache\SchemaCache}.

{@see \Yiisoft\Db\Schema\AbstractSchema} uses this implementation to cache table metadata.

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		Yiisoft\Db\Cache\SchemaCache
get()	Retrieve value from cache.	Yiisoft\Db\Cache\SchemaCache
getDuration()		Yiisoft\Db\Cache\SchemaCache
invalidate()	Invalidates all the cached values associated with any of the specified tags.	Yiisoft\Db\Cache\SchemaCache
isEnabled()	Return true if SchemaCache is active.	Yiisoft\Db\Cache\SchemaCache
isExcluded()		Yiisoft\Db\Cache\SchemaCache
remove()	Remove a value with the specified key from cache.	Yiisoft\Db\Cache\SchemaCache
set()	Persists data in the cache, uniquely referenced by a key with an optional tag.	Yiisoft\Db\Cache\SchemaCache
setDuration()	Number of seconds that table metadata can remain valid in cache. Use 'null' to indicate that the cached data will never expire.	Yiisoft\Db\Cache\SchemaCache
setEnabled()	Whether to enable schema caching.	Yiisoft\Db\Cache\SchemaCache
setExclude()	List of tables not to cache metadata for.	Yiisoft\Db\Cache\SchemaCache

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( \Psr\SimpleCache\CacheInterface $psrCache )
$psrCache	\Psr\SimpleCache\CacheInterface	PSR-16 cache implementation to use.

Source code

                public function __construct(private CacheInterface $psrCache) {}

get() public method

Retrieve value from cache.

public mixed get ( mixed $key )
$key	mixed	The key identifying the value to cache.
return	mixed	Cache value.
throws	\Psr\SimpleCache\InvalidArgumentException

Source code

                public function get(mixed $key): mixed
{
    $stringKey = $this->normalize($key);
    return $this->psrCache->get($stringKey);
}

getDuration() public method

public DateInterval\|integer\|null getDuration ( )
return	DateInterval\|integer\|null	The number of seconds that table metadata can remain valid in cache.

Source code

                public function getDuration(): int|DateInterval|null
{
    return $this->duration;
}

invalidate() public method

Invalidates all the cached values associated with any of the specified tags.

public void invalidate ( string $cacheTag )
$cacheTag	string	The cache tag used to identify the values to invalidate.
throws	\Psr\SimpleCache\InvalidArgumentException

Source code

                public function invalidate(string $cacheTag): void
{
    if (empty($cacheTag)) {
        return;
    }
    /** @var string[] $data */
    $data = $this->psrCache->get($cacheTag, []);
    foreach ($data as $key) {
        $this->psrCache->delete($key);
    }
}

isEnabled() public method

Return true if SchemaCache is active.

public boolean isEnabled ( )

Source code

                public function isEnabled(): bool
{
    return $this->enabled;
}

isExcluded() public method

public boolean isExcluded ( string $value )
$value	string	The table name.
return	boolean	Whether to exclude the table from caching.

Source code

                public function isExcluded(string $value): bool
{
    return in_array($value, $this->exclude, true);
}

remove() public method

Remove a value with the specified key from cache.

public void remove ( mixed $key )
$key	mixed	A key identifying the value to delete from cache.
throws	\Psr\SimpleCache\InvalidArgumentException

Source code

                public function remove(mixed $key): void
{
    $stringKey = $this->normalize($key);
    $this->psrCache->delete($stringKey);
}

set() public method

Persists data in the cache, uniquely referenced by a key with an optional tag.

public void set ( mixed $key, mixed $value, string\|null $tag = null )
$key	mixed	The key of the item to store.
$value	mixed	The value of the item to store.
$tag	string\|null	Cache tag.
throws	\Psr\SimpleCache\InvalidArgumentException	If the $key string isn't a legal value.
throws	RuntimeException	If cache value isn't set.

Source code

                public function set(mixed $key, mixed $value, ?string $tag = null): void
{
    $stringKey = $this->normalize($key);
    if ($this->psrCache->set($stringKey, $value, $this->duration)) {
        $this->addToTag($stringKey, $tag);
        return;
    }
    throw new RuntimeException('Cache value not set.');
}

setDuration() public method

Number of seconds that table metadata can remain valid in cache. Use 'null' to indicate that the cached data will never expire.

public void setDuration ( DateInterval\|integer\|null $value )
$value	DateInterval\|integer\|null	The number of seconds that table metadata can remain valid in cache.

public void setEnabled ( boolean $value )
$value	boolean	Whether to enable schema caching.

public void setExclude ( array $value )
$value	array	The table names.