SnapMetadata Class Reference
[Undocumented Classes]

INSERT BRIEF DESCRIPTION HERE. More...

Inheritance diagram for SnapMetadata:

[legend]

List of all members.

Public Member Functions
	__construct ($file)
	INSERT BRIEF DESCRIPTION HERE.
	clear ()
	INSERT BRIEF DESCRIPTION HERE.
	commit ()
	INSERT BRIEF DESCRIPTION HERE.
	getData ()
	INSERT BRIEF DESCRIPTION HERE.
	getKeys ()
	INSERT BRIEF DESCRIPTION HERE.
	put ($key, $value)
	INSERT BRIEF DESCRIPTION HERE.
	putMany ($data)
	INSERT BRIEF DESCRIPTION HERE.
	remove ($key)
	INSERT BRIEF DESCRIPTION HERE.
	retrieve ($key)
	INSERT BRIEF DESCRIPTION HERE.
	setAll ($data)
	INSERT BRIEF DESCRIPTION HERE.
Static Public Member Functions
static	findKeys ($domain= '//', $constraints=array(), $limit=array(), $order=array())
	INSERT BRIEF DESCRIPTION HERE.
Protected Member Functions
	populate ()
	INSERT BRIEF DESCRIPTION HERE.

---

Detailed Description

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Author:

AUTHOR (DATE)

Definition at line 11 of file SnapMetadata.php5.

---

Constructor & Destructor Documentation

SnapMetadata::__construct

(

$

file

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$file

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 30 of file SnapMetadata.php5.

References populate().

---

Member Function Documentation

SnapMetadata::clear

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 157 of file SnapMetadata.php5.

References SnapObject::checkValid().

SnapMetadata::commit

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 269 of file SnapMetadata.php5.

References SnapDBI::cancelTransaction(), SnapObject::checkValid(), SnapDBI::commitTransaction(), SnapObject::getId(), SnapObject::getType(), SnapDBI::query(), SObject::setError(), SnapDBI::startTransaction(), and SnapCache::updateById().

static SnapMetadata::findKeys	(	$	domain = '//',
		$	constraints = array(),
		$	limit = array(),
		$	order = array()
	)			[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$domain	[TYPE]: DESCRIPTION
	$constraints	[TYPE]: DESCRIPTION
	$limit	[TYPE]: DESCRIPTION
	$order	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 348 of file SnapMetadata.php5.

References SnapDBI::criteriaToString(), SnapDBI::limitToString(), SnapDBI::orderToString(), and SnapDBI::query().

SnapMetadata::getData

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 144 of file SnapMetadata.php5.

References SnapObject::checkValid().

SnapMetadata::getKeys

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 131 of file SnapMetadata.php5.

References SnapObject::checkValid().

SnapMetadata::populate

(

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SnapObject.

Definition at line 45 of file SnapMetadata.php5.

References SnapObject::checkValid(), SnapObject::getId(), SnapObject::getType(), SnapDBI::query(), SObject::setError(), SnapObject::setValid(), and SnapCache::updateById().

Referenced by __construct().

SnapMetadata::put	(	$	key,
		$	value
	)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$key	[TYPE]: DESCRIPTION
	$value	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 83 of file SnapMetadata.php5.

References SnapObject::checkValid(), and SObject::setError().

SnapMetadata::putMany

(

$

data

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$data

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 201 of file SnapMetadata.php5.

References SnapObject::checkValid(), and SObject::setError().

SnapMetadata::remove

(

$

key

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$key

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 178 of file SnapMetadata.php5.

References SnapObject::checkValid().

SnapMetadata::retrieve

(

$

key

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$key

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 114 of file SnapMetadata.php5.

References SnapObject::checkValid().

SnapMetadata::setAll

(

$

data

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$data

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 234 of file SnapMetadata.php5.

References SnapObject::checkValid(), and SObject::setError().

---

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

• snap2/objects/SnapMetadata.php5