Propel API
Class

PropelOnDemandCollection

class PropelOnDemandCollection extends PropelCollection

Class for iterating over a statement and returning one Propel object at a time

Methods

array getData()

Get the data in the collection

 from PropelCollection
setData(array $data)

Set the data in the collection

 from PropelCollection
integer getPosition()

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

 from PropelCollection
mixed getFirst()

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

 from PropelCollection
boolean isFirst()

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

 from PropelCollection
mixed getPrevious()

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

 from PropelCollection
mixed getCurrent()

Get the current element in the collection

 from PropelCollection
mixed getNext()

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

 from PropelCollection
mixed getLast()

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

 from PropelCollection
boolean isLast()

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

 from PropelCollection
boolean isEmpty()

Check if the collection is empty

 from PropelCollection
boolean isOdd()

Check if the current index is an odd integer

 from PropelCollection
boolean isEven()

Check if the current index is an even integer

 from PropelCollection
mixed get(mixed $key)

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

 from PropelCollection
mixed pop()

Pops an element off the end of the collection

 from PropelCollection
mixed shift()

Pops an element off the beginning of the collection

 from PropelCollection
prepend($value)

set(mixed $key, mixed $value)

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

 from PropelCollection
mixed remove(mixed $key)

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

 from PropelCollection
array clear()

Clears the collection

 from PropelCollection
boolean contains(mixed $element)

Whether or not this collection contains a specified element

 from PropelCollection
mixed search(mixed $element)

Search an element in the collection

 from PropelCollection
serialize()

unserialize(string $data)

PropelOnDemandIterator getIterator()

ArrayIterator getInternalIterator()

from PropelCollection
clearIterator()

Clear the internal Iterator.

 from PropelCollection
setModel(string $model)

Set the model of the elements in the collection

 from PropelCollection
string getModel()

Get the model of the elements in the collection

 from PropelCollection
string getPeerClass()

Get the peer class of the elements in the collection

 from PropelCollection
setFormatter(PropelFormatter $formatter)

from PropelCollection
PropelFormatter getFormatter()

from PropelCollection
PropelPDO getConnection(string $type = Propel::CONNECTION_READ)

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

 from PropelCollection
BaseObject importFrom(mixed $parser, string $data)

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

 from PropelCollection
exportTo($parser, $usePrefix = true, $includeLazyLoadColumns = true)

{@inheritdoc}
array|string __call(string $name, mixed $params)

Catches calls to undefined methods.

 from PropelCollection
string __toString()

Returns a string representation of the current collection.

 from PropelCollection
initIterator(PropelFormatter $formatter, PDOStatement $stmt)

array toArray(string $keyColumn = null, boolean $usePrefix = false, string $keyType = BasePeer::TYPE_PHPNAME, boolean $includeLazyLoadColumns = true, array $alreadyDumpedObjects = array())

Get an array representation of the collection Each object is turned into an array and the result is returned
fromArray(array $arr)

Populates the collection from an array Each object is populated from an array and the result is stored Does not empty the collection before adding the data from the array
boolean offsetExists(integer $offset)

mixed offsetGet(integer $offset)

offsetSet(integer $offset, mixed $value)

offsetUnset(integer $offset)

integer count()

Returns the number of rows in the resultset Warning: this number is inaccurate for most databases.
append($value)

asort()

exchangeArray($input)

getArrayCopy()

getFlags()

ksort()

natcasesort()

natsort()

setFlags($flags)

uasort($cmp_function)

uksort($cmp_function)

Details

in PropelCollection at line 52
public array getData()

Get the data in the collection

Return Value

array

in PropelCollection at line 62
public setData(array $data)

Set the data in the collection

Parameters

array $data

in PropelCollection at line 73
public integer getPosition()

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

Return Value

integer

in PropelCollection at line 84
public mixed getFirst()

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

Return Value

mixed

in PropelCollection at line 95
public boolean isFirst()

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

Return Value

boolean

in PropelCollection at line 106
public mixed getPrevious()

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

Return Value

mixed

in PropelCollection at line 122
public mixed getCurrent()

Get the current element in the collection

Return Value

mixed

in PropelCollection at line 133
public mixed getNext()

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

Return Value

mixed

in PropelCollection at line 145
public mixed getLast()

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

Return Value

mixed

in PropelCollection at line 161
public boolean isLast()

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

Return Value

boolean

in PropelCollection at line 177
public boolean isEmpty()

Check if the collection is empty

Return Value

boolean

in PropelCollection at line 187
public boolean isOdd()

Check if the current index is an odd integer

Return Value

boolean

in PropelCollection at line 197
public boolean isEven()

Check if the current index is an even integer

Return Value

boolean

in PropelCollection at line 209
public mixed get(mixed $key)

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

Parameters

mixed $key

Return Value

mixed The element

in PropelCollection at line 222
public mixed pop()

Pops an element off the end of the collection

Return Value

mixed The popped element

in PropelCollection at line 238
public mixed shift()

Pops an element off the beginning of the collection

Return Value

mixed The popped element

