classes/phing/util/DataStore.php

\DataStore

An abstract representation of file and directory pathnames.

author
Michiel Rook
package
phing.util
version
$Revision: 543 $

Properties

Propertyprivate  $data= 'array'
Default valuearrayDetails
Type
Propertyprivate  $file= 'null'
Default valuenullDetails
Type

Methods

methodpublic  __construct( \PhingFile $file ) :
Constructs a new data store
Parameters
Name Type Description
$file \PhingFile object pointing to the data store on disk
methodpublic  __destruct( ) :
Destructor
methodpublic  commit( ) : \none
Commits data store to disk
Returns
Type Description
\none
methodpublic  get( string $key ) : mixed
Retrieves a value from the data store
Parameters
Name Type Description
$key string the key
Returns
Type Description
mixed
methodpublic  put( string $key, mixed $value, boolean $autocommit = false ) : \none
Adds a value to the data store
Parameters
Name Type Description
$key string the key
$value mixed the value
$autocommit boolean

whether to auto-commit (write) the data store to disk

Returns
Type Description
\none
methodprivate  read( ) : \none
Internal function to read data store from file
Returns
Type Description
\none
methodprivate  write( ) : \none
Internal function to write data store to file
Returns
Type Description
\none
Documentation was generated by DocBlox 0.13.1.