Overview

Namespaces

  • Khill
    • Fontawesome
      • Exceptions
  • PHP

Classes

  • FontAwesome
  • FontAwesomeFacade
  • FontAwesomeList
  • FontAwesomeServiceProvider
  • FontAwesomeStack
  • Overview
  • Namespace
  • Class
  • Tree

Class FontAwesomeStack

Namespace: Khill\Fontawesome
Located at FontAwesomeStack.php
Methods summary
public string
# output( )

Outputs the FontAwesome object as an HTML string

Outputs the FontAwesome object as an HTML string

Returns

string
HTML string of icon or stack
public Khill\Fontawesome\FontAwesomeStack
# setTopIcon( string $icon )

Sets the top icon to be used in a stack

Sets the top icon to be used in a stack

Parameters

$icon
string
$icon Icon label

Returns

Khill\Fontawesome\FontAwesomeStack
FontAwesomeStack object

Throws

Khill\Fontawesome\Exceptions\BadLabelException
If $icon is not a string
public Khill\Fontawesome\FontAwesomeStack
# setBottomIcon( string $icon )

Sets the bottom icon to be used in a stack

Sets the bottom icon to be used in a stack

Parameters

$icon
string
$icon Icon label

Returns

Khill\Fontawesome\FontAwesomeStack
FontAwesomeStack object

Throws

Khill\Fontawesome\Exceptions\BadLabelException
If $icon is not a string
Khill\Fontawesome\Exceptions\IncompleteStackException
If The on() method was called without the stack() method
public Khill\Fontawesome\FontAwesomeStack
# addClass( string $class )

Add extra classes to the stack

Add extra classes to the stack

Parameters

$class
string
$class CSS class

Returns

Khill\Fontawesome\FontAwesomeStack
FontAwesomeStack object

Throws

Khill\Fontawesome\Exceptions\BadLabelException
If $class is not a string
Constants summary
string ICON_HTML '<i class="fa fa-%s %s"></i>'
#

Html string template to build the icon

Html string template to build the icon

string STACK_HTML '<span class="%s">%s%s</span>'
#

Html string template to build the icon stack

Html string template to build the icon stack

Properties summary
public string $topIcon ''
#

Stores top icon in a stack

Stores top icon in a stack

public string $bottomIcon ''
#

Stores bottom icon in a stack

Stores bottom icon in a stack

API documentation generated by ApiGen 2.8.0