PdoCache
class PdoCache extends AbstractCache implements PruneableInterface
Traits
PdoTrait | |
AbstractTrait | |
LoggerAwareTrait |
Methods
hasItem($key) {@inheritdoc} | from AbstractTrait | |
clear() {@inheritdoc} | from AbstractTrait | |
deleteItem($key) {@inheritdoc} | from AbstractTrait | |
deleteItems(array $keys) {@inheritdoc} | from AbstractTrait | |
bool | enableVersioning(bool $enable = true) Enables/disables versioning of items. | from AbstractTrait |
reset() {@inheritdoc} | from AbstractTrait | |
static | handleUnserializeCallback($class) | from AbstractTrait |
get($key, $default = null) {@inheritdoc} | from AbstractCache | |
set($key, $value, $ttl = null) {@inheritdoc} | from AbstractCache | |
getMultiple($keys, $default = null) {@inheritdoc} | from AbstractCache | |
setMultiple($values, $ttl = null) {@inheritdoc} | from AbstractCache | |
deleteMultiple($keys) {@inheritdoc} | from AbstractCache | |
createTable() Creates the table to store cache items which can be called once for setup. | from PdoTrait | |
prune() {@inheritdoc} | from PdoTrait | |
__construct($connOrDsn, string $namespace = '', int $defaultLifetime, array $options = array()) You can either pass an existing database connection as PDO instance or a Doctrine DBAL Connection or a DSN string that will be used to lazy-connect to the database when the cache is actually used. |
Details
hasItem($key)
{@inheritdoc}
Parameters
$key |
clear()
{@inheritdoc}
deleteItem($key)
{@inheritdoc}
Parameters
$key |
deleteItems(array $keys)
{@inheritdoc}
Parameters
array | $keys |
bool enableVersioning(bool $enable = true)
Enables/disables versioning of items.
When versioning is enabled, clearing the cache is atomic and doesn't require listing existing keys to proceed, but old keys may need garbage collection and extra round-trips to the back-end are required.
Calling this method also clears the memoized namespace version and thus forces a resynchonization of it.
Parameters
bool | $enable |
Return Value
bool | the previous state of versioning |
reset()
{@inheritdoc}
static handleUnserializeCallback($class)
Parameters
$class |
get($key, $default = null)
{@inheritdoc}
Parameters
$key | ||
$default |
set($key, $value, $ttl = null)
{@inheritdoc}
Parameters
$key | ||
$value | ||
$ttl |
getMultiple($keys, $default = null)
{@inheritdoc}
Parameters
$keys | ||
$default |
setMultiple($values, $ttl = null)
{@inheritdoc}
Parameters
$values | ||
$ttl |
deleteMultiple($keys)
{@inheritdoc}
Parameters
$keys |
createTable()
Creates the table to store cache items which can be called once for setup.
Cache ID are saved in a column of maximum length 255. Cache data is saved in a BLOB.
Exceptions
PDOException | When the table already exists |
DBALException | When the table already exists |
DomainException | When an unsupported PDO driver is used |
prune()
{@inheritdoc}
__construct($connOrDsn, string $namespace = '', int $defaultLifetime, array $options = array())
You can either pass an existing database connection as PDO instance or a Doctrine DBAL Connection or a DSN string that will be used to lazy-connect to the database when the cache is actually used.
List of available options: * dbtable: The name of the table [default: cacheitems] * dbidcol: The column where to store the cache id [default: itemid] * dbdatacol: The column where to store the cache data [default: itemdata] * dblifetimecol: The column where to store the lifetime [default: itemlifetime] * dbtimecol: The column where to store the timestamp [default: itemtime] * dbusername: The username when lazy-connect [default: ''] * dbpassword: The password when lazy-connect [default: ''] * dbconnectionoptions: An array of driver-specific connection options [default: array()]
Parameters
$connOrDsn | ||
string | $namespace | |
int | $defaultLifetime | |
array | $options |
Exceptions
InvalidArgumentException | When first argument is not PDO nor Connection nor string |
InvalidArgumentException | When PDO error mode is not PDO::ERRMODE_EXCEPTION |
InvalidArgumentException | When namespace contains invalid characters |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Cache/Simple/PdoCache.html