Documentation

badge extends helper
in package
Uses iconHelper, valueHelper

Badge 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

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
$icon  : string
Icon class
$iconOnly  : bool
Show icon only
$iconStack  : string
Button text
$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
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
__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
initFromYml()  : bool
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
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
setValue()  : $this
Set input value
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
getIconString()  : string
Return full icon string
getNameIdString()  : string
Returns name and ID string
getReadonlyString()  : string
Return class 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

Constants

LABEL_TYPE_DEFAULT

public mixed LABEL_TYPE_DEFAULT = 'input-group'

LABEL_TYPE_FLOATING

public mixed LABEL_TYPE_FLOATING = 'form-floating'

TEXT_DEFAULT_LABEL

public mixed TEXT_DEFAULT_LABEL = 'LABEL_FIELD_'

Properties

$aria

Ement aria config

protected array<string|int, mixed> $aria = []
Tags
since
5.0-dev

$autoFocused

Element is autoFocused

protected bool $autoFocused = false
Tags
since
4.1

$data

Element data

protected array<string|int, mixed> $data = []

$iconOnly

Show icon only

protected bool $iconOnly = false

$iconStack

Button text

protected string $iconStack = ''

$id

Element ID

protected string $id = ''

$labelClass

CS class for label

protected string $labelClass = ''
Tags
since
4.1

$labelType

Column with if input uses an icon

protected string $labelType = 'input-group'

$name

Element name

protected string $name = ''

$prefix

Element prefix

protected string $prefix = ''

$readonly

Element is readonly

protected bool $readonly = false

$requ

Element is required

protected bool $requ = false
Tags
since
5.0.0-a3

$returned

Flag if element string was return by @see __toString

protected bool $returned = false

$spinner

Spinner class for icon

protected string $spinner = ''
Tags
since
4.2

$stackTop

Move stack icon to top

protected bool $stackTop = false

$text

Input label

protected string $text = ''

$useWrapper

Add div wrapper to input field

protected string $useWrapper = false

$wrapperClass

CSS class for div wrapper

protected string $wrapperClass = ''

Methods

__construct()

Konstruktor

public __construct(string $name[, string $id = '' ]) : mixed
Parameters
$name : string
$id : string = ''
Return values
mixed

getCleanName()

Name cleanup from bracket, etc.

public final getCleanName() : string
Return values
string

getIdString()

Returns name and ID string

public final getIdString() : string
Return values
string

getJsLangVars()

Returns optional JavaScript language vars

public getJsLangVars() : void
Return values
void

getJsVars()

Returns optional JavaScript vars

public getJsVars() : void
Return values
void

initFromYml()

public final initFromYml(array<string|int, mixed> $param, array<string|int, mixed> $viewVars) : bool
Parameters
$param : array<string|int, mixed>
$viewVars : array<string|int, mixed>
Tags
since
4.5
Return values
bool

setAria()

Add array for 'data-'-params to element

public setAria(array<string|int, mixed> $aria) : $this
Parameters
$aria : array<string|int, mixed>
Return values
$this

setAutoFocused()

Make helper auto focused

public setAutoFocused(bool $autoFocused) : $this
Parameters
$autoFocused : bool
Tags
since
4.1
Return values
$this

setClass()

Set additional css class

public setClass(string $class) : $this
Parameters
$class : string
Return values
$this

setData()

Add array for 'data-'-params to element

public setData(array<string|int, mixed> $data) : $this
Parameters
$data : array<string|int, mixed>
Return values
$this

setIcon()

Set icon

public setIcon(string $icon[, string $prefix = 'fa' ][, bool $useFa = true ]) : $this
Parameters
$icon : string

Icon CSS classes

$prefix : string = 'fa'

Icon prefix

$useFa : bool = true

Auto-add FontAwesome Icon classes

Return values
$this

setIconOnly()

Set button to display icon only

public setIconOnly(string $iconOnly) : $this
Parameters
$iconOnly : string
Return values
$this

setLabelClass()

Set label class CSS string

public setLabelClass(string $labelClass) : $this
Parameters
$labelClass : string
Tags
since
4.1
Return values
$this

setLabelTypeFloat()

Set label typ to floating

public setLabelTypeFloat() : $this
Tags
since
5.0.0-b4
Return values
$this

setReadonly()

Set element to readonly

public setReadonly(bool $readonly) : $this
Parameters
$readonly : bool
Return values
$this

setRequired()

Set required flag

public setRequired(bool $requ) : $this
Parameters
$requ : bool
Tags
since
5.0.0-a3
Return values
$this

setReturned()

Prevents rendering of view helper at the end of PHP proessing

public setReturned(bool $returned) : $this
Parameters
$returned : bool
Return values
$this

setSize()

Set Icon size

public setSize(string $size[, bool $useFa = true ]) : $this
Parameters
$size : string
$useFa : bool = true

Auto-add FontAwesome Icon classes

Return values
$this

setSpinner()

Set flag icon has spinner

public setSpinner(string $spinner[, bool $useFa = true ]) : $this
Parameters
$spinner : string
$useFa : bool = true
Return values
$this

setStack()

Set if icon is stacked

public setStack(string $iconStack[, bool $useFa = true ]) : $this
Parameters
$iconStack : string
$useFa : bool = true

Auto-add FontAwesome Icon classes

Return values
$this

setStackTop()

Move stack icon to top

public setStackTop(bool $stackTop) : $this
Parameters
$stackTop : bool
Return values
$this

setText()

Set button description

public final setText(string $text[, array<string|int, mixed> $params = [] ]) : $this
Parameters
$text : string
$params : array<string|int, mixed> = []
Return values
$this

setValue()

Set input value

public setValue(mixed $value[, int $escapeMode = null ]) : $this
Parameters
$value : mixed
$escapeMode : int = null
Return values
$this

setWrapper()

Use div wrapper around input field

public setWrapper(bool $useWrapper) : $this
Parameters
$useWrapper : bool
Return values
$this

setWrapperClass()

Set wrapper css class

public setWrapperClass(string $wrapperClass) : $this
Parameters
$wrapperClass : string
Return values
$this

getAriaString()

Return class string

protected getAriaString() : string
Return values
string

getAutoFocusedString()

Return autofocused string

protected getAutoFocusedString() : string
Return values
string

getClassString()

Return class string

protected getClassString() : string
Return values
string

getDataString()

Return class string

protected getDataString() : string
Return values
string

getDescriptionTextString()

Returns name and ID string

protected final getDescriptionTextString([string $prefix = 'ps-1' ]) : string
Parameters
$prefix : string = 'ps-1'
Return values
string

getIconString()

Return full icon string

protected getIconString() : string
Return values
string

getNameIdString()

Returns name and ID string

protected getNameIdString() : string
Return values
string

getReadonlyString()

Return class string

protected getReadonlyString() : string
Return values
string

getString()

Return element string

protected getString() : string
Return values
string

getValueString()

Return value string

protected getValueString() : string
Return values
string

init()

Optional init function

protected init() : void
Return values
void

initLabel()

Initialized default label by field name

protected final initLabel() : bool
Tags
since
4.3.0
Return values
bool

assocArrayToString()

Turns assoc array into string

private assocArrayToString(string $prefix, array<string|int, mixed> $data) : string
Parameters
$prefix : string
$data : array<string|int, mixed>
Return values
string

Search results