Propel 2 API
Class

Propel\Runtime\Collection\Collection

class Collection extends ArrayObject implements Serializable

Class for iterating over a list of Propel elements The collection keys must be integers - no associative array accepted

Methods

array getData()

Get the data in the collection
setData(array $data)

Set the data in the collection
integer getPosition()

Gets the position of the internal pointer This position can be later used in seek()
mixed getFirst()

Move the internal pointer to the beginning of the list And get the first element in the collection
boolean isFirst()

Check whether the internal pointer is at the beginning of the list
mixed getPrevious()

Move the internal pointer backward And get the previous element in the collection
mixed getCurrent()

Get the current element in the collection
mixed getNext()

Move the internal pointer forward And get the next element in the collection
mixed getLast()

Move the internal pointer to the end of the list And get the last element in the collection
boolean isLast()

Check whether the internal pointer is at the end of the list
boolean isEmpty()

Check if the collection is empty
boolean isOdd()

Check if the current index is an odd integer
boolean isEven()

Check if the current index is an even integer
mixed get(mixed $key)

Get an element from its key Alias for ArrayObject::offsetGet()
mixed pop()

Pops an element off the end of the collection
mixed shift()

Pops an element off the beginning of the collection
integer prepend(mixed $value)

Prepend one or more elements to the beginning of the collection
set(mixed $key, mixed $value)

Add an element to the collection with the given key Alias for ArrayObject::offsetSet()
mixed remove(mixed $key)

Removes a specified collection element Alias for ArrayObject::offsetUnset()
array clear()

Clears the collection
boolean contains(mixed $element)

Whether or not this collection contains a specified element
mixed search(mixed $element)

Search an element in the collection
Collection diff(Collection $collection)

Returns an array of objects present in the collection that are not presents in the given collection.
string serialize()

unserialize(string $data)

ArrayIterator getIterator()

Overrides ArrayObject::getIterator() to save the iterator object for internal use e.g.
ArrayIterator getInternalIterator()

clearIterator()

Clear the internal Iterator.
setModel(string $model)

Set the model of the elements in the collection
string getModel()

Get the model of the elements in the collection
string getFullyQualifiedModel()

Get the model of the elements in the collection
getTableMapClass()

setFormatter(AbstractFormatter $formatter)

AbstractFormatter getFormatter()

ConnectionInterface getWriteConnection()

Get a write connection object for the database containing the elements of the collection
BaseObject importFrom(mixed $parser, string $data)

Populate the current collection from a string, using a given parser format <code> $coll = new ObjectCollection(); $coll->setModel('Book'); $coll->importFrom('JSON', '{{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}}'); </code>
string exportTo(mixed $parser, boolean $usePrefix = true, boolean $includeLazyLoadColumns = true)

Export the current collection to a string, using a given parser format <code> $books = BookQuery::create()->find(); echo $book->exportTo('JSON'); => {{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}}'); </code>
array|string __call(string $name, mixed $params)

Catches calls to undefined methods.
string __toString()

Returns a string representation of the current collection.
__clone()

Creates clones of the containing data.
Collection fromXML(string $data)

Populate the collection from an XML string
Collection fromYAML(string $data)

Populate the collection from a YAML string
Collection fromJSON(string $data)

Populate the collection from a JSON string
Collection fromCSV(string $data)

Populate the collection from a CSV string
string toXML(boolean $usePrefix, boolean $includeLazyLoadColumns)

Export the collection to an XML string
string toYAML(boolean $usePrefix, boolean $includeLazyLoadColumns)

Export the collection to a YAML string
string toJSON(boolean $usePrefix, boolean $includeLazyLoadColumns)

Export the collection to a JSON string
string toCSV(boolean $usePrefix, boolean $includeLazyLoadColumns)

Export the collection to a CSV string

Details

at line 70
public array getData()

Get the data in the collection

Return Value

array

at line 80
public setData(array $data)

Set the data in the collection

Parameters

array $data

at line 91
public integer getPosition()

Gets the position of the internal pointer This position can be later used in seek()

Return Value

integer

at line 102
public mixed getFirst()

Move the internal pointer to the beginning of the list And get the first element in the collection

Return Value

mixed

at line 114
public boolean isFirst()

Check whether the internal pointer is at the beginning of the list

Return Value

boolean

at line 125
public mixed getPrevious()

Move the internal pointer backward And get the previous element in the collection

Return Value

mixed

at line 141
public mixed getCurrent()

Get the current element in the collection

Return Value

mixed

at line 152
public mixed getNext()

Move the internal pointer forward And get the next element in the collection

Return Value

mixed

at line 165
public mixed getLast()

Move the internal pointer to the end of the list And get the last element in the collection

Return Value

mixed

at line 181
public boolean isLast()

Check whether the internal pointer is at the end of the list

Return Value

boolean

at line 198
public boolean isEmpty()

Check if the collection is empty

Return Value

boolean

at line 208
public boolean isOdd()

Check if the current index is an odd integer

Return Value

boolean

at line 218
public boolean isEven()

Check if the current index is an even integer

Return Value

boolean

at line 230
public mixed get(mixed $key)

Get an element from its key Alias for ArrayObject::offsetGet()

Parameters

mixed $key

Return Value

mixed The element

at line 244
public mixed pop()

Pops an element off the end of the collection

Return Value

mixed The popped element

at line 262
public mixed shift()

Pops an element off the beginning of the collection

Return Value

mixed The popped element

at line 279
public integer prepend(mixed $value)

Prepend one or more elements to the beginning of the collection

Parameters

mixed $value the element to prepend

Return Value

