Class FileStorage
A storage using the file system.
-
ICanBoogie\Storage\FileStorage
implements
ICanBoogie\Storage\Storage,
ArrayAccess,
IteratorAggregate
uses
ICanBoogie\Storage\ArrayAccessTrait
Methods summary
public
|
#
__construct( string $path )
Constructor.
Parameters
- $path
- Absolute path to the storage directory.
|
protected
string
|
#
normalize_key( string $key )
Normalizes a key into a valid filename.
Normalizes a key into a valid filename.
Parameters
Returns
string
|
protected
string
|
#
format_pathname( string $key )
Formats a key into an absolute pathname.
Formats a key into an absolute pathname.
Parameters
Returns
string
|
protected
string
|
#
format_pathname_with_ttl( string $pathname )
Formats a pathname with a TTL extension.
Formats a pathname with a TTL extension.
Parameters
Returns
string
|
protected
string
|
#
serialize( mixed $value )
Serializes a value so that it can be stored.
Serializes a value so that it can be stored.
Parameters
Returns
string
|
protected
mixed
|
#
unserialize( string $value )
Unserializes a value retrieved from storage.
Unserializes a value retrieved from storage.
Parameters
Returns
mixed
|
public
|
#
store( string $key, mixed $value, string $ttl = 0 )
Parameters
- $key
Store the variable using this name. keys are cache-unique, so storing
a second value with the same key will overwrite the original value. - $value
- The value to store.
- $ttl
Time To Live; store value in the cache for ttl seconds. After the
ttl has passed, the stored value won't be available for the next request. If no ttl is
supplied (or if the ttl is empty), the value will persist until it is removed from the
cache manually, or otherwise fails to exist in the cache. Throws
Exception
when a file operation fails.
Inheritdoc
Implementation of
|
public
mixed|null
|
#
retrieve( mixed $key, $default = null )
Parameters
- $key
- $default The value returned if the key does not exists. Defaults to
null.
- $default
Returns
mixed|null
The value associated with the key, or null if the key doesn't exists.
Inheritdoc
Implementation of
|
public
|
#
eliminate( string $key )
Parameters
Inheritdoc
Implementation of
|
public
boolean
|
#
exists( string $key )
Parameters
Returns
boolean
true if the key exists, false otherwise.
Inheritdoc
Implementation of
|
public
|
#
clear( )
Clears the cache.
Implementation of
|
public
ICanBoogie\Storage\FileStorageIterator
|
#
getIterator( )
Returns an iterator for the storage.
Returns an iterator for the storage.
Returns
Implementation of
IteratorAggregate::getIterator()
|
public
ICanBoogie\Storage\FileStorageIterator
|
#
matching( string $regex )
Returns an iterator for the keys matching a specified regex.
Returns an iterator for the keys matching a specified regex.
Parameters
Returns
|
public
boolean
|
#
check_writable( )
Checks whether the storage directory is writable.
Checks whether the storage directory is writable.
Returns
boolean
Throws
Exception
when the storage directory is not writable.
|
Methods inherited from ArrayAccess
offsetExists(),
offsetGet(),
offsetSet(),
offsetUnset()
Constants summary
string |
MAGIC
Magic pattern used to recognize automatically serialized values.
Magic pattern used to recognize automatically serialized values.
|
|
integer |
MAGIC_LENGTH
|
|
Properties summary
protected
string
|
$path
Absolute path to the storage directory.
Absolute path to the storage directory.
|
|