phpDocumentor

FontAwesomeIconClassProvider
in package

Table of Contents

$archived  : array<string|int, mixed>
$custom  : array<string|int, mixed>
$documents  : array<string|int, mixed>
$images  : array<string|int, mixed>
$map  : array<string|int, mixed>
$media  : array<string|int, mixed>
$presentation  : array<string|int, mixed>
$tables  : array<string|int, mixed>
$text  : array<string|int, mixed>
getClass()  : string
Returns a font awesome class string by the given type.

Properties

$custom

protected static array<string|int, mixed> $custom = ['pdf' => 'fa fa-file-pdf-o', 'html' => 'fa fa-html5', 'htm' => 'fa fa-html5', 'link' => 'fa fa-link']

$documents

protected static array<string|int, mixed> $documents = ['doc', 'docx', 'docm', 'dot', 'dotm', 'dotx', 'odt', 'ods', 'odg', 'odc', 'odf', 'odi', 'odm', 'ott', 'ots', 'otp', 'otg']

$map

protected static array<string|int, mixed> $map = ['media' => 'fa fa-play-circle-o', 'documents' => 'fa fa-file-o', 'tables' => 'fa fa-table', 'presentation' => 'fa fa-file-powerpoint-o', 'images' => 'fa fa-file-image-o', 'text' => 'fa fa-file-text-o', 'archived' => 'fa fa-file-archive-o']

$media

protected static array<string|int, mixed> $media = ['webm', 'ogx', 'ogv', 'oga', 'ogg', 'ogm', 'spx', 'mp3', 'mp4', 'wav', 'asf', 'mpg', 'mpeg', 'avi', 'wmv', 'mov', 'ram']

$presentation

protected static array<string|int, mixed> $presentation = ['odp', 'ppa', 'ppam', 'pps', 'ppsm', 'ppsx', 'ppt', 'pptm', 'pptx', 'pptx', 'pptx', 'pot', 'potm', 'potx']

Methods

getClass()

Returns a font awesome class string by the given type.

public static getClass(string $type) : string

If no type for the given file type was found, the fallback class 'fa fa-file-text-o' will be returned.

Parameters
$type : string

File type, which is represent by the font awesome icon class.

Return values
string

Font awesome class string.

Search results