Documentation

select extends helper

in package

• fpcm
• view
• helper

Uses iconHelper, valueHelper, selectedHelper, labelFieldSize

Select menu view helper object

Tags

author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2020, Stefan Seehafer

license

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

Table of Contents

FIRST_OPTION_DISABLED  = -3

FIRST_OPTION_EMPTY  = -1

FIRST_OPTION_PLEASESELECT  = -2

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

$class  : string

CSS class string

$data  : array<string|int, mixed>

Element data

$fieldSize  : string

Input field size

$firstOption  : int

Is first option auto added

$hasOptGroup  : bool

Select includes opt groups

$icon  : string

Icon class

$iconOnly  : bool

Show icon only

$iconStack  : string

Button text

$id  : string

Element ID

$isMultiple  : bool

Select multiple options

$labelClass  : string

CS class for label

$labelSize  : string

Label size string

$labelType  : string

Column with if input uses an icon

$language  : language

Language object

$name  : string

Element name

$options  : array<string|int, mixed>

Select options

$prefix  : string

Element prefix

$prependLabel  : bool

Prepend label to selectbox

$readonly  : bool

Element is readonly

$requ  : bool

Element is required

$returned  : bool

Flag if element string was return by @see __toString

$returnString  : string

Option return string

$selected  : string|array<string|int, mixed>

Element value

$size  : string

Button text

$spinner  : string

Spinner class for icon

$stackTop  : bool

Move stack icon to top

$text  : string

Input label

$useWrapper  : string

Add div wrapper to input field

$value  : string

Element value

$wrapperClass  : string

CSS class for div wrapper

$sizeMap  : array<string|int, mixed>

Size map

__construct()  : mixed

Konstruktor

getCleanName()  : string

Name cleanup from bracket, etc.

getFieldSize()  : string

Fetch field size classes

getIdString()  : string

Returns name and ID string

getJsLangVars()  : void

Returns optional JavaScript language vars

getJsVars()  : void

Returns optional JavaScript vars

getLabelSize()  : string

Fetch label size classes

initFromYml()  : bool

prependLabel()  : $this

Prepend label to select menu

setAria()  : $this

Add array for 'data-'-params to element

setAutoFocused()  : $this

Make helper auto focused

setClass()  : $this

Set additional css class

setData()  : $this

Add array for 'data-'-params to element

setDisplaySizes()  : $this

Sets label and field sizes

setDisplaySizesDefault()  : $this

Sets default label and field sizes values, Label: xs: 12, sm: 6, md: 5 Fields: xs: 12, sm: 6, md: 7

setFieldSize()  : $this

Sets field sizes only

setFirstOption()  : $this

Select auto-added first option, values are fpcm\view\helper\select::FIRST_OPTION_EMPTY, fpcm\view\helper\select::FIRST_OPTION_PLEASESELECT, fpcm\view\helper\select::FIRST_OPTION_DISABLED

setIcon()  : $this

Set icon

setIconOnly()  : $this

Set button to display icon only

setIsMultiple()  : $this

Enable multiple selection

setLabelClass()  : $this

Set label class CSS string

setLabelSize()  : $this

Sets label sizes only

setLabelTypeFloat()  : $this

Set label typ to floating

setOptGroup()  : $this

Enables opt group for select element

setOptions()  : $this

Set options for selectbox

setReadonly()  : $this

Set element to readonly

setRequired()  : $this

Set required flag

setReturned()  : $this

Prevents rendering of view helper at the end of PHP proessing

setSelected()  : $this

Set preselected value

setSize()  : $this

Set Icon size

setSpinner()  : $this

Set flag icon has spinner

setStack()  : $this

Set if icon is stacked

setStackTop()  : $this

Move stack icon to top

setText()  : $this

Set button description

setValue()  : $this

Set input value

setWidth()  : $this

Set with of select menu

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

getDataString()  : string

Return class string

getDescriptionTextString()  : string

Returns name and ID string

getFirstOption()  : bool

Return first option string

getIconString()  : string

Return full icon string

getNameIdString()  : string

Returns name and ID string

getOptionsGroupsString()  : string

Create options string

getOptionsString()  : string|void

Create options string

getReadonlyString()  : string

Return class string

getSelectedString()  : string

Return selected string

getString()  : string

Return element string

getValueString()  : string

Return value string

init()  : void

Optional init function

initLabel()  : bool

Initialized default label by field name

assocArrayToString()  : string

Turns assoc array into string

mapSizes()  : bool

Maps indices to sizeMap