class FontAwesomeIcon (View source)

Helper class to render a Font Awesome 5 icon.

Accepts font awesome 4 icon name for backward compatibility.

Constants

PREFIX_SOLID

PREFIX_BRANDS

PREFIX_REGULAR

PREFIX_LIGHT

PREFIX_DUOTONE

Properties

protected string $name
protected string $prefix
protected string $size
protected bool $fixedWidth
protected int $rotate
protected string $flip
protected bool $spin
protected bool $pulse
protected bool $bordered
protected string $pull
protected bool $pro
protected bool $migrateOldName
protected $migrateList

Methods

__construct(string $name, string $prefix = self::PREFIX_SOLID)

No description

string
getName()

No description

void
setName(string $name)

No description

string
getPrefix()

No description

void
setPrefix(string $prefix)

No description

string
getSize()

No description

void
setSize(string $size)

No description

bool
isFixedWidth()

No description

void
setFixedWidth(bool $fixedWidth)

No description

int
getRotate()

No description

void
setRotate(int $rotate)

No description

string
getFlip()

No description

void
setFlip(string $flip)

No description

bool
isSpin()

No description

void
setSpin(bool $spin)

No description

bool
isPulse()

No description

void
setPulse(bool $pulse)

No description

bool
isBordered()

No description

void
setBordered(bool $bordered)

No description

string
getPull()

No description

void
setPull(string $pull)

No description

bool
isPro()

No description

void
setPro(bool $pro)

No description

bool
shouldMigrateOldName()

No description

void
setMigrateOldName(bool $migrateOldName)

No description

void
migrateOldIconName()

No description

static FontAwesomeIcon
getFromClassNames(string $classname)

Get helper class from full class name list like 'far fa-address'.

Element
getTag()

No description

__toString()

No description

Details

__construct(string $name, string $prefix = self::PREFIX_SOLID)

No description

Parameters

string $name
string $prefix

string getName()

No description

Return Value

string

void setName(string $name)

No description

Parameters

string $name

Return Value

void

string getPrefix()

No description

Return Value

string

void setPrefix(string $prefix)

No description

Parameters

string $prefix

Return Value

void

string getSize()

No description

Return Value

string

void setSize(string $size)

No description

Parameters

string $size

Available options are 'xs', 'sm', 'lg', '2x', '3x', '5x', '7x', '10x'

Return Value

void

bool isFixedWidth()

No description

Return Value

bool

void setFixedWidth(bool $fixedWidth)

No description

Parameters

bool $fixedWidth

Return Value

void

int getRotate()

No description

Return Value

int

void setRotate(int $rotate)

No description

Parameters

int $rotate

Available options are 90, 180, 270

Return Value

void

string getFlip()

No description

Return Value

string

void setFlip(string $flip)

No description

Parameters

string $flip

Available options are 'horizontal', 'vertical' and 'both'

Return Value

void

bool isSpin()

No description

Return Value

bool

void setSpin(bool $spin)

No description

Parameters

bool $spin

Return Value

void

bool isPulse()

No description

Return Value

bool

void setPulse(bool $pulse)

No description

Parameters

bool $pulse

Return Value

void

bool isBordered()

No description

Return Value

bool

void setBordered(bool $bordered)

No description

Parameters

bool $bordered

Return Value

void

string getPull()

No description

Return Value

string

void setPull(string $pull)

No description

Parameters

string $pull

Available options are 'left' and 'right'

Return Value

void

bool isPro()

No description

Return Value

bool

void setPro(bool $pro)

No description

Parameters

bool $pro

Return Value

void

bool shouldMigrateOldName()

No description

Return Value

bool

void setMigrateOldName(bool $migrateOldName)

No description

Parameters

bool $migrateOldName

Return Value

void

protected void migrateOldIconName()

No description

Return Value

void

static FontAwesomeIcon getFromClassNames(string $classname)

Get helper class from full class name list like 'far fa-address'.

Also supports just icon name like 'address'

Parameters

string $classname

Return Value

FontAwesomeIcon

Element getTag()

No description

Return Value

Element

__toString()

No description