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.


				
				 public 
				
				

				exists(  $key )
				

				: boolean


				
				 public 
				
				

				retrieve( mixed $key,  $default = null )
				

				: mixed|null

$key: $default The value returned if the key does not exists. Defaults to null.
$default

mixed|null
The value associated with the key, or null if the key doesn't exists.

ICanBoogie\Storage\Cache::retrieve()


				
				 public 
				
				

				store( string $key, mixed $value, string $ttl = 0 )

$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.

Exception
when a file operation fails.

ICanBoogie\Storage\Storage::store()


				
				 public 
				
				

				eliminate( string $key )


				
				 protected 
				
				

				normalize_key( string $key )
				

				: string

Normalizes a key into a valid filename.


				
				 protected 
				
				

				format_pathname( string $key )
				

				: string

Formats a key into an absolute pathname.


				
				 protected 
				
				

				format_pathname_with_ttl( string $pathname )
				

				: string

Formats a pathname with a TTL extension.


				
				 protected 
				
				

				serialize( mixed $value )
				

				: string

Serializes a value so that it can be stored.


				
				 protected 
				
				

				unserialize( string $value )
				

				: mixed

Unserializes a value retrieved from storage.


				
				 public 
				
				

				getIterator( void )
				

				: Iterator


				
				 public 
				
				

				matching( string $regex )
				

				: ICanBoogie\Storage\FileStorageIterator

Returns an iterator for the keys matching a specified regex.


				
				 public 
				
				

				check_writable( void )
				

				: boolean

Checks whether the storage directory is writable.

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


				
MAGIC				

                : string

Magic pattern used to recognize automatically serialized values.

"VAR\0SLZ\0"


				
MAGIC_LENGTH				

                : integer


				
				protected  
				

				
$path				

				: string

Absolute path to the storage directory.