abstract class Doctrine_Pager_Range (View source)

Doctrine_Pager_Range

Properties

protected array $_options

Methods

void
__construct(array $options = array(), Doctrine_Pager $pager = null)

__construct

void
setPager($pager)

setPager

array
getOptions()

getOptions

array
getOption($option)

getOption

void
_setOptions($options)

_setOptions

boolean
isInRange($page)

isInRange

void
_initialize()

_initialize

array
rangeAroundPage()

rangeAroundPage

Details

final void __construct(array $options = array(), Doctrine_Pager $pager = null)

__construct

Parameters

array $options Custom subclass implementation options. Default is a blank array
Doctrine_Pager $pager Optional Doctrine_Pager object to be associated

Return Value

void

Doctrine_Pager getPager()

getPager

Returns the Doctrine_Pager object related to the pager range

Return Value

Doctrine_Pager Doctrine_Pager object related to the pager range

void setPager($pager)

setPager

Defines the Doctrine_Pager object related to the pager range and automatically (re-)initialize Doctrine_Pager_Range

Parameters

$pager Doctrine_Pager object related to the pager range

Return Value

void

array getOptions()

getOptions

Returns the custom Doctrine_Pager_Range implementation options

Return Value

array Custom Doctrine_Pager_Range implementation options

array getOption($option)

getOption

Returns the custom Doctrine_Pager_Range implementation offset option

Parameters

$option

Return Value

array Custom Doctrine_Pager_Range implementation options

protected void _setOptions($options)

_setOptions

Defines the subclass implementation options

Parameters

$options Custom Doctrine_Pager_Range implementation options

Return Value

void

boolean isInRange($page)

isInRange

Check if a given page is in the range

Parameters

$page Page to be checked

Return Value

boolean

abstract protected void _initialize()

_initialize

Initialize Doctrine_Page_Range subclass which does custom class definitions

Return Value

void

abstract array rangeAroundPage()

rangeAroundPage

Calculate and returns an array representing the range around the current page

Return Value

array