Documentation

badge extends helper
in
Uses iconHelper, valueHelper

Badge view helper object

Table of Contents

$icon Icon class string
$iconOnly Show icon only bool
$iconStack Button text string
$stackTop Move stack icon to top bool
$size Button text string
$spinner Spinner class for icon string
$value Element value string
$data Element data array
$id Element ID string
$name Element name string
$text Input label string
$class CSS class string string
$readonly Element is readonly bool
$autoFocused Element is autoFocused bool
$prefix Element prefix string
$useWrapper Add div wrapper to input field string
$wrapperClass CSS class for div wrapper string
$labelClass CS class for label string
$language Language object language
$returned Flag if element string was return by @see __toString bool
getString() Return element string string
init() Optional init function void
setIcon() Set icon $this
setIconOnly() Set button to display icon only $this
setStack() Set if icon is stacked $this
setSize() Set Icon size $this
setStackTop() Move stack icon to top $this
setSpinner() Set flag icon has spinner $this
getIconString() Return full icon string string
setValue() Set input value $this
getValueString() Return value string string
__construct() Konstruktor mixed
setReturned() Prevents rendering of view helper at the end of PHP proessing $this
getCleanName() Name cleanup from bracket, etc. string
getNameIdString() Returns name and ID string string
getIdString() Returns name and ID string string
getDescriptionTextString() Returns name and ID string string
initLabel() Initialized default label by field name bool
setClass() Set additional css class $this
getClassString() Return class string string
getDataString() Return class string string
getReadonlyString() Return class string string
setReadonly() Set element to readonly $this
setAutoFocused() Make helper auto focused $this
getAutoFocusedString() Return autofocused string string
setWrapper() Use div wrapper around input field $this
setWrapperClass() Set wrapper css class $this
setLabelClass() Set label class CSS string $this
setText() Set button description $this
getJsVars() Returns optional JavaScript vars void
getJsLangVars() Returns optional JavaScript language vars void
setData() Add array for 'data-'-params to element $this
initFromYml() bool
getString() Return element string string

Properties

$iconOnly

Show icon only

protected bool $iconOnly = false

$iconStack

Button text

protected string $iconStack = ''

$stackTop

Move stack icon to top

protected bool $stackTop = false

$spinner

Spinner class for icon

protected string $spinner = ''

$data

Element data

protected array $data = []

$id

Element ID

protected string $id = ''

$name

Element name

protected string $name = ''

$text

Input label

protected string $text = ''

$class

CSS class string

protected string $class = ''

$readonly

Element is readonly

protected bool $readonly = false

$autoFocused

Element is autoFocused

protected bool $autoFocused = false

$prefix

Element prefix

protected string $prefix = ''

$useWrapper

Add div wrapper to input field

protected string $useWrapper = false

$wrapperClass

CSS class for div wrapper

protected string $wrapperClass = ''

$labelClass

CS class for label

protected string $labelClass = ''

$returned

Flag if element string was return by @see __toString

protected bool $returned = false

Methods

getString()

Return element string

protected getString( ) : string
Return values
string

init()

Optional init function

protected init( ) : void

setIcon()

Set icon

public setIcon( $icon : string [, $prefix : string = 'fa' ] [, $useFa : bool = 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( $iconOnly : string ) : $this
Parameters
$iconOnly : string
Return values
$this

setStack()

Set if icon is stacked

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

Auto-add FontAwesome Icon classes

Return values
$this

setSize()

Set Icon size

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

Auto-add FontAwesome Icon classes

Return values
$this

setStackTop()

Move stack icon to top

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

setSpinner()

Set flag icon has spinner

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

getIconString()

Return full icon string

protected getIconString( ) : string
Return values
string

setValue()

Set input value

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

getValueString()

Return value string

protected getValueString( ) : string
Return values
string

__construct()

Konstruktor

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

setReturned()

Prevents rendering of view helper at the end of PHP proessing

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

getCleanName()

Name cleanup from bracket, etc.

protected final getCleanName( ) : string
Return values
string

getNameIdString()

Returns name and ID string

protected getNameIdString( ) : string
Return values
string

getIdString()

Returns name and ID string

public final getIdString( ) : string
Return values
string

getDescriptionTextString()

Returns name and ID string

protected final getDescriptionTextString( ) : string
Return values
string

initLabel()

Initialized default label by field name

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

setClass()

Set additional css class

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

getClassString()

Return class string

protected getClassString( ) : string
Return values
string

getDataString()

Return class string

protected getDataString( ) : string
Return values
string

getReadonlyString()

Return class string

protected getReadonlyString( ) : string
Return values
string

setReadonly()

Set element to readonly

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

setAutoFocused()

Make helper auto focused

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

getAutoFocusedString()

Return autofocused string

protected getAutoFocusedString( ) : string
Return values
string

setWrapper()

Use div wrapper around input field

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

setWrapperClass()

Set wrapper css class

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

setLabelClass()

Set label class CSS string

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

setText()

Set button description

public final setText( $text : string [, $params : array = [] ] ) : $this
Parameters
$text : string
$params : array = []
Return values
$this

getJsVars()

Returns optional JavaScript vars

public getJsVars( ) : void

getJsLangVars()

Returns optional JavaScript language vars

public getJsLangVars( ) : void

setData()

Add array for 'data-'-params to element

public setData( $data : array ) : $this
Parameters
$data : array
Return values
$this

initFromYml()

public final initFromYml( $param : array , $viewVars : array ) : bool
Parameters
$param : array
$viewVars : array
Tags
since
Return values
bool

getString()

Return element string

protected abstract getString( ) : string
Return values
string

Search results