iconHelper
View helper with Icon
Tags
Table of Contents
- $icon : string
- Icon class
- $iconOnly : bool
- Show icon only
- $iconStack : string
- Button text
- $size : string
- Button text
- $spinner : string
- Spinner class for icon
- $stackTop : bool
- Move stack icon to top
- setIcon() : $this
- Set icon
- setIconOnly() : $this
- Set button to display icon only
- 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
- getIconString() : string
- Return full icon string
Properties
$icon
Icon class
protected
string
$icon
= ''
$iconOnly
Show icon only
protected
bool
$iconOnly
= false
$iconStack
Button text
protected
string
$iconStack
= ''
$size
Button text
protected
string
$size
= ''
$spinner
Spinner class for icon
protected
string
$spinner
= ''
Tags
$stackTop
Move stack icon to top
protected
bool
$stackTop
= false
Methods
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 —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 —getIconString()
Return full icon string
protected
getIconString() : string