• Home
• lithium
• data
• entity
• Document

PHP Class lithium\data\entity\Document

A Document object's fields can represent a collection of both simple and complex data types, as well as other Document objects. Given the following data (document) structure: {{{ { _id: 12345. name: 'Acme, Inc.', employees: { 'Larry': { email: '[email protected]' }, 'Curly': { email: '[email protected]' }, 'Moe': { email: '[email protected]' } } } }}} You can query the object as follows: {{{$acme = Company::find(12345);}}} This returns a Document object, populated with the raw representation of the data. {{{print_r($acme->to('array')); Yields: array( '_id' => 12345, 'name' => 'Acme, Inc.', 'employees' => array( 'Larry' => array('email' => '[email protected]'), 'Curly' => array('email' => '[email protected]'), 'Moe' => array('email' => '[email protected]') ) )}}} As with other database objects, a Document exposes its fields as object properties, like so: {{{echo $acme->name; // echoes 'Acme, Inc.'}}} However, accessing a field containing a data set will return that data set wrapped in a sub-Document object., i.e.: {{{$employees = $acme->employees; returns a Document object with the data in 'employees'}}} ファイルを表示 Open project: unionofrad/lithium Class Usage Examples

Protected Properties

Property	Type	Description
$_pathKey	string	If this Document instance has a parent document (see $_parent), this value indicates the key name of the parent document that contains it.
$_removed	array	Removed keys list. Contains names of the fields will be removed from the backend data store
$_stats	array	Contains an array of backend-specific statistics generated by the query that produced this Document object. These stats are accessible via the stats() method.
$_valid	boolean	Holds the current iteration state. Used by Document::valid() to terminate foreach loops when there are no more fields to iterate over.

Public Methods

Method	Description
__get ( $name ) : mixed	PHP magic method used when accessing fields as document properties, i.e. $document->_id.
__isset ( $name ) : boolean	PHP magic method used to check the presence of a field as document properties, i.e.
__set ( $name, $value = null ) : void	PHP magic method used when setting properties on the Document instance, i.e.
__unset ( string $name ) : void	PHP magic method used when unset() is called on a Document instance.
current ( )
export ( array $options = [] )
key ( )
next ( ) : mixed	Returns the next Document in the set, and advances the object's internal pointer. If the end of the set is reached, a new document will be fetched from the data source connection handle ($_handle). If no more records can be fetched, returns null.
offsetExists ( mixed $offset ) : boolean	Allows document fields to be tested as array keys, i.e. isset($document['_id']).
offsetGet ( mixed $offset ) : mixed	Allows document fields to be accessed as array keys, i.e. $document['_id'].
offsetSet ( mixed $offset, mixed $value ) : void	Allows document fields to be assigned as array keys, i.e. $document['_id'] = $id.
offsetUnset ( string $key ) : void	Allows document fields to be unset as array keys, i.e. unset($document['_id']).
rewind ( ) : mixed	Rewinds to the first item.
set ( array $data, array $options = [] ) : void	Allows several properties to be assigned at once.
sync ( mixed $id = null, array $data = [], array $options = [] ) : void	Extends the parent implementation to ensure that child documents are properly synced as well.
to ( string $format, array $options = [] ) : mixed	Adds conversions checks to ensure certain class types and embedded values are properly cast.
valid ( ) : boolean	Used by the Iterator interface to determine the current state of the iteration, and when to stop iterating.

Protected Methods

Method	Description
_getNested ( $name )
_init ( )
_relation ( string $classType, string $key, array $data, array $options = [] ) : object	Instantiates a new Document object as a descendant of the current object, and sets all default values and internal state.
_setNested ( $name, $value )

Method Details

Property Details