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 |
| PropelCollection |
diff(PropelCollection $collection)
Returns an array of objects present in the collection that are not presents in the given collection. |
from PropelCollection |
| serialize() | ||
| void | 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
in PropelCollection at line 62
public
setData(array $data)
Set the data in the collection
in PropelCollection at line 73
public integer
getPosition()
Gets the position of the internal pointer This position can be later used in seek()
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
in PropelCollection at line 96
public boolean
isFirst()
Check whether the internal pointer is at the beginning of the list
in PropelCollection at line 107
public mixed
getPrevious()
Move the internal pointer backward And get the previous element in the collection
in PropelCollection at line 124
public mixed
getCurrent()
Get the current element in the collection
in PropelCollection at line 135
public mixed
getNext()
Move the internal pointer forward And get the next element in the collection
in PropelCollection at line 148
public mixed
getLast()
Move the internal pointer to the end of the list And get the last element in the collection
in PropelCollection at line 165
public boolean
isLast()
Check whether the internal pointer is at the end of the list
in PropelCollection at line 181
public boolean
isEmpty()
Check if the collection is empty
in PropelCollection at line 191
public boolean
isOdd()
Check if the current index is an odd integer
in PropelCollection at line 201
public boolean
isEven()
Check if the current index is an even integer
in PropelCollection at line 215
public mixed
get(mixed $key)
Get an element from its key Alias for ArrayObject::offsetGet()
in PropelCollection at line 229
public mixed
pop()
Pops an element off the end of the collection
in PropelCollection at line 246
public mixed
shift()
Pops an element off the beginning of the collection
at line 202
public
prepend($value)
in PropelCollection at line 281
public
set(mixed $key, mixed $value)
Add an element to the collection with the given key Alias for ArrayObject::offsetSet()
in PropelCollection at line 295
public mixed
remove(mixed $key)
Removes a specified collection element Alias for ArrayObject::offsetUnset()
in PropelCollection at line 309
public array
clear()
Clears the collection
in PropelCollection at line 320
public boolean
contains(mixed $element)
Whether or not this collection contains a specified element
in PropelCollection at line 331
public mixed
search(mixed $element)
Search an element in the collection
in PropelCollection at line 343
public PropelCollection
diff(PropelCollection $collection)
Returns an array of objects present in the collection that are not presents in the given collection.
at line 166
public
serialize()
at line 177
public void
unserialize(string $data)
at line 106
public PropelOnDemandIterator
getIterator()
in PropelCollection at line 402
public ArrayIterator
getInternalIterator()
in PropelCollection at line 417
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.
in PropelCollection at line 429
public
setModel(string $model)
Set the model of the elements in the collection
in PropelCollection at line 439
public string
getModel()
Get the model of the elements in the collection
in PropelCollection at line 451
public string
getPeerClass()
Get the peer class of the elements in the collection
in PropelCollection at line 463
public
setFormatter(PropelFormatter $formatter)
in PropelCollection at line 471
public PropelFormatter
getFormatter()
in PropelCollection at line 482
public PropelPDO
getConnection(string $type = Propel::CONNECTION_READ)
Get a connection object for the database containing the elements of the collection
in PropelCollection at line 502
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>
at line 260
public
exportTo($parser, $usePrefix = true, $includeLazyLoadColumns = true)
{@inheritdoc}
in PropelCollection at line 553
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
in PropelCollection at line 574
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
at line 33
public
initIterator(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
at line 96
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
at line 119
public boolean
offsetExists(integer $offset)
at line 133
public mixed
offsetGet(integer $offset)
at line 147
public
offsetSet(integer $offset, mixed $value)
at line 156
public
offsetUnset(integer $offset)
at line 190
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.