Constants

VAR_CURRENT_PAGE

VAR_CURRENT_PAGE

FUNCTION_UPDATE_CURRENT_PAGE

FUNCTION_UPDATE_CURRENT_PAGE

Properties

$startPageNumber

$startPageNumber : integer

Type

integer — Start Page number

$customMaxPageNumber

$customMaxPageNumber : integer

Type

integer — Custom maximum page number

$previousChunkAction

$previousChunkAction : string

Type

string — Previous chunk action name

$nextChunkAction

$nextChunkAction : string

Type

string — Next chunk action name

$chunkActionAppendsPageNumber

$chunkActionAppendsPageNumber : boolean

Type

boolean — Chunk action appended with Page number

Methods

collect()

collect() : array<mixed,\FML\Script\Features\ScriptFeature>

Collect the Script Features of the given objects

Returns

array<mixed,\FML\Script\Features\ScriptFeature>

prepare()

prepare(\FML\Script\Script  $script) : static

Prepare the given Script for rendering by adding the needed Labels, etc.

Parameters

\FML\Script\Script $script

Script to prepare

Returns

static

__construct()

__construct(\FML\Controls\Label  $label = null, array<mixed,\FML\Script\Features\PagingPage>  $pages = null, array<mixed,\FML\Script\Features\PagingButton>  $buttons = null) 

Construct a new Paging

Parameters

\FML\Controls\Label $label

(optional) Page number Label

array<mixed,\FML\Script\Features\PagingPage> $pages

(optional) Pages

array<mixed,\FML\Script\Features\PagingButton> $buttons

(optional) Pageing Buttons

getLabel()

getLabel() : \FML\Controls\Label

Get the Label showing the Page number

Returns

\FML\Controls\Label

setLabel()

setLabel(\FML\Controls\Label  $label) : static

Set the Label showing the Page number

Parameters

\FML\Controls\Label $label

Page number Label

Returns

static

addPageControl()

addPageControl(\FML\Controls\Control  $pageControl, string  $pageNumber = null) : static

Add a new Page Control

Parameters

\FML\Controls\Control $pageControl

Page Control

string $pageNumber

(optional) Page number

Returns

static

setPages()

setPages(array<mixed,\FML\Script\Features\PagingPage>  $pages) : static

Add new Pages

Parameters

array<mixed,\FML\Script\Features\PagingPage> $pages

Pages

Returns

static

addButtonControl()

addButtonControl(\FML\Controls\Control  $buttonControl, integer  $browseAction = null) : static

Add a new Button Control to browse through the Pages

Parameters

\FML\Controls\Control $buttonControl

Button used for browsing

integer $browseAction

(optional) Number of browsed Pages per click

Returns

static

addButton()

addButton(\FML\Script\Features\PagingButton  $button) : static

Add a new Button to browse through Pages

Parameters

\FML\Script\Features\PagingButton $button

Paging Button

Returns

static

setButtons()

setButtons(array<mixed,\FML\Script\Features\PagingButton>  $buttons) : static

Set the Paging Buttons

Parameters

array<mixed,\FML\Script\Features\PagingButton> $buttons

Paging Buttons

Returns

static

getStartPageNumber()

getStartPageNumber() : integer

Get the start Page number

Returns

integer

setStartPageNumber()

setStartPageNumber(integer  $startPageNumber) : static

Set the start Page number

Parameters

integer $startPageNumber

Page number to start with

Returns

static

getCustomMaxPageNumber()

getCustomMaxPageNumber() : integer

Get a custom maximum Page number for using chunks

Returns

integer

setCustomMaxPageNumber()

setCustomMaxPageNumber(integer  $maxPageNumber) : static

Set a custom maximum Page number for using chunks

Parameters

integer $maxPageNumber

Custom maximum Page number

Returns

static

getPreviousChunkAction()

getPreviousChunkAction() : string

Get the action triggered when the previous chunk is needed

Returns

string

setPreviousChunkAction()

setPreviousChunkAction(string  $previousChunkAction) : static

Set the action triggered when the previous chunk is needed

Parameters

string $previousChunkAction

Triggered action

Returns

static

getNextChunkAction()

getNextChunkAction() : string

Get the action triggered when the next chunk is needed

Returns

string

setNextChunkAction()

setNextChunkAction(string  $nextChunkAction) : static

Set the action triggered when the next chunk is needed

Parameters

string $nextChunkAction

Triggered action

Returns

static

setChunkActions()

setChunkActions(string  $chunkAction) : static

Set the actions triggered when another chunk is needed

Parameters

string $chunkAction

Triggered action

Returns

static

getChunkActionAppendsPageNumber()

getChunkActionAppendsPageNumber() : boolean

Get if the chunk action should append the needed Page number

Returns

boolean

setChunkActionAppendsPageNumber()

setChunkActionAppendsPageNumber(boolean  $appendPageNumber) : static

Set if the chunk action should append the needed Page number

Parameters

boolean $appendPageNumber

Append the needed Page number

Returns

static

getPagesArrayText()

getPagesArrayText() : string

Build the array text for the Pages

Returns

string

getPageButtonsArrayText()

getPageButtonsArrayText() : string

Build the array text for the Page Buttons

Returns

string