Zend_Cloud_DocumentService_Document Class Reference

Public Member Functions
	__construct ($fields, $id=null)
	Construct an instance of Zend_Cloud_DocumentService_Document.
	setId ($id)
	Set document identifier.
	getId ()
	Get ID name.
	getFields ()
	Get fields as array.
	getField ($name)
	Get field by name.
	setField ($name, $value)
	Set field by name.
	__get ($name)
	Overloading: get value.
	__set ($name, $value)
	Overloading: set field.
	offsetExists ($name)
	ArrayAccess: does field exist?
	offsetGet ($name)
	ArrayAccess: get field by name.
	offsetSet ($name, $value)
	ArrayAccess: set field to value.
	offsetUnset ($name)
	ArrayAccess: remove field from document.
	__call ($name, $args)
	Overloading: retrieve and set fields by name.
	count ()
	Countable: return count of fields in document.
	getIterator ()
	IteratorAggregate: return iterator for iterating over fields.

Public Attributes
const	KEY_FIELD = '_id'
	key in document denoting identifier

Protected Attributes
	$_id
	$_fields

Constructor & Destructor Documentation

__construct	(		$fields,
			$id = null
	)

Construct an instance of Zend_Cloud_DocumentService_Document.

If no identifier is provided, but a field matching KEY_FIELD is present, then that field's value will be used as the document identifier.

Parameters

array	$fields
mixed	$id	Document identifier

Returns

void

Member Function Documentation

__call	(		$name,
			$args
	)

Overloading: retrieve and set fields by name.

Parameters

string	$name
mixed	$args

Returns

mixed

__get

(

$name

)

Overloading: get value.

Parameters

string

$name

Returns

mixed

__set	(		$name,
			$value
	)

Overloading: set field.

Parameters

string	$name
mixed	$value

Returns

void

count

(

)

Countable: return count of fields in document.

Returns

int

getField

(

$name

)

Get field by name.

Parameters

string

$name

Returns

mixed

getFields

(

)

Get fields as array.

Returns

array

getId

(

)

Get ID name.

Returns

string

getIterator

(

)

IteratorAggregate: return iterator for iterating over fields.

Returns

Iterator

offsetExists

(

$name

)

ArrayAccess: does field exist?

Parameters

string

$name

Returns

bool

offsetGet

(

$name

)

ArrayAccess: get field by name.

Parameters

string

$name

Returns

mixed

offsetSet	(		$name,
			$value
	)

ArrayAccess: set field to value.

Parameters

string	$name
mixed	$value

Returns

void

offsetUnset

(

$name

)

ArrayAccess: remove field from document.

Parameters

string

$name

Returns

void

setField	(		$name,
			$value
	)

Set field by name.

Parameters

string	$name
mixed	$value

Returns

Zend_Cloud_DocumentService_Document

setId

(

$id

)

Set document identifier.

Parameters

mixed

$id

Returns

Zend_Cloud_DocumentService_Document

Member Data Documentation

$_fields

protected

$_id

protected

const KEY_FIELD = '_id'

key in document denoting identifier