class PropelCollection 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 |
|
PropelCollection |
diff(PropelCollection $collection)
Returns an array of objects present in the collection that are not presents in the given collection. |
|
string |
serialize()
|
|
void |
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 |
getPeerClass()
Get the peer class of the elements in the collection |
|
setFormatter(PropelFormatter $formatter)
|
||
PropelFormatter |
getFormatter()
|
|
PropelPDO |
getConnection(string $type = Propel::CONNECTION_READ)
Get a 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 |
|
string |
exportTo(mixed $parser, boolean $usePrefix = true, boolean $includeLazyLoadColumns = true)
Export the current collection to a string, using a given parser format |
|
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. |
||
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 |
|
PropelCollection |
fromXML(string $data)
Populate the collection from an XML string |
|
PropelCollection |
fromYAML(string $data)
Populate the collection from a YAML string |
|
PropelCollection |
fromJSON(string $data)
Populate the collection from a JSON string |
|
PropelCollection |
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 52
public array
getData()
Get the data in the collection
at line 62
public
setData(array $data)
Set the data in the collection
at line 73
public integer
getPosition()
Gets the position of the internal pointer This position can be later used in seek()
at line 84
public mixed
getFirst()
Move the internal pointer to the beginning of the list And get the first element in the collection
at line 96
public boolean
isFirst()
Check whether the internal pointer is at the beginning of the list
at line 107
public mixed
getPrevious()
Move the internal pointer backward And get the previous element in the collection
at line 124
public mixed
getCurrent()
Get the current element in the collection
at line 135
public mixed
getNext()
Move the internal pointer forward And get the next element in the collection
at line 148
public mixed
getLast()
Move the internal pointer to the end of the list And get the last element in the collection
at line 165
public boolean
isLast()
Check whether the internal pointer is at the end of the list
at line 181
public boolean
isEmpty()
Check if the collection is empty
at line 191
public boolean
isOdd()
Check if the current index is an odd integer
at line 201
public boolean
isEven()
Check if the current index is an even integer
at line 216
public mixed
get(mixed $key)
Get an element from its key Alias for ArrayObject::offsetGet()
at line 230
public mixed
pop()
Pops an element off the end of the collection
at line 247
public mixed
shift()
Pops an element off the beginning of the collection
at line 265
public integer
prepend(mixed $value)
Prepend one or more elements to the beginning of the collection
at line 283
public
set(mixed $key, mixed $value)
Add an element to the collection with the given key Alias for ArrayObject::offsetSet()
at line 298
public mixed
remove(mixed $key)
Removes a specified collection element Alias for ArrayObject::offsetUnset()
at line 312
public array
clear()
Clears the collection
at line 324
public boolean
contains(mixed $element)
Whether or not this collection contains a specified element
at line 336
public mixed
search(mixed $element)
Search an element in the collection
at line 349
public PropelCollection
diff(PropelCollection $collection)
Returns an array of objects present in the collection that are not presents in the given collection.
at line 368
public string
serialize()
at line 383
public void
unserialize(string $data)
at line 398
public ArrayIterator
getIterator()
Overrides ArrayObject::getIterator() to save the iterator object for internal use e.g.
getNext(), isOdd(), etc.
at line 408
public ArrayIterator
getInternalIterator()
at line 424
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.
at line 436
public
setModel(string $model)
Set the model of the elements in the collection
at line 446
public string
getModel()
Get the model of the elements in the collection
at line 458
public string
getPeerClass()
Get the peer class of the elements in the collection
at line 470
public
setFormatter(PropelFormatter $formatter)
at line 478
public PropelFormatter
getFormatter()
at line 490
public PropelPDO
getConnection(string $type = Propel::CONNECTION_READ)
Get a connection object for the database containing the elements of the collection
at line 510
public BaseObject
importFrom(mixed $parser, string $data)
Populate the current collection from a string, using a given parser format $coll = new PropelObjectCollection(); $coll->setModel('Book'); $coll->importFrom('JSON', '{{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}}');
at line 540
public string
exportTo(mixed $parser, boolean $usePrefix = true, boolean $includeLazyLoadColumns = true)
Export the current collection to a string, using a given parser format $books = BookQuery::create()->find(); echo $book->exportTo('JSON'); => {{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}}');
A PropelOnDemandCollection cannot be exported. Any attempt will result in a PropelExecption being thrown.
at line 562
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
at line 583
public string
__toString()
Returns a string representation of the current collection.
Based on the string representation of the underlying objects, defined in the Peer::DEFAULTSTRINGFORMAT constant
at line 591
public
__clone()
Creates clones of the containing data.
at line 637
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 28
PropelCollection
fromXML(string $data)
Populate the collection from an XML string
at line 28
PropelCollection
fromYAML(string $data)
Populate the collection from a YAML string
at line 28
PropelCollection
fromJSON(string $data)
Populate the collection from a JSON string
at line 28
PropelCollection
fromCSV(string $data)
Populate the collection from a CSV string
at line 28
string
toXML(boolean $usePrefix, boolean $includeLazyLoadColumns)
Export the collection to an XML string
at line 28
string
toYAML(boolean $usePrefix, boolean $includeLazyLoadColumns)
Export the collection to a YAML string
at line 28
string
toJSON(boolean $usePrefix, boolean $includeLazyLoadColumns)
Export the collection to a JSON string
at line 28
string
toCSV(boolean $usePrefix, boolean $includeLazyLoadColumns)
Export the collection to a CSV string