util/DataStore.php

Show: inherited
Table of Contents

An abstract representation of file and directory pathnames.

Author
Michiel Rook  
Package
phing.util  
Version
$Id$  

\DataStore

Package: phing\util

An abstract representation of file and directory pathnames.

Author
Michiel Rook  
Version
$Id$  

Properties

Propertyprivate  $data= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $file= 'null'
Default valuenullDetails
Type
n/a

Methods

methodpublic__construct( \PhingFile $file ) : void

Constructs a new data store

Parameters
Name Type Description
$file \PhingFile

object pointing to the data store on disk

methodpublic__destruct( ) : void

Destructor

methodpubliccommit( ) : \none

Commits data store to disk

Returns
Type Description
\none
methodpublicget( string $key ) : mixed

Retrieves a value from the data store

Parameters
Name Type Description
$key string

the key

Returns
Type Description
mixed the value
methodpublicput( 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
methodprivateread( ) : \none

Internal function to read data store from file

Returns
Type Description
\none
methodprivatewrite( ) : \none

Internal function to write data store to file

Returns
Type Description
\none
Documentation was generated by DocBlox 0.18.1.