at line 198
public prepend($value)

Parameters

$value

in PropelCollection at line 273
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

in PropelCollection at line 285
public mixed remove(mixed $key)

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

Parameters

mixed $key

Return Value

mixed The removed element

in PropelCollection at line 298
public array clear()

Clears the collection

Return Value

array The previous collection

in PropelCollection at line 309
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 164
public serialize()

Exceptions

PropelException

at line 173
public unserialize(string $data)

Parameters

string $data

Exceptions

PropelException

at line 104
public PropelOnDemandIterator getIterator()

Return Value

PropelOnDemandIterator

in PropelCollection at line 366
public ArrayIterator getInternalIterator()

Return Value

ArrayIterator

in PropelCollection at line 380
public clearIterator()

Clear the internal Iterator.

PHP 5.3 doesn't know how to free a PropelCollection 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

in PropelCollection at line 392
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

in PropelCollection at line 402
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

in PropelCollection at line 412
public string getPeerClass()

Get the peer class of the elements in the collection

Return Value

string Name of the Propel peer class stored in the collection

in PropelCollection at line 423
public setFormatter(PropelFormatter $formatter)

Parameters

PropelFormatter $formatter

in PropelCollection at line 431
public PropelFormatter getFormatter()

Return Value

PropelFormatter

in PropelCollection at line 442
public PropelPDO getConnection(string $type = Propel::CONNECTION_READ)

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

Parameters

string $type The connection type (Propel::CONNECTION_READ by default; can be Propel::connection_WRITE)

Return Value

PropelPDO A PropelPDO connection object

in PropelCollection at line 462
public BaseObject importFrom(mixed $parser, string $data)

Populate the current collection from a string, using a given parser format <code> $coll = new PropelObjectCollection(); $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 PropelParser 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 256
public exportTo($parser, $usePrefix = true, $includeLazyLoadColumns = true)

{@inheritdoc}

Parameters

$parser
$usePrefix
$includeLazyLoadColumns

in PropelCollection at line 509
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

in PropelCollection at line 530
public string __toString()

Returns a string representation of the current collection.

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

Return Value

string

at line 33
public initIterator(PropelFormatter $formatter, PDOStatement $stmt)

Parameters

PropelFormatter $formatter
PDOStatement $stmt

at line 72
public array toArray(string $keyColumn = null, boolean $usePrefix = false, string $keyType = BasePeer::TYPE_PHPNAME, boolean $includeLazyLoadColumns = true, array $alreadyDumpedObjects = array())

Get an array representation of the collection Each object is turned into an array and the result is returned

Parameters

string $keyColumn If null, the returned array uses an incremental index. Otherwise, the array is indexed using the specified column
boolean $usePrefix If true, the returned array prefixes keys with the model class name ('Article_0', 'Article_1', etc).
string $keyType (optional) One of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME, BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. Defaults to BasePeer::TYPE_PHPNAME.
boolean $includeLazyLoadColumns (optional) Whether to include lazy loaded columns. Defaults to TRUE.
array $alreadyDumpedObjects List of objects to skip to avoid recursion <code> $bookCollection->toArray(); array( 0 => array('Id' => 123, 'Title' => 'War And Peace'), 1 => array('Id' => 456, 'Title' => 'Don Juan'), ) $bookCollection->toArray('Id'); array( 123 => array('Id' => 123, 'Title' => 'War And Peace'), 456 => array('Id' => 456, 'Title' => 'Don Juan'), ) $bookCollection->toArray(null, true); array( 'Book_0' => array('Id' => 123, 'Title' => 'War And Peace'), 'Book_1' => array('Id' => 456, 'Title' => 'Don Juan'), ) </code>

Return Value

array

at line 94
public fromArray(array $arr)

Populates the collection from an array Each object is populated from an array and the result is stored Does not empty the collection before adding the data from the array

Parameters

array $arr

at line 117
public boolean offsetExists(integer $offset)

Parameters

integer $offset

Return Value

boolean

Exceptions

PropelException

at line 131
public mixed offsetGet(integer $offset)

Parameters

integer $offset

Return Value

mixed

Exceptions

PropelException

at line 145
public offsetSet(integer $offset, mixed $value)

Parameters

integer $offset
mixed $value

Exceptions

PropelException

at line 154
public offsetUnset(integer $offset)

Parameters

integer $offset

Exceptions

PropelException

at line 186
public integer count()

Returns the number of rows in the resultset Warning: this number is inaccurate for most databases.

Do not rely on it for a portable application.

Return Value

integer Number of results

at line 193
public append($value)

Parameters

$value

at line 203
public asort()

at line 208
public exchangeArray($input)

Parameters

$input

at line 213
public getArrayCopy()

at line 218
public getFlags()

at line 223
public ksort()

at line 228
public natcasesort()

at line 233
public natsort()

at line 238
public setFlags($flags)

Parameters

$flags

at line 243
public uasort($cmp_function)

Parameters

$cmp_function

at line 248
public uksort($cmp_function)

Parameters

$cmp_function