PdoAdapter

class PdoAdapter extends AbstractAdapter

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
static handleUnserializeCallback($class) from AbstractTrait
static AdapterInterface createSystemCache(string $namespace, int $defaultLifetime, string $version, string $directory, LoggerInterface $logger = null) from AbstractAdapter
static createConnection($dsn, array $options = array()) from AbstractAdapter
CacheItem getItem($key)

{@inheritdoc}

from AbstractAdapter
getItems(array $keys = array())

{@inheritdoc}

from AbstractAdapter
save(CacheItemInterface $item)

{@inheritdoc}

from AbstractAdapter
saveDeferred(CacheItemInterface $item)

{@inheritdoc}

from AbstractAdapter
commit()

{@inheritdoc}

from AbstractAdapter
__destruct() from AbstractAdapter
createTable()

Creates the table to store cache items which can be called once for setup.

from PdoTrait
__construct(PDO|Connection|string $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

static handleUnserializeCallback($class)

Parameters

$class

static AdapterInterface createSystemCache(string $namespace, int $defaultLifetime, string $version, string $directory, LoggerInterface $logger = null)

Parameters

string $namespace
int $defaultLifetime
string $version
string $directory
LoggerInterface $logger

Return Value

AdapterInterface

static createConnection($dsn, array $options = array())

Parameters

$dsn
array $options

CacheItem getItem($key)

{@inheritdoc}

Parameters

$key

Return Value

CacheItem

getItems(array $keys = array())

{@inheritdoc}

return \Traversable|CacheItem[]

Parameters

array $keys

save(CacheItemInterface $item)

{@inheritdoc}

Parameters

CacheItemInterface $item

saveDeferred(CacheItemInterface $item)

{@inheritdoc}

Parameters

CacheItemInterface $item

commit()

{@inheritdoc}

__destruct()

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

__construct(PDO|Connection|string $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

PDO|Connection|string $connOrDsn A \PDO or Connection instance or DSN string or null
string $namespace
int $defaultLifetime
array $options An associative array of 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/3.3/Symfony/Component/Cache/Adapter/PdoAdapter.html