0 follower

Yii Framework 3.0 API Documentation

This is the Yii Framework API Documentation. Here you will find detailed information about all classes provided by the Framework. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 3.0 of the framework. You can use the dropdown menu on the top right to switch between versions.

You can search API documentation using the search form on the top. You can search for class names and also method and property names, e.g. ActiveRecord.save() or just .save() or ::save().

This page is also available in JSON format:
curl https://www.yiiframework.com/doc/api/3.0/cache -H 'Accept: application/json'

Class	Description
Yiisoft\Cache\ArrayCache	ArrayCache provides caching for the current request only by storing the values in an array.
Yiisoft\Cache\Cache	Cache provides support for the data caching, including cache key composition and dependencies, and uses "Probably early expiration" for cache stampede prevention. The actual data caching is performed via PSR-16 {@see \Psr\SimpleCache\CacheInterface} instance passed to constructor.
Yiisoft\Cache\CacheInterface	CacheInterface is a wrapper over PSR-16 {@see \Psr\SimpleCache\CacheInterface} that allows you to implement the cache stampede prevention using the "Probably early expiration" algorithm.
Yiisoft\Cache\CacheKeyNormalizer	CacheKeyNormalizer normalizes the cache key to a string.
Yiisoft\Cache\DependencyAwareCache	Cache provides support for the data caching, including dependencies.
Yiisoft\Cache\Dependency\AllDependencies	AllDependencies represents a dependency which is composed of a list of other dependencies.
Yiisoft\Cache\Dependency\AnyDependency	AnyDependency represents a dependency which is composed of a list of other dependencies.
Yiisoft\Cache\Dependency\CallbackDependency	CallbackDependency represents a dependency based on the result of a callback.
Yiisoft\Cache\Dependency\Dependency	Dependency is the base class for cache dependency classes.
Yiisoft\Cache\Dependency\FileDependency	FileDependency represents a dependency based on a file's last modification time.
Yiisoft\Cache\Dependency\TagDependency	TagDependency associates a cached value with one or multiple {@see TagDependency::$tags}.
Yiisoft\Cache\Dependency\ValueDependency	ValueDependency represents a dependency based on the specified value in the constructor.
Yiisoft\Cache\Exception\CacheException
Yiisoft\Cache\Exception\InvalidArgumentException
Yiisoft\Cache\Exception\RemoveCacheException
Yiisoft\Cache\Exception\SetCacheException
Yiisoft\Cache\Metadata\CacheItem	CacheItem store the metadata of cache item.
Yiisoft\Cache\Metadata\CacheItems	CacheItems store the metadata of each cache item.
Yiisoft\Cache\NullCache	NullCache does not cache anything reporting success for all methods calls.
Yiisoft\Cache\PrefixedCache	PrefixedCache decorates any PSR-16 cache to add global prefix. It is added to every cache key so that it is unique globally in the whole cache storage. It is recommended that you set a unique cache key prefix for each application if the same cache storage is being used by different applications.
Yiisoft\Cache\Serializer\PhpSerializer
Yiisoft\Cache\Serializer\SerializerInterface
Yiisoft\Cache\Ttl	Value object representing a time-to-live (TTL) duration in seconds.