README

此存储库包含在 PHP 中使用 Font Awesome 所需的数据。

要求

Font Awesome 4.7.0
PHP 5.3+

许可

MIT - 详细信息

安装

使用 composer

composer require awps/font-awesome-php

手动

require_once 'src/load.php';

使用方法

该库包含2个主要用于公共的类

Awps\FontAwesome() - 使用 FA 图标的静态数组。（推荐）
Awps\FontAwesomeReader( $css_path ) - 从 font-awesome.css 文件生成数组。您必须定义此文件的路径。

创建实例

// 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();

接下来很简单。您可以通过这样做来获取图标数组。

$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()`

注意：这将修改原始数组。您可以使用 ->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',
  ...
*/

实用工具

`->total()`

从原始数组返回图标总数。

`->getIconUnicode( $icon_class )`

通过图标类获取 unicode。

示例

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

// Result
// '\f2bb'

`->getIconName( $icon_class )`

通过类获取可读的图标名称。

示例

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

// Result
// 'Address card'

`->getIcon( $icon_class )`

通过类获取单个图标的详细信息。

示例

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

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

`->getIconByUnicode( $unicode )`

通过 unicode 获取单个图标的详细信息。

示例

$icons->getIconByUnicode( '\\f004' )

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

`->reset()`

将当前数组重置为其原始状态

示例

$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',
  ...
);
*/

awps / font-awesome-php

维护者

详细信息