PHP Class Shanty_Mongo_Iterator_Default

Author: Coen Hyde
Inheritance: implements SeekableIterator, implements RecursiveIterator, implements Countable
Mostra file Open project: coen-hyde/shanty-mongo

Protected Properties

Property Type Description
$_counter
$_document
$_init
$_position
$_properties

Public Methods

Method Description
__construct ( Shanty_Mongo_Document $document )
count ( ) : integer Count all properties
current ( ) : mixed Get the current value
getChildren ( ) * Get children
getDocument ( ) : Shanty_Mongo_Document Get the document
getDocumentProperties ( ) : array Get the properties
hasChildren ( ) : boolean Determine if the current node has an children
key ( ) : string Get the current key
next ( ) Move next
rewind ( ) Rewind the iterator
seek ( unknown_type $position ) Seek to a position
valid ( ) : boolean Is the current position valid

Method Details

__construct() public method

public __construct ( Shanty_Mongo_Document $document )
$document Shanty_Mongo_Document

count() public method

Count all properties
public count ( ) : integer
return integer

current() public method

Get the current value
public current ( ) : mixed
return mixed

getChildren() public method

* Get children
public getChildren ( )

getDocument() public method

Get the document
public getDocument ( ) : Shanty_Mongo_Document
return Shanty_Mongo_Document

getDocumentProperties() public method

Get the properties
public getDocumentProperties ( ) : array
return array

hasChildren() public method

Determine if the current node has an children
public hasChildren ( ) : boolean
return boolean

key() public method

Get the current key
public key ( ) : string
return string

next() public method

Move next
public next ( )

rewind() public method

Rewind the iterator
public rewind ( )

seek() public method

Seek to a position
public seek ( unknown_type $position )
$position unknown_type

valid() public method

Is the current position valid
public valid ( ) : boolean
return boolean

Property Details

$_counter protected_oe property

protected $_counter

$_document protected_oe property

protected $_document

$_init protected_oe property

protected $_init

$_position protected_oe property

protected $_position

$_properties protected_oe property

protected $_properties