PHP Class Neos\Cache\Backend\PdoBackend

Inheritance: extends AbstractBackend, implements Neos\Cache\Backend\TaggableBackendInterface, implements IterableBackendInterface, implements Neos\Cache\Backend\PhpCapableBackendInterface, use trait RequireOnceFromValueTrait
ファイルを表示 Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$cacheEntriesIterator ArrayIterator
$dataSourceName string
$databaseHandle PDO
$password string
$pdoDriver string
$username string

Public Methods

Method Description
collectGarbage ( ) : void Does garbage collection
current ( ) : mixed Returns the data of the current cache entry pointed to by the cache entry iterator.
findIdentifiersByTag ( string $tag ) : array Finds and returns all cache entry identifiers which are tagged by the specified tag.
flush ( ) : void Removes all cache entries of this cache.
flushByTag ( string $tag ) : void Removes all cache entries of this cache which are tagged by the specified tag.
get ( string $entryIdentifier ) : mixed Loads data from the cache.
has ( string $entryIdentifier ) : boolean Checks if a cache entry with the specified identifier exists.
initializeObject ( ) : void Initialize the cache backend.
key ( ) : string Returns the identifier of the current cache entry pointed to by the cache entry iterator.
next ( ) : void Move forward to the next cache entry.
remove ( string $entryIdentifier ) : boolean Removes all cache entries matching the specified identifier.
rewind ( ) : void Rewinds the cache entry iterator to the first element and fetches cacheEntries.
set ( string $entryIdentifier, string $data, array $tags = [], integer $lifetime = null ) : void Saves data in the cache.
setDataSourceName ( string $DSN ) : void Sets the DSN to use
setPassword ( string $password ) : void Sets the password to use
setUsername ( string $username ) : void Sets the username to use
valid ( ) : boolean Checks if the current position of the cache entry iterator is valid.

Protected Methods

Method Description
connect ( ) : void Connect to the database
createCacheTables ( ) : void Creates the tables needed for the cache backend.
getNotExpiredStatement ( ) : string Returns an SQL statement that evaluates to true if the entry is not expired.

Method Details

collectGarbage() public method

Does garbage collection
public collectGarbage ( ) : void
return void

connect() protected method

Connect to the database
protected connect ( ) : void
return void

createCacheTables() protected method

Creates the tables needed for the cache backend.
protected createCacheTables ( ) : void
return void

current() public method

Returns the data of the current cache entry pointed to by the cache entry iterator.
public current ( ) : mixed
return mixed

findIdentifiersByTag() public method

Finds and returns all cache entry identifiers which are tagged by the specified tag.
public findIdentifiersByTag ( string $tag ) : array
$tag string The tag to search for
return array An array with identifiers of all matching entries. An empty array if no entries matched

flush() public method

Removes all cache entries of this cache.
public flush ( ) : void
return void

flushByTag() public method

Removes all cache entries of this cache which are tagged by the specified tag.
public flushByTag ( string $tag ) : void
$tag string The tag the entries must have
return void

get() public method

Loads data from the cache.
public get ( string $entryIdentifier ) : mixed
$entryIdentifier string An identifier which describes the cache entry to load
return mixed The cache entry's content as a string or FALSE if the cache entry could not be loaded

getNotExpiredStatement() protected method

Returns an SQL statement that evaluates to true if the entry is not expired.
protected getNotExpiredStatement ( ) : string
return string

has() public method

Checks if a cache entry with the specified identifier exists.
public has ( string $entryIdentifier ) : boolean
$entryIdentifier string An identifier specifying the cache entry
return boolean TRUE if such an entry exists, FALSE if not

initializeObject() public method

Initialize the cache backend.
public initializeObject ( ) : void
return void

key() public method

Returns the identifier of the current cache entry pointed to by the cache entry iterator.
public key ( ) : string
return string

next() public method

Move forward to the next cache entry.
public next ( ) : void
return void

remove() public method

Usually this only affects one entry but if - for what reason ever - old entries for the identifier still exist, they are removed as well.
public remove ( string $entryIdentifier ) : boolean
$entryIdentifier string Specifies the cache entry to remove
return boolean TRUE if (at least) an entry could be removed or FALSE if no entry was found

rewind() public method

Rewinds the cache entry iterator to the first element and fetches cacheEntries.
public rewind ( ) : void
return void

set() public method

Saves data in the cache.
public set ( string $entryIdentifier, string $data, array $tags = [], integer $lifetime = null ) : void
$entryIdentifier string An identifier for this specific cache entry
$data string The data to be stored
$tags array Tags to associate with this cache entry
$lifetime integer Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited liftime.
return void

setDataSourceName() public method

Sets the DSN to use
public setDataSourceName ( string $DSN ) : void
$DSN string The DSN to use for connecting to the DB
return void

setPassword() public method

Sets the password to use
public setPassword ( string $password ) : void
$password string The password to use for connecting to the DB
return void

setUsername() public method

Sets the username to use
public setUsername ( string $username ) : void
$username string The username to use for connecting to the DB
return void

valid() public method

Checks if the current position of the cache entry iterator is valid.
public valid ( ) : boolean
return boolean TRUE if the current position is valid, otherwise FALSE

Property Details

$cacheEntriesIterator protected_oe property

protected ArrayIterator $cacheEntriesIterator
return ArrayIterator

$dataSourceName protected_oe property

protected string $dataSourceName
return string

$databaseHandle protected_oe property

protected PDO $databaseHandle
return PDO

$password protected_oe property

protected string $password
return string

$pdoDriver protected_oe property

protected string $pdoDriver
return string

$username protected_oe property

protected string $username
return string