Overview

Namespaces

  • Khill
    • Fontawesome
      • Exceptions
  • PHP

Classes

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

Class FontAwesomeList

Namespace: Khill\Fontawesome
Located at FontAwesomeList.php
Methods summary
public Khill\Fontawesome\FontAwesome
# __construct( string $icon = '' )

Assigns the name to the icon

Assigns the name to the icon

Parameters

$icon
string
$icon Icon label

Returns

Khill\Fontawesome\FontAwesome
FontAwesome object
public string
# output( )

Outputs the FontAwesomeList object as an HTML string

Outputs the FontAwesomeList object as an HTML string

Returns

string
HTML string of list

Throws

Khill\Fontawesome\Exceptions\IncompleteListException
If No default icon was setempty string
public Khill\Fontawesome\FontAwesomeList
# addClass( string $class )

Adds extra classes to list

Adds extra classes to list

Parameters

$class
string
$class CSS class

Returns

Khill\Fontawesome\FontAwesomeList
FontAwesomeList object

Throws

Khill\Fontawesome\Exceptions\IncompleteListException
If $class is not a non empty string
public Khill\Fontawesome\FontAwesomeList
# addItem( string $line )

Add an item to the list

Add an item to the list

Parameters

$line
string
$line Line to add to the list

Returns

Khill\Fontawesome\FontAwesomeList
FontAwesomeList object

Throws

Khill\Fontawesome\Exceptions\IncompleteListException
If $line is not a non empty string
public Khill\Fontawesome\FontAwesomeList
# addItems( string $lineArray )

Add multiple items to list

Add multiple items to list

Parameters

$lineArray
string
$lineArray Array of lines to add to list

Returns

Khill\Fontawesome\FontAwesomeList
FontAwesomeList object

Throws

Khill\Fontawesome\Exceptions\IncompleteListException
If $lineArray is not an array
public
# setDefaultIcon( string $icon )

Sets the default icon to be used in the list

Sets the default icon to be used in the list

Parameters

$icon
string
$icon Icon label

Throws

Khill\Fontawesome\Exceptions\BadLabelException
If $icon is not a string
public
# setListItems( array $listItems )

Sets the entire list with multiple icons

Sets the entire list with multiple icons

Parameters

$listItems
array
$listItems Array of icons and list items
Constants summary
string UL_HTML '<ul class="fa-ul">%s</ul>'
#

Html string template to build the list

Html string template to build the list

string LI_HTML '<li>%s%s</li>'
#

Html string template to build the list items

Html string template to build the list items

string ICON_HTML '<i class="fa %s"></i>'
#

Html string template to build the icon

Html string template to build the icon

API documentation generated by ApiGen 2.8.0