Documentation

pager extends helper

in package

• fpcm
• view
• helper

Pager view helper object

Tags

author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2022, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

Table of Contents

ID_START_PREFIX  = 'fpcm-id-'

LABEL_TYPE_DEFAULT  = 'input-group'

LABEL_TYPE_FLOATING  = 'form-floating'

TEXT_DEFAULT_LABEL  = 'LABEL_FIELD_'

$aria  : array<string|int, mixed>

Ement aria config

$autoFocused  : bool

Element is autoFocused

$bottomSpace  : string

UI element bottom spance

$class  : string

CSS class string

$data  : array<string|int, mixed>

Element data

$id  : string

Element ID

$labelClass  : string

CS class for label

$labelType  : string

Column with if input uses an icon

$language  : language

Language object

$name  : string

Element name

$prefix  : string

Element prefix

$readonly  : bool

Element is readonly

$requ  : bool

Element is required

$returned  : bool

Flag if element string was return by @see __toString

$text  : string

Input label

$useWrapper  : string

Add div wrapper to input field

$wrapperClass  : string

CSS class for div wrapper

$actionLink  : int

Action data for pager

$currentPage  : int

Current page

$currentPageItemsCount  : int

Numer of items on current page

$itemsPerPage  : int

Numer of items per page

$maxItemCount  : int

Maximum numer of items

$maxPages  : int

Caculated numer if pages

$showBackButton  : int

Show button to previews page

$showNextButton  : int

Show button to next page

__construct()  : mixed

Konstruktor

getCleanName()  : string

Name cleanup from bracket, etc.

getIdString()  : string

Returns name and ID string

getJsLangVars()  : array<string|int, mixed>

Returns optional JavaScript language vars

getJsVars()  : array<string|int, mixed>

Returns optional JavaScript vars

initFromYml()  : bool

setAria()  : $this

Add array for 'data-'-params to element

setAutoFocused()  : $this

Make helper auto focused

setBottomSpace()  : $this

Set bottom space class

setClass()  : $this

Set additional css class

setData()  : $this

Add array for 'data-'-params to element

setLabelClass()  : $this

Set label class CSS string

setLabelTypeFloat()  : $this

Set label typ to floating

setReadonly()  : $this

Set element to readonly

setRequired()  : $this

Set required flag

setReturned()  : $this

Prevents rendering of view helper at the end of PHP proessing

setText()  : $this

Set button description

setWrapper()  : $this

Use div wrapper around input field

setWrapperClass()  : $this

Set wrapper css class

getAriaString()  : string

Return class string

getAutoFocusedString()  : string

Return autofocused string

getClassString()  : string

Return class string

getColorMode()  : string

Returns color mode

getDataString()  : string

Return class string

getDescriptionTextString()  : string

Returns name and ID string

getNameIdString()  : string

Returns name and ID string

getReadonlyString()  : string

Return class string

getString()  : string

Return element string

initLabel()  : bool

Initialized default label by field name

isFloating()  : bool

assocArrayToString()  : string

Turns assoc array into string