class PropelObjectFormatter extends PropelFormatter
Object formatter for Propel query format() returns a PropelObjectCollection of Propel model objects
Methods
| __construct(ModelCriteria $criteria = null) | from PropelFormatter | |
| PropelFormatter |
init(ModelCriteria $criteria)
Define the hydration schema based on a query object. |
from PropelFormatter |
| setDbName($dbName) | from PropelFormatter | |
| getDbName() | from PropelFormatter | |
| setClass($class) | from PropelFormatter | |
| getClass() | from PropelFormatter | |
| setPeer($peer) | from PropelFormatter | |
| getPeer() | from PropelFormatter | |
| setWith($withs = array()) | from PropelFormatter | |
| getWith() | from PropelFormatter | |
| setAsColumns($asColumns = array()) | from PropelFormatter | |
| getAsColumns() | from PropelFormatter | |
| setHasLimit($hasLimit = false) | from PropelFormatter | |
| hasLimit() | from PropelFormatter | |
| BaseObject |
formatRecord(BaseObject $record = null)
Formats an ActiveRecord object |
from PropelFormatter |
| format(PDOStatement $stmt) | ||
| formatOne(PDOStatement $stmt) | ||
| isObjectFormatter() | ||
| checkInit() | from PropelFormatter | |
| getTableMap() | from PropelFormatter | |
| BaseObject |
getSingleObjectFromRow(array $row, string $class, int $col)
Gets a Propel object hydrated from a selection of columns in statement row |
from PropelFormatter |
| BaseObject |
getAllObjectsFromRow(array $row)
Hydrates a series of objects from a result row The first object to hydrate is the model of the Criteria The following objects (the ones added by way of ModelCriteria::with()) are linked to the first one |
Details
in PropelFormatter at line 29
public
__construct(ModelCriteria $criteria = null)
in PropelFormatter at line 44
public PropelFormatter
init(ModelCriteria $criteria)
Define the hydration schema based on a query object.
Fills the Formatter's properties using a Criteria as source
in PropelFormatter at line 57
public
setDbName($dbName)
in PropelFormatter at line 62
public
getDbName()
in PropelFormatter at line 67
public
setClass($class)
in PropelFormatter at line 73
public
getClass()
in PropelFormatter at line 78
public
setPeer($peer)
in PropelFormatter at line 83
public
getPeer()
in PropelFormatter at line 88
public
setWith($withs = array())
in PropelFormatter at line 93
public
getWith()
in PropelFormatter at line 98
public
setAsColumns($asColumns = array())
in PropelFormatter at line 103
public
getAsColumns()
in PropelFormatter at line 108
public
setHasLimit($hasLimit = false)
in PropelFormatter at line 113
public
hasLimit()
in PropelFormatter at line 125
public BaseObject
formatRecord(BaseObject $record = null)
Formats an ActiveRecord object
at line 23
public
format(PDOStatement $stmt)
at line 57
public
formatOne(PDOStatement $stmt)
at line 69
public
isObjectFormatter()
in PropelFormatter at line 136
public
checkInit()
in PropelFormatter at line 143
public
getTableMap()
in PropelFormatter at line 190
public BaseObject
getSingleObjectFromRow(array $row, string $class, int $col)
Gets a Propel object hydrated from a selection of columns in statement row
at line 84
public BaseObject
getAllObjectsFromRow(array $row)
Hydrates a series of objects from a result row The first object to hydrate is the model of the Criteria The following objects (the ones added by way of ModelCriteria::with()) are linked to the first one