PHP Class Doctrine\ODM\MongoDB\PersistentCollection

Since: 1.0

Author: Jonathan H. Wage ([email protected])

Author: Roman Borschel ([email protected])

Inheritance: implements Doctrine\Common\Collections\Collection

Afficher le fichier Open project: pmjones/php-framework-benchmarks Class Usage Examples

Méthodes publiques

Méthode	Description
__construct ( Doctrine\Common\Collections\Collection $coll, DocumentManager $dm, Configuration $c )
__sleep ( )	Called by PHP when this collection is serialized. Ensures that only the elements are properly serialized.
add ( $value )
clear ( )
clearSnapshot ( )	INTERNAL: Clears the internal snapshot information and sets isDirty to true if the collection has elements.
contains ( $element )
containsKey ( $key )
count ( )
current ( )	Gets the element of the collection at the current iterator position.
exists ( Closure $p )
filter ( Closure $p )
first ( )
forAll ( Closure $p )
get ( $key )
getDeleteDiff ( ) : array	INTERNAL: getDeleteDiff
getInsertDiff ( ) : array	INTERNAL: getInsertDiff
getIterator ( )
getKeys ( )
getMapping ( )
getOwner ( ) : object	INTERNAL: Gets the collection owner.
getReferences ( )
getSnapshot ( ) : array	INTERNAL: Returns the last snapshot of the elements in the collection.
getTypeClass ( )
getValues ( )
indexOf ( $element )
initialize ( )	Initializes the collection by loading its contents from the database if the collection is not yet initialized.
isDirty ( ) : boolean	Gets a boolean flag indicating whether this collection is dirty which means its state needs to be synchronized with the database.
isEmpty ( )
isInitialized ( ) : boolean	Checks whether this collection has been initialized.
key ( )
last ( )
map ( Closure $func )
next ( )	Moves the internal iterator position to the next element.
offsetExists ( $offset )
offsetGet ( $offset )
offsetSet ( $offset, $value )
offsetUnset ( $offset )
partition ( Closure $p )
remove ( $key )
removeElement ( $element )
set ( $key, $value )
setDirty ( boolean $dirty )	Sets a boolean flag, indicating whether this collection is dirty.
setInitialized ( boolean $bool )	Sets the initialized flag of the collection, forcing it into that state.
setOwner ( object $document, array $mapping )	INTERNAL: Sets the collection's owning entity together with the AssociationMapping that describes the association between the owner and the elements of the collection.
setReferences ( array $references )	Set the array of mongo database references to be used to initialize this collection.
slice ( $offset, $length = null )
takeSnapshot ( )	INTERNAL: Tells this collection to take a snapshot of its current state.
toArray ( )
unwrap ( )	Retrieves the wrapped Collection instance.

Private Methods

Méthode	Description
changed ( )	Marks this collection as changed/dirty.

Method Details

__construct() public méthode

public __construct ( Doctrine\Common\Collections\Collection $coll, DocumentManager $dm, Configuration $c )
$coll	Doctrine\Common\Collections\Collection
$dm	DocumentManager
$c	Configuration

__sleep() public méthode

Called by PHP when this collection is serialized. Ensures that only the elements are properly serialized.

public __sleep ( )

add() public méthode

public add ( $value )

clear() public méthode

public clear ( )

clearSnapshot() public méthode

INTERNAL: Clears the internal snapshot information and sets isDirty to true if the collection has elements.

public clearSnapshot ( )

contains() public méthode

public contains ( $element )

containsKey() public méthode

public containsKey ( $key )

count() public méthode

public count ( )

current() public méthode

Gets the element of the collection at the current iterator position.

public current ( )

exists() public méthode

public exists ( Closure $p )
$p	Closure

filter() public méthode

public filter ( Closure $p )
$p	Closure

first() public méthode

public first ( )

forAll() public méthode

public forAll ( Closure $p )
$p	Closure

get() public méthode

public get ( $key )

getDeleteDiff() public méthode

INTERNAL: getDeleteDiff

public getDeleteDiff ( ) : array
Résultat	array

getInsertDiff() public méthode

INTERNAL: getInsertDiff

public getInsertDiff ( ) : array
Résultat	array

getIterator() public méthode

public getIterator ( )

getKeys() public méthode

public getKeys ( )

getMapping() public méthode

public getMapping ( )

getOwner() public méthode

INTERNAL: Gets the collection owner.

public getOwner ( ) : object
Résultat	object

getReferences() public méthode

public getReferences ( )

getSnapshot() public méthode

INTERNAL: Returns the last snapshot of the elements in the collection.

public getSnapshot ( ) : array
Résultat	array	The last snapshot of the elements.

getTypeClass() public méthode

public getTypeClass ( )

getValues() public méthode

public getValues ( )

indexOf() public méthode

public indexOf ( $element )

initialize() public méthode

Initializes the collection by loading its contents from the database if the collection is not yet initialized.

public initialize ( )

isDirty() public méthode

Gets a boolean flag indicating whether this collection is dirty which means its state needs to be synchronized with the database.

public isDirty ( ) : boolean
Résultat	boolean	TRUE if the collection is dirty, FALSE otherwise.

isEmpty() public méthode

public isEmpty ( )

isInitialized() public méthode

Checks whether this collection has been initialized.

public isInitialized ( ) : boolean
Résultat	boolean

key() public méthode

public key ( )

last() public méthode

public last ( )

map() public méthode

public map ( Closure $func )
$func	Closure

next() public méthode

Moves the internal iterator position to the next element.

public next ( )

offsetExists() public méthode

offsetGet() public méthode

offsetSet() public méthode

offsetUnset() public méthode

partition() public méthode

public partition ( Closure $p )
$p	Closure

remove() public méthode

public remove ( $key )

removeElement() public méthode

public removeElement ( $element )

set() public méthode

public set ( $key, $value )

setDirty() public méthode

Sets a boolean flag, indicating whether this collection is dirty.

public setDirty ( boolean $dirty )
$dirty	boolean	Whether the collection should be marked dirty or not.

setInitialized() public méthode

Sets the initialized flag of the collection, forcing it into that state.

public setInitialized ( boolean $bool )
$bool	boolean

setOwner() public méthode

INTERNAL: Sets the collection's owning entity together with the AssociationMapping that describes the association between the owner and the elements of the collection.

public setOwner ( object $document, array $mapping )
$document	object
$mapping	array

setReferences() public méthode

Set the array of mongo database references to be used to initialize this collection.

public setReferences ( array $references )
$references	array

slice() public méthode

public slice ( $offset, $length = null )

takeSnapshot() public méthode

INTERNAL: Tells this collection to take a snapshot of its current state.

public takeSnapshot ( )

toArray() public méthode

public toArray ( )

unwrap() public méthode

Retrieves the wrapped Collection instance.

public unwrap ( )