Cloud/DocumentService/Document.php

Show:

inherited

Classes
- \Zend_Cloud_DocumentService_Document

Table of Contents

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Cloud
Subpackage: DocumentService

\Zend_Cloud_DocumentService_Document
jump to top

Package: Zend\Cloud\DocumentService

Class encapsulating documents.

Fields are stored in a name/value array. Data are represented as strings.

TODO Can fields be large enough to warrant support for streams?

Implements
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                KEY_FIELD
                = '_id'

key in document denoting identifier

Properties

array $_fields

Name/value array of field names to values.

Details

Type: array

mixed $_id

ID of this document.

Details

Type: mixed

Methods

__call(string $name, mixed $args) : mixed

Overloading: retrieve and set fields by name

Parameters

Name	Type	Description
$name	string
$args	mixed

Returns

Type	Description
mixed

__construct(array $fields, mixed $id = null) : void

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

Name	Type	Description
$fields	array
$id	mixed	Document identifier

__get(string $name) : mixed

Overloading: get value

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
mixed

__set(string $name, mixed $value) : void

Overloading: set field

Parameters

Name	Type	Description
$name	string
$value	mixed

count() : int

Countable: return count of fields in document

Returns

Type	Description
int

getField(string $name) : mixed

Get field by name.

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
mixed

getFields() : array

Get fields as array.

Returns

Type	Description
array

getId() : string

Get ID name.

Returns

Type	Description
string

getIterator() : \Iterator

IteratorAggregate: return iterator for iterating over fields

Returns

Type	Description
\Iterator

offsetExists(string $name) : bool

ArrayAccess: does field exist?

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool

offsetGet(string $name) : mixed

ArrayAccess: get field by name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
mixed

offsetSet(string $name, mixed $value) : void

ArrayAccess: set field to value

Parameters

Name	Type	Description
$name	string
$value	mixed

offsetUnset(string $name) : void

ArrayAccess: remove field from document

Parameters

Name	Type	Description
$name	string

setField(string $name, mixed $value) : \Zend_Cloud_DocumentService_Document

Set field by name.

Parameters

Name	Type	Description
$name	string
$value	mixed

Returns

Type	Description
\Zend_Cloud_DocumentService_Document

setId(mixed $id) : \Zend_Cloud_DocumentService_Document

Set document identifier

Parameters

Name	Type	Description
$id	mixed

Returns

Type	Description
\Zend_Cloud_DocumentService_Document

Cloud/DocumentService/Document.php

\Zend_Cloud_DocumentService_Documentjump to top

Constants

Properties

Methods

\Zend_Cloud_DocumentService_Document
jump to top