Propel 2 API
Class

Propel\Runtime\Formatter\AbstractFormatter

abstract class AbstractFormatter

Abstract class for query formatter

Methods

__construct(BaseModelCriteria $criteria = null, DataFetcherInterface $dataFetcher = null)

setDataFetcher(DataFetcherInterface $dataFetcher)

Sets a DataFetcherInterface object.
DataFetcherInterface getDataFetcher()

Returns the current DataFetcherInterface object.
AbstractFormatter init(BaseModelCriteria $criteria, DataFetcherInterface $dataFetcher = null)

Define the hydration schema based on a query object.
setDbName($dbName)

getDbName()

setClass($class)

getClass()

setWith($withs = array())

getWith()

setAsColumns($asColumns = array())

getAsColumns()

setHasLimit($hasLimit = false)

hasLimit()

getCollectionClassName()

BaseObject formatRecord(BaseObject $record = null)

Formats an ActiveRecord object
format(DataFetcherInterface $dataFetcher = null)

formatOne(DataFetcherInterface $dataFetcher = null)

isObjectFormatter()

checkInit()

getTableMap()

BaseObject getSingleObjectFromRow(array $row, string $class, int $col)

Gets a Propel object hydrated from a selection of columns in statement row

Details

at line 46
public __construct(BaseModelCriteria $criteria = null, DataFetcherInterface $dataFetcher = null)

Parameters

BaseModelCriteria $criteria
DataFetcherInterface $dataFetcher

at line 63
public setDataFetcher(DataFetcherInterface $dataFetcher)

Sets a DataFetcherInterface object.

Parameters

DataFetcherInterface $dataFetcher

at line 73
public DataFetcherInterface getDataFetcher()

Returns the current DataFetcherInterface object.

Return Value

DataFetcherInterface

at line 87
public AbstractFormatter init(BaseModelCriteria $criteria, DataFetcherInterface $dataFetcher = null)

Define the hydration schema based on a query object.

Fills the Formatter's properties using a Criteria as source

Parameters

BaseModelCriteria $criteria
DataFetcherInterface $dataFetcher

Return Value

AbstractFormatter The current formatter object

at line 103
public setDbName($dbName)

Parameters

$dbName

at line 108
public getDbName()

at line 113
public setClass($class)

Parameters

$class

at line 119
public getClass()

at line 124
public setWith($withs = array())

Parameters

$withs

at line 129
public getWith()

at line 134
public setAsColumns($asColumns = array())

Parameters

$asColumns

at line 139
public getAsColumns()

at line 144
public setHasLimit($hasLimit = false)

Parameters

$hasLimit

at line 149
public hasLimit()

at line 172
public getCollectionClassName()

at line 184
public BaseObject formatRecord(BaseObject $record = null)

Formats an ActiveRecord object

Parameters

BaseObject $record the object to format

Return Value

BaseObject The original record

at line 189
abstract public format(DataFetcherInterface $dataFetcher = null)

Parameters

DataFetcherInterface $dataFetcher

at line 191
abstract public formatOne(DataFetcherInterface $dataFetcher = null)

Parameters

DataFetcherInterface $dataFetcher

at line 193
abstract public isObjectFormatter()

at line 195
public checkInit()

at line 202
public getTableMap()

at line 251
public BaseObject getSingleObjectFromRow(array $row, string $class, int $col)

Gets a Propel object hydrated from a selection of columns in statement row

Parameters

array $row associative array indexed by column number, as returned by DataFetcher::fetch()
string $class The classname of the object to create
int $col The start column for the hydration (modified)

Return Value

BaseObject