PHP Class Shanty_Mongo_DocumentSet

Author: Coen Hyde
Inheritance: extends Shanty_Mongo_Document
Show file Open project: coen-hyde/shanty-mongo

Protected Properties

Property Type Description
$_requirements

Public Methods

Method Description
__call ( $name, $arguments = [] )
addDocument ( Shanty_Mongo_Document $document ) Add a document to this set
export ( $skipRequired = false ) : array Export all data
getOperations ( boolean $includingChildren = false ) Get all operations
getProperty ( $index = null ) Get a property
getPropertyKeys ( ) : array Get the property keys for this Document Set
purgeOperations ( boolean $includingChildren = false ) Remove all operations
pushDocument ( Shanty_Mongo_Document $document ) Add a document to the push queue
setProperty ( $index, $document ) Set property

Method Details

__call() public method

public __call ( $name, $arguments = [] )

addDocument() public method

Add a document to this set
public addDocument ( Shanty_Mongo_Document $document )
$document Shanty_Mongo_Document

export() public method

Export all data
public export ( $skipRequired = false ) : array
return array

getOperations() public method

Get all operations
public getOperations ( boolean $includingChildren = false )
$includingChildren boolean Get operations from children as well

getProperty() public method

Get a property
public getProperty ( $index = null )

getPropertyKeys() public method

Get the property keys for this Document Set
public getPropertyKeys ( ) : array
return array

purgeOperations() public method

Remove all operations
public purgeOperations ( boolean $includingChildren = false )
$includingChildren boolean Remove operations from children as wells

pushDocument() public method

Add a document to the push queue
public pushDocument ( Shanty_Mongo_Document $document )
$document Shanty_Mongo_Document

setProperty() public method

Set property
public setProperty ( $index, $document )
$index
$document

Property Details

$_requirements protected static property

protected static $_requirements