Documentation

jsIcon extends icon

in package

• fpcm
• view
• helper

implements JsonSerializable

Icon dummy helper for JavsScript use

Tags

author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2022, Stefan Seehafer

license

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

since

4-5

Interfaces, Classes, Traits and Enums

JsonSerializable

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

$icon  : string

Icon class

$iconOnly  : bool

Show icon only

$iconStack  : string

Icon stack class

$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

$size  : string

Icon size

$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

$wrapperClass  : string

CSS class for div wrapper

__construct()  : mixed

Konstruktor

getCleanName()  : string

Name cleanup from bracket, etc.

getIdString()  : string

Returns name and ID string

getJsLangVars()  : void

Returns optional JavaScript language vars

getJsVars()  : void

Returns optional JavaScript vars

getText()  : string

Return text set on icon

initFromYml()  : bool

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

Returns array for object

parseLangvarIcon()  : bool1

Parse language variable icon

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

setIcon()  : $this

Set icon

setIconOnly()  : $this

Set button to display icon only

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

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

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

getIconString()  : string

Return full icon string

getNameIdString()  : string

Returns name and ID string

getReadonlyString()  : string

Return class string

getString()  : string

Return element string

init()  : void

Optional init function

initLabel()  : bool

Initialized default label by field name

isFloating()  : bool

assocArrayToString()  : string

Turns assoc array into string