ICanBoogie
  • Documentation
  • API Reference
  • Storage v1.0.1
Namespaces
  • ICanBoogie
    • Storage
Classes
  • APCStorage
  • FileStorage
  • FileStorageIterator
Interfaces
  • StorageInterface
Traits
  • ArrayAccessTrait

Class FileStorage

A storage using the file system.

ICanBoogie\Storage\FileStorage implements ArrayAccess, IteratorAggregate, ICanBoogie\Storage\StorageInterface uses ICanBoogie\Storage\ArrayAccessTrait
Namespace: ICanBoogie\Storage
Located at FileStorage.php

Methods summary

public __construct( string $path )

Constructor.

Constructor.

Parameters

$path
Absolute path to the storage directory.
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\StorageInterface::store()
public retrieve( mixed $name, $default = null ) : mixed|null

Parameters

$name
$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\StorageInterface::retrieve()
public eliminate( string $name )

Parameters

$name
$key

Inheritdoc

Implementation of

ICanBoogie\Storage\StorageInterface::eliminate()
public exists( string $name ) : boolean

Parameters

$name
$key

Returns

boolean
true if the key exists, false otherwise.

Inheritdoc

Implementation of

ICanBoogie\Storage\StorageInterface::exists()
public clear( void )

Clears the cache.

Clears the cache.

Implementation of

ICanBoogie\Storage\StorageInterface::clear()
public getIterator( void ) : ICanBoogie\Storage\FileStorageIterator

Returns an iterator for the storage.

Returns an iterator for the storage.

Returns

ICanBoogie\Storage\FileStorageIterator

Implementation of

IteratorAggregate::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 ArrayAccess

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

Methods used from ICanBoogie\Storage\ArrayAccessTrait

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

Constants summary

MAGIC : string

Magic pattern used to recognized automatically serialized values.

Magic pattern used to recognized 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 v1.0.1 – Check on GitHub – API documentation generated by ApiGen