ICanBoogie
  • Documentation
  • API Reference
  • Storage v2.0.1
Namespaces
  • ICanBoogie
    • Storage
      • Storage
Classes
  • APCStorage
  • CacheCollection
  • FileStorage
  • FileStorageIterator
  • RedisStorage
  • RunTimeStorage
  • StorageCollection
Interfaces
  • Cache
  • Storage

Class FileStorage

A storage using the file system.

ICanBoogie\Storage\FileStorage implements ICanBoogie\Storage\Storage, ArrayAccess uses ICanBoogie\Storage\Storage\ArrayAccess, ICanBoogie\Storage\Storage\ClearWithIterator
Namespace: ICanBoogie\Storage
Located at FileStorage.php

Methods summary

public __construct( string $path )

Constructor.

Constructor.

Parameters

$path
Absolute path to the storage directory.
public exists( $key ) : boolean

Parameters

$key

Returns

boolean
true if the key exists, false otherwise.

Inheritdoc

Implementation of

ICanBoogie\Storage\Cache::exists()
public retrieve( mixed $key, $default = null ) : mixed|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

ICanBoogie\Storage\Cache::retrieve()
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

ICanBoogie\Storage\Storage::store()
public eliminate( string $key )

Parameters

$key

Inheritdoc

Implementation of

ICanBoogie\Storage\Storage::eliminate()
protected normalize_key( string $key ) : string

Normalizes a key into a valid filename.

Normalizes a key into a valid filename.

Parameters

$key

Returns

string
protected format_pathname( string $key ) : string

Formats a key into an absolute pathname.

Formats a key into an absolute pathname.

Parameters

$key

Returns

string
protected format_pathname_with_ttl( string $pathname ) : string

Formats a pathname with a TTL extension.

Formats a pathname with a TTL extension.

Parameters

$pathname

Returns

string
protected serialize( mixed $value ) : string

Serializes a value so that it can be stored.

Serializes a value so that it can be stored.

Parameters

$value

Returns

string
protected unserialize( string $value ) : mixed

Unserializes a value retrieved from storage.

Unserializes a value retrieved from storage.

Parameters

$value

Returns

mixed
public getIterator( void ) : Iterator

Returns

Iterator

Inheritdoc

Implementation of

ICanBoogie\Storage\Cache::getIterator()
public matching( string $regex ) : ICanBoogie\Storage\FileStorageIterator

Returns an iterator for the keys matching a specified regex.

Returns an iterator for the keys matching a specified regex.

Parameters

$regex

Returns

ICanBoogie\Storage\FileStorageIterator
public check_writable( void ) : boolean

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 ICanBoogie\Storage\Storage

clear()

Methods inherited from ArrayAccess

offsetExists(), offsetGet(), offsetSet(), offsetUnset()

Methods used from ICanBoogie\Storage\Storage\ArrayAccess

offsetExists(), offsetGet(), offsetSet(), offsetUnset()

Methods used from ICanBoogie\Storage\Storage\ClearWithIterator

clear()

Constants summary

MAGIC : string

Magic pattern used to recognize automatically serialized values.

Magic pattern used to recognize automatically serialized values.

"VAR\0SLZ\0"
MAGIC_LENGTH : integer

Length of the magic pattern ICanBoogie\Storage\FileStorage::MAGIC.

Length of the magic pattern ICanBoogie\Storage\FileStorage::MAGIC.

8

Properties summary

protected $path : string

Absolute path to the storage directory.

Absolute path to the storage directory.


		
Storage v2.0.1 – Check on GitHub – API documentation generated by ApiGen