class PropelArrayCollection extends PropelCollection
Class for iterating over a list of Propel objects stored as arrays
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 |
integer |
prepend(mixed $value)
Prepend one or more elements to the beginning of the collection |
from PropelCollection |
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 |
string |
serialize()
|
from PropelCollection |
void |
unserialize(string $data)
|
from PropelCollection |
ArrayIterator |
getIterator()
Overrides ArrayObject::getIterator() to save the iterator object for internal use e.g. |
from PropelCollection |
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 |
from PropelCollection |
string |
exportTo(mixed $parser, boolean $usePrefix = true, boolean $includeLazyLoadColumns = true)
Export the current collection to a string, using a given parser format |
from PropelCollection |
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 |
__clone()
Creates clones of the containing data. |
from PropelCollection | |
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 This is not an alias for getData(), since it returns a copy of the data |
|
PropelCollection |
fromXML(string $data)
Populate the collection from an XML string |
from PropelCollection |
PropelCollection |
fromYAML(string $data)
Populate the collection from a YAML string |
from PropelCollection |
PropelCollection |
fromJSON(string $data)
Populate the collection from a JSON string |
from PropelCollection |
PropelCollection |
fromCSV(string $data)
Populate the collection from a CSV string |
from PropelCollection |
string |
toXML(boolean $usePrefix, boolean $includeLazyLoadColumns)
Export the collection to an XML string |
from PropelCollection |
string |
toYAML(boolean $usePrefix, boolean $includeLazyLoadColumns)
Export the collection to a YAML string |
from PropelCollection |
string |
toJSON(boolean $usePrefix, boolean $includeLazyLoadColumns)
Export the collection to a JSON string |
from PropelCollection |
string |
toCSV(boolean $usePrefix, boolean $includeLazyLoadColumns)
Export the collection to a CSV string |
from PropelCollection |
save(PropelPDO $con = null)
Save all the elements in the collection |
||
delete(PropelPDO $con = null)
Delete all the elements in the collection |
||
array |
getPrimaryKeys(boolean $usePrefix = true)
Get an array of the primary keys of all the objects in the collection |
|
fromArray(array $arr)
Populates the collection from an array Uses the object model to force the column types Does not empty the collection before adding the data from the array |
||
array |
getArrayCopy(string $keyColumn = null, boolean $usePrefix = false)
Synonym for toArray(), to provide a similar interface to PopelObjectCollection |
|
array |
toKeyValue(string $keyColumn, string $valueColumn)
Get an associative array representation of the collection The first parameter specifies the column to be used for the key, And the seconf for the value. |
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 216
public mixed
get(mixed $key)
Get an element from its key Alias for ArrayObject::offsetGet()
in PropelCollection at line 230
public mixed
pop()
Pops an element off the end of the collection
in PropelCollection at line 247
public mixed
shift()
Pops an element off the beginning of the collection
in PropelCollection at line 265
public integer
prepend(mixed $value)
Prepend one or more elements to the beginning of the collection
in PropelCollection at line 283
public
set(mixed $key, mixed $value)
Add an element to the collection with the given key Alias for ArrayObject::offsetSet()
in PropelCollection at line 298
public mixed
remove(mixed $key)
Removes a specified collection element Alias for ArrayObject::offsetUnset()
in PropelCollection at line 312
public array
clear()
Clears the collection
in PropelCollection at line 324
public boolean
contains(mixed $element)
Whether or not this collection contains a specified element
in PropelCollection at line 336
public mixed
search(mixed $element)
Search an element in the collection
in PropelCollection 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.
in PropelCollection at line 368
public string
serialize()
in PropelCollection at line 383
public void
unserialize(string $data)
in PropelCollection at line 398
public ArrayIterator
getIterator()
Overrides ArrayObject::getIterator() to save the iterator object for internal use e.g.
getNext(), isOdd(), etc.
in PropelCollection at line 408
public ArrayIterator
getInternalIterator()
in PropelCollection 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.
in PropelCollection at line 436
public
setModel(string $model)
Set the model of the elements in the collection
in PropelCollection at line 446
public string
getModel()
Get the model of the elements in the collection
in PropelCollection at line 458
public string
getPeerClass()
Get the peer class of the elements in the collection
in PropelCollection at line 470
public
setFormatter(PropelFormatter $formatter)
in PropelCollection at line 478
public PropelFormatter
getFormatter()
in PropelCollection at line 490
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 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}}');
in PropelCollection 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.
in PropelCollection 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
in PropelCollection 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
in PropelCollection at line 591
public
__clone()
Creates clones of the containing data.
at line 146
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 This is not an alias for getData(), since it returns a copy of the data
in PropelCollection at line 28
PropelCollection
fromXML(string $data)
Populate the collection from an XML string
in PropelCollection at line 28
PropelCollection
fromYAML(string $data)
Populate the collection from a YAML string
in PropelCollection at line 28
PropelCollection
fromJSON(string $data)
Populate the collection from a JSON string
in PropelCollection at line 28
PropelCollection
fromCSV(string $data)
Populate the collection from a CSV string
in PropelCollection at line 28
string
toXML(boolean $usePrefix, boolean $includeLazyLoadColumns)
Export the collection to an XML string
in PropelCollection at line 28
string
toYAML(boolean $usePrefix, boolean $includeLazyLoadColumns)
Export the collection to a YAML string
in PropelCollection at line 28
string
toJSON(boolean $usePrefix, boolean $includeLazyLoadColumns)
Export the collection to a JSON string
in PropelCollection at line 28
string
toCSV(boolean $usePrefix, boolean $includeLazyLoadColumns)
Export the collection to a CSV string
at line 28
public
save(PropelPDO $con = null)
Save all the elements in the collection
at line 58
public
delete(PropelPDO $con = null)
Delete all the elements in the collection
at line 88
public array
getPrimaryKeys(boolean $usePrefix = true)
Get an array of the primary keys of all the objects in the collection
at line 107
public
fromArray(array $arr)
Populates the collection from an array Uses the object model to force the column types Does not empty the collection before adding the data from the array
at line 166
public array
getArrayCopy(string $keyColumn = null, boolean $usePrefix = false)
Synonym for toArray(), to provide a similar interface to PopelObjectCollection
at line 188
public array
toKeyValue(string $keyColumn, string $valueColumn)
Get an associative array representation of the collection The first parameter specifies the column to be used for the key, And the seconf for the value.
$res = $coll->toKeyValue('Id', 'Name');