integer The number of new elements in the array

at line 297
public set(mixed $key, mixed $value)

Add an element to the collection with the given key Alias for ArrayObject::offsetSet()

Parameters

mixed $key
mixed $value

at line 309
public mixed remove(mixed $key)

Removes a specified collection element Alias for ArrayObject::offsetUnset()

Parameters

mixed $key

Return Value

mixed The removed element

at line 323
public array clear()

Clears the collection

Return Value

array The previous collection

at line 334
public boolean contains(mixed $element)

Whether or not this collection contains a specified element

Parameters

mixed $element

Return Value

boolean

Search an element in the collection

Parameters

mixed $element

Return Value

mixed Returns the key for the element if it is found in the collection, FALSE otherwise

at line 357
public Collection diff(Collection $collection)

Returns an array of objects present in the collection that are not presents in the given collection.

Parameters

Collection $collection A Propel collection.

Return Value

Collection An array of Propel objects from the collection that are not presents in the given collection.

at line 376
public string serialize()

Return Value

string

at line 389
public unserialize(string $data)

Parameters

string $data

at line 404
public ArrayIterator getIterator()

Overrides ArrayObject::getIterator() to save the iterator object for internal use e.g.

getNext(), isOdd(), etc.

Return Value

ArrayIterator

at line 414
public ArrayIterator getInternalIterator()

Return Value

ArrayIterator

at line 429
public clearIterator()

Clear the internal Iterator.

PHP 5.3 doesn't know how to free a Collection object if it has an attached
Iterator, so this must be done manually to avoid memory leaks.

See also

http://www.propelorm.org/ticket/1232

at line 441
public setModel(string $model)

Set the model of the elements in the collection

Parameters

string $model Name of the Propel object classes stored in the collection

at line 456
public string getModel()

Get the model of the elements in the collection

Return Value

string Name of the Propel object class stored in the collection

at line 466
public string getFullyQualifiedModel()

Get the model of the elements in the collection

Return Value

string Fully qualified Name of the Propel object class stored in the collection

at line 471
public getTableMapClass()

at line 485
public setFormatter(AbstractFormatter $formatter)

Parameters

AbstractFormatter $formatter

at line 493
public AbstractFormatter getFormatter()

Return Value

AbstractFormatter

at line 503
public ConnectionInterface getWriteConnection()

Get a write connection object for the database containing the elements of the collection

Return Value

ConnectionInterface A ConnectionInterface connection object

at line 523
public BaseObject importFrom(mixed $parser, string $data)

Populate the current collection from a string, using a given parser format <code> $coll = new ObjectCollection(); $coll->setModel('Book'); $coll->importFrom('JSON', '{{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}}'); </code>

Parameters

mixed $parser A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV')
string $data The source data to import from

Return Value

BaseObject The current object, for fluid interface

at line 552
public string exportTo(mixed $parser, boolean $usePrefix = true, boolean $includeLazyLoadColumns = true)

Export the current collection to a string, using a given parser format <code> $books = BookQuery::create()->find(); echo $book->exportTo('JSON'); => {{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}}'); </code>

A OnDemandCollection cannot be exported. Any attempt will result in a PropelException being thrown.

Parameters

mixed $parser A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV')
boolean $usePrefix (optional) If true, the returned element keys will be prefixed with the model class name ('Article_0', 'Article_1', etc). Defaults to TRUE. Not supported by ArrayCollection, as ArrayFormatter has already created the array used here with integers as keys.
boolean $includeLazyLoadColumns (optional) Whether to include lazy load(ed) columns. Defaults to TRUE. Not supported by ArrayCollection, as ArrayFormatter has already included lazy-load columns in the array used here.

Return Value

string The exported data

at line 572
public array|string __call(string $name, mixed $params)

Catches calls to undefined methods.

Provides magic import/export method support (fromXML()/toXML(), fromYAML()/toYAML(), etc.).
Allows to define default __call() behavior if you use a custom BaseObject

Parameters

string $name
mixed $params

Return Value

array|string

at line 596
public string __toString()

Returns a string representation of the current collection.

Based on the string representation of the underlying objects, defined in
the TableMap::DEFAULT_STRING_FORMAT constant

Return Value

string

at line 604
public __clone()

Creates clones of the containing data.

at line 39
Collection fromXML(string $data)

Populate the collection from an XML string

Parameters

string $data

Return Value

Collection

at line 39
Collection fromYAML(string $data)

Populate the collection from a YAML string

Parameters

string $data

Return Value

Collection

at line 39
Collection fromJSON(string $data)

Populate the collection from a JSON string

Parameters

string $data

Return Value

Collection

at line 39
Collection fromCSV(string $data)

Populate the collection from a CSV string

Parameters

string $data

Return Value

Collection

at line 39
string toXML(boolean $usePrefix, boolean $includeLazyLoadColumns)

Export the collection to an XML string

Parameters

boolean $usePrefix
boolean $includeLazyLoadColumns

Return Value

string

at line 39
string toYAML(boolean $usePrefix, boolean $includeLazyLoadColumns)

Export the collection to a YAML string

Parameters

boolean $usePrefix
boolean $includeLazyLoadColumns

Return Value

string

at line 39
string toJSON(boolean $usePrefix, boolean $includeLazyLoadColumns)

Export the collection to a JSON string

Parameters

boolean $usePrefix
boolean $includeLazyLoadColumns

Return Value

string

at line 39
string toCSV(boolean $usePrefix, boolean $includeLazyLoadColumns)

Export the collection to a CSV string

Parameters

boolean $usePrefix
boolean $includeLazyLoadColumns

Return Value

string