class BaseLoop

Class BaseLoop

Methods

__construct( ContainerInterface $container)

Create a new Loop

mixed
__call( string $name, mixed $arguments)

Provides a getter to loop parameter values

initializeArgs( array $nameValuePairs)

Initialize the loop arguments.

count()

No description

exec( PropelModelPager $pagination)

No description

parseResults( LoopResult $loopResult)

No description

getArgumentCollection()

Get the argument collection

null|String
getLoopName()

Get the loop name

string
getType()

No description

bool
getForceReturn()

No description

bool
getBackendContext()

No description

int
getOffset()

available if countable is true

int
getPage()

available if countable is true

int
getLimit()

available if countable is true

bool
getReturnUrl()

false for disable the generation of urls

ModelCriteria
buildModelCriteria()

No description

array
buildArray()

No description

Details

at line 99
__construct( ContainerInterface $container)

Create a new Loop

Parameters

ContainerInterface $container

at line 210
mixed __call( string $name, mixed $arguments)

Provides a getter to loop parameter values

Parameters

string $name the method name (only getArgname is supported)
mixed $arguments this parameter is ignored

Return Value

mixed the argument value

Exceptions

InvalidArgumentException if the parameter is unknown or the method name is not supported.

at line 231
initializeArgs( array $nameValuePairs)

Initialize the loop arguments.

Parameters

array $nameValuePairs a array of name => value pairs. The name is the name of the argument.

Exceptions

InvalidArgumentException if some argument values are missing, or invalid

at line 456
count()

at line 496
LoopResult exec( PropelModelPager $pagination)

Parameters

PropelModelPager $pagination

Return Value

LoopResult

at line 613
abstract LoopResult parseResults( LoopResult $loopResult)

Parameters

LoopResult $loopResult

Return Value

LoopResult

at line 744
ArgumentCollection getArgumentCollection()

Get the argument collection

Return Value

ArgumentCollection

at line 754
null|String getLoopName()

Get the loop name

Return Value

null|String

at line 52
string getType()

Return Value

string

at line 52
bool getForceReturn()

Return Value

bool

at line 52
bool getBackendContext()

Return Value

bool

at line 52
int getOffset()

available if countable is true

Return Value

int

at line 52
int getPage()

available if countable is true

Return Value

int

at line 52
int getLimit()

available if countable is true

Return Value

int

at line 52
bool getReturnUrl()

false for disable the generation of urls

Return Value

bool

at line 52
ModelCriteria buildModelCriteria()

Return Value

ModelCriteria

at line 52
array buildArray()

Return Value

array