SharedDocuments Class Reference

Collaboration diagram for SharedDocuments:

Static Public Member Functions
static	getLimit ()
static	setLimit ($limit)
static &	get ($key)
static	set ($key, &$item, $force=false)
static	remove ($key)
static	clear ()
static	getKeys ()
static	exists ($key)
static	isShared ($key, &$item)

Static Protected Attributes
static	$limit = MAXGDOCS

Detailed Description

Manage Shared documents through the global array $gdocs

Definition at line 11 of file SharedDocuments.php.

Member Function Documentation

static clear ( )

static

unset all objects referenced in shared object

Returns

bool

Definition at line 97 of file SharedDocuments.php.

static exists (   $key )

static

Verify if a key is referenced in shared object

Parameters

string

$key

object identifier

Returns

bool

Definition at line 120 of file SharedDocuments.php.

static& get (   $key )

static

Retrieve object from key identifier

Parameters

string

$key

document identifier

Returns

|null

Definition at line 37 of file SharedDocuments.php.

static getKeys ( )

static

Return all keys referenced in shared object

Returns

array referenced keys returns

Definition at line 107 of file SharedDocuments.php.

static getLimit ( )

static

Returns

int

Definition at line 17 of file SharedDocuments.php.

static isShared (   $key, &  $item  )

static

Verify if a key is referenced in cached and object is same as item object

Parameters

string	$key	object identifier
\Doc	$item	object item

Returns

bool true if $key and item match

Definition at line 134 of file SharedDocuments.php.

static remove (   $key )

static

Unset object

Parameters

string

$key

object identifier

Returns

bool

Definition at line 81 of file SharedDocuments.php.

static set (   $key, &  $item,   $force = false  )

static

Add or update an object

Parameters

string	$key	object identifier
\Doc	$item	object to add or update
bool	$force	set to true to add without limits

Returns

bool

Definition at line 60 of file SharedDocuments.php.

static setLimit (   $limit )

static

Parameters

int

$limit

Exceptions

\Dcp\Exception

Definition at line 25 of file SharedDocuments.php.

Field Documentation

$limit = MAXGDOCS

staticprotected

Definition at line 13 of file SharedDocuments.php.

---

The documentation for this class was generated from the following file:

• SharedDocuments.php