font awesome php

Une bibliothèque PHP pour Font Awesome.

Ce référentiel contient les données nécessaires pour travailler avec Font Awesome en PHP.

Exigences:

• Font génial 4.7.0
• PHP 5.3+.

Licence

• MIT - Détails

Installation

Avec compositeur:

composer require awps/font-awesome-php

Manuellement:

 require_once ' src/load.php ' ;

Usage

La bibliothèque contient 2 classes principales créées pour le public:

• AwpsFontAwesome() - utilise un tableau statique d'icônes FA. (Recommandée)
• AwpsFontAwesomeReader( $css_path ) - Génère le tableau à partir du fichier font-awesome.css . Vous devez définir le chemin d'accès à ce fichier.

Créer une instance:

 // Using the reader to dynamically get the icons array. It's resource intensive and you must cache the result.
$ css_path = __DIR__ . ' /css/font-awesome.css ' ;
$ icons    = new Awps  FontAwesomeReader ( $ css_path );

// .... or better use the static class

$ icons = new Awps  FontAwesome ();

Ensuite, c'est facile. Vous pouvez obtenir la gamme d'icônes simplement en faisant cela.

 $ icons -> getArray ();

// Result:
/*
array (
  'fa-glass' => '\f000',
  'fa-music' => '\f001',
  'fa-search' => '\f002',
  ...
*/

API:

->getAllData()

 $ icons -> getAllData ();

// Result:
/*
array (
  'fa-glass' => 
  array (
    'unicode' => '\f000',
    'name' => 'Glass',
    'class' => 'fa-glass',
  ),
  'fa-music' => 
  array (
    'unicode' => '\f001',
    'name' => 'Music',
    'class' => 'fa-music',
  ),
  ...
*/ 

->getCssClasses()

 $ icons -> getCssClasses ();

// Result:
/*
array (
  'fa-glass' => 'fa-glass',
  'fa-music' => 'fa-music',
  'fa-search' => 'fa-search',
  ...
*/ 

->getUnicodeKeys()

 $ icons -> getUnicodeKeys ();

// Result:
/*
array (
  'fa-glass' => '\f000',
  'fa-music' => '\f001',
  'fa-search' => '\f002',
  'fa-envelope-o' => '\f003',
  ...
*/ 

->getReadableNames()

 $ icons -> getReadableNames ();

// Result:
/*
array (
  'fa-glass' => 'Glass',
  'fa-music' => 'Music',
  'fa-search' => 'Search',
  ...
*/ 

->sortByName()

Attention: cela modifie le tableau d'origine. Vous pouvez le réinitialiser en utilisant la méthode ->reset() .

 $ icons -> sortByName ();

// Result:
/*
array (
  'fa-500px' => '\f26e',
  'fa-address-book' => '\f2b9',
  'fa-address-book-o' => '\f2ba',
  'fa-address-card' => '\f2bb',
  'fa-address-card-o' => '\f2bc',
  'fa-adjust' => '\f042',
  ...
*/ 

Services publics:

->total()

Renvoyez le nombre total d'icônes du tableau d'origine.

->getIconUnicode( $icon_class )

Obtenez la classe Unicode par icône.

Exemple:

 $ icons -> getIconUnicode ( ' fa-address-card ' );

// Result
// 'f2bb' 

->getIconName( $icon_class )

Obtenez le nom d'icône lisible par classe.

Exemple:

 $ icons -> getIconName ( ' fa-address-card ' );

// Result
// 'Address card' 

->getIcon( $icon_class )

Obtenez les détails d'une seule icône par classe.

Exemple:

 $ icons -> getIcon ( ' fa-address-card ' );

// Result
/*
array (
  'unicode' => '\f2bb',
  'name' => 'Address card',
  'class' => 'fa-address-card',
)
*/ 

->getIconByUnicode( $unicode )

Obtenez les détails d'une seule icône par Unicode.

Exemple:

 $ icons -> getIconByUnicode ( '\ f004 ' )

// Result
/*
array (
  'unicode' => '\f004',
  'name' => 'Heart',
  'class' => 'fa-heart',
)
*/ 

->reset()

Réinitialisez le tableau actuel à son état d'origine

Exemple:

 $ icons -> sortByName ();

// Array is sorted:
$ icons -> getArray ();

/*
array (
  'fa-500px' => '\f26e',
  'fa-address-book' => '\f2b9',
  'fa-address-book-o' => '\f2ba',
  'fa-address-card' => '\f2bb',
  ...
);
*/

// Reset it
$ icons -> reset ();

// This one will return the original array
$ icons -> getArray ();

// Result:
/*
array (
  'fa-glass' => '\f000',
  'fa-music' => '\f001',
  'fa-search' => '\f002',
  ...
);
*/