Sections

Class Phalcon\Cache

Исходный код на GitHub

Namespace Phalcon   Uses Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Cache\Exception\Exception, Phalcon\Cache\Exception\InvalidArgumentException, Psr\SimpleCache\CacheInterface, Traversable   Implements CacheInterface

This component offers caching capabilities for your application. Phalcon\Cache implements PSR-16.

Properties

/**
 * The adapter
 *
 * @var AdapterInterface
 */
protected adapter;

Методы

public function __construct( AdapterInterface $adapter ): void;

Constructor.

public function clear(): bool;

Wipes clean the entire cache’s keys.

@return bool True on success and false on failure.

public function delete( mixed $key ): bool;

Delete an item from the cache by its unique key.

@return bool True if the item was successfully removed. False if there was an error.

@throws Phalcon\Cache\Exception\InvalidArgumentException MUST be thrown if the $key string is not a legal value.

public function deleteMultiple( mixed $keys ): bool;

Deletes multiple cache items in a single operation.

@return bool True if the items were successfully removed. False if there was an error.

@throws Phalcon\Cache\Exception\InvalidArgumentException MUST be thrown if $keys is neither an array nor a Traversable, or if any of the $keys are not a legal value.

public function get( mixed $key, mixed $defaultValue = null ): mixed;

Fetches a value from the cache.

@return mixed The value of the item from the cache, or $default in case of cache miss.

@throws Phalcon\Cache\Exception\InvalidArgumentException MUST be thrown if the $key string is not a legal value.

public function getAdapter(): AdapterInterface
public function getMultiple( mixed $keys, mixed $defaultValue = null ): mixed;

Obtains multiple cache items by their unique keys.

@return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.

@throws Phalcon\Cache\Exception\InvalidArgumentException MUST be thrown if $keys is neither an array nor a Traversable, or if any of the $keys are not a legal value.

public function has( mixed $key ): bool;

Determines whether an item is present in the cache.

@return bool

@throws Phalcon\Cache\Exception\InvalidArgumentException MUST be thrown if the $key string is not a legal value.

public function set( mixed $key, mixed $value, mixed $ttl = null ): bool;

Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.

                                 the driver supports TTL then the library may set a default value
                                 for it or let the driver take care of that.

@return bool True on success and false on failure.

@throws Phalcon\Cache\Exception\InvalidArgumentException MUST be thrown if the $key string is not a legal value.

public function setMultiple( mixed $values, mixed $ttl = null ): bool;

Persists a set of key => value pairs in the cache, with an optional TTL.

                                  the driver supports TTL then the library may set a default value
                                  for it or let the driver take care of that.

@return bool True on success and false on failure.

@throws Phalcon\Cache\Exception\InvalidArgumentException MUST be thrown if $values is neither an array nor a Traversable, or if any of the $values are not a legal value.

protected function checkKey( mixed $key ): void;

Checks the key. If it contains invalid characters an exception is thrown

protected function checkKeys( mixed $keys ): void;

Checks the key. If it contains invalid characters an exception is thrown

Interface Phalcon\Cache\Adapter\AdapterInterface

Исходный код на GitHub

Namespace Phalcon\Cache\Adapter   Uses Phalcon\Storage\Adapter\AdapterInterface   Extends StorageAdapterInterface

Interface for Phalcon\Cache adapters

Class Phalcon\Cache\Adapter\Apcu

Исходный код на GitHub

Namespace Phalcon\Cache\Adapter   Uses Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Storage\Adapter\Apcu   Extends StorageApcu   Implements CacheAdapterInterface

Apcu adapter

Class Phalcon\Cache\Adapter\Libmemcached

Исходный код на GitHub

Namespace Phalcon\Cache\Adapter   Uses Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Storage\Adapter\Libmemcached   Extends StorageLibmemcached   Implements CacheAdapterInterface

Libmemcached adapter

Class Phalcon\Cache\Adapter\Memory

Исходный код на GitHub

Namespace Phalcon\Cache\Adapter   Uses Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Storage\Adapter\Memory   Extends StorageMemory   Implements CacheAdapterInterface

Memory adapter

Class Phalcon\Cache\Adapter\Redis

Исходный код на GitHub

Namespace Phalcon\Cache\Adapter   Uses Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Storage\Adapter\Redis   Extends StorageRedis   Implements CacheAdapterInterface

Redis adapter

Class Phalcon\Cache\Adapter\Stream

Исходный код на GitHub

Namespace Phalcon\Cache\Adapter   Uses Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Storage\Adapter\Stream   Extends StorageStream   Implements CacheAdapterInterface

Stream adapter

Class Phalcon\Cache\AdapterFactory

Исходный код на GitHub

Namespace Phalcon\Cache   Uses Phalcon\Cache\Adapter\AbstractAdapter, Phalcon\Cache\Exception\Exception, Phalcon\Factory\AbstractFactory, Phalcon\Storage\SerializerFactory   Extends AbstractFactory

Factory to create Cache adapters

Properties

/**
 * @var SerializerFactory
 */
private serializerFactory;

Методы

public function __construct( SerializerFactory $factory = null, array $services = [] );

AdapterFactory constructor.

public function newInstance( string $name, array $options = [] ): AbstractAdapter;

Create a new instance of the adapter

protected function getAdapters(): array;

Returns the available adapters

Class Phalcon\Cache\CacheFactory

Исходный код на GitHub

Namespace Phalcon\Cache   Uses Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Cache\AdapterFactory, Phalcon\Cache, Phalcon\Cache\CacheInterface, Phalcon\Cache\Exception\Exception, Phalcon\Config, Phalcon\Helper\Arr

Creates a new Cache class

Properties

/**
 * @var AdapterFactory
 */
protected adapterFactory;

Методы

public function __construct( AdapterFactory $factory );

Constructor

public function load( mixed $config ): mixed;

Factory to create an instace from a Config object

public function newInstance( string $name, array $options = [] ): CacheInterface;

Constructs a new Cache instance.

Class Phalcon\Cache\Exception\Exception

Исходный код на GitHub

Namespace Phalcon\Cache\Exception   Extends \Phalcon\Exception   Implements \Psr\SimpleCache\CacheException

Exceptions thrown in Phalcon\Cache will use this class

Class Phalcon\Cache\Exception\InvalidArgumentException

Исходный код на GitHub

Namespace Phalcon\Cache\Exception   Extends \Phalcon\Exception   Implements \Psr\SimpleCache\InvalidArgumentException

Exceptions thrown in Phalcon\Cache will use this class