Propel API
Class

ModelWith

class ModelWith

Data object to describe a joined hydration in a Model Query ModelWith objects are used by formatters to hydrate related objects

Methods

__construct(ModelJoin $join = null)

init(ModelJoin $join)

Define the joined hydration schema based on a join object.

setModelName($modelName)

getModelName()

setModelPeerName($modelPeerName)

getModelPeerName()

setIsSingleTableInheritance($isSingleTableInheritance)

isSingleTableInheritance()

setIsAdd($isAdd)

isAdd()

setIsWithOneToMany($isWithOneToMany)

isWithOneToMany()

setRelationName($relationName)

getRelationName()

setRelationMethod($relationMethod)

getRelationMethod()

setInitMethod($initMethod)

getInitMethod()

setLeftPhpName($leftPhpName)

getLeftPhpName()

setRightPhpName($rightPhpName)

getRightPhpName()

isPrimary()

__toString()

Details

at line 31
public __construct(ModelJoin $join = null)

Parameters

ModelJoin $join

at line 44
public init(ModelJoin $join)

Define the joined hydration schema based on a join object.

Fills the ModelWith properties using a ModelJoin as source

Parameters

ModelJoin $join

at line 69
public setModelName($modelName)

Parameters

$modelName

at line 74
public getModelName()

at line 79
public setModelPeerName($modelPeerName)

Parameters

$modelPeerName

at line 84
public getModelPeerName()

at line 89
public setIsSingleTableInheritance($isSingleTableInheritance)

Parameters

$isSingleTableInheritance

at line 94
public isSingleTableInheritance()

at line 99
public setIsAdd($isAdd)

Parameters

$isAdd

at line 104
public isAdd()

at line 109
public setIsWithOneToMany($isWithOneToMany)

Parameters

$isWithOneToMany

at line 114
public isWithOneToMany()

at line 119
public setRelationName($relationName)

Parameters

$relationName

at line 124
public getRelationName()

at line 129
public setRelationMethod($relationMethod)

Parameters

$relationMethod

at line 134
public getRelationMethod()

at line 139
public setInitMethod($initMethod)

Parameters

$initMethod

at line 144
public getInitMethod()

at line 149
public setLeftPhpName($leftPhpName)

Parameters

$leftPhpName

at line 154
public getLeftPhpName()

at line 159
public setRightPhpName($rightPhpName)

Parameters

$rightPhpName

at line 164
public getRightPhpName()

at line 171
public isPrimary()

at line 176
public __toString()