README

遍历FontAwesome中的图标或将它们作为数组获取。

等等，这到底是什么？

简单来说，这个类是为了让你遍历FontAwesome的图标，以便在需要选择自己图标界面的用户界面中构建。话虽如此，如果你有其他创造性的用途，也请随意使用！

这个类扩展了PHP的内置 ArrayIterator 类，并为FontAwesome本地副本中的每个图标返回一个 Icon 类。

要求

1. PHP 5.2+
2. FontAwesome（默认为4.0+创建，但可以配置为任何版本。）

安装

通过Composer

只需将以下内容添加到composer.json文件中的require部分：

"bca/fontawesomeiterator": "1.*"

然后执行 composer install 以拉取最新版本。

包详细信息可在https://packagist.org.cn/packages/bca/fontawesomeiterator找到。

通过Github

您可以从https://github.com/brodkinca/BCA-PHP-FontAwesomeIterator/releases下载特定版本，或访问主仓库https://github.com/brodkinca/BCA-PHP-FontAwesomeIterator以下载未发布代码或通过git拉取副本。

基本用法

1. 创建Iterator实例

use BCA\FontAwesomeIterator\Iterator as FontAwesomeIterator;

$icons = new FontAwesomeIterator('path/to/fontawesome.css');

2. 执行有用操作

foreach循环

foreach ($icons as $icon) {
    echo $icon->class; // Do Something Here
}

while循环

while ($icons->valid()) {
    $icon = $icons->current();
    echo $icon->class; // Do Something Here
    $icons->next();
}

高级用法

如果您正在使用仍然使用icon- CSS前缀的较旧版本的FontAwesome或带有非标准前缀的自定义构建的FontAweosme，则在实例化类时必须定义前缀。

老式icon前缀

需要 FontAwesome v3 及以下版本。

$icons = new FontAwesomeIterator('path/to/fontawesome.css', 'icon');

自定义前缀

$icons = new FontAwesomeIterator('path/to/fontawesome.css', 'my-custom-prefix');

注意：前缀应定义为不带任何额外连字符。例如（prefix）而不是（prefix-）。

示例实现

按名称创建图标选择列表

<select>
<?php
    foreach ($icons as $icon) {
        echo '<option value="'.$icon->class.'">'.$icon->name.'</option>';
    }
?>
</select>

通过正确的CSS，也可以在选择列表中显示FontAwesome图标。

图标类

Iterator返回的每个值都将是一个Icon类的实例。

每个Icon将具有当前属性

• class 图标的CSS类
• name 图标的格式化名称（例如，角（右））
• unicode 图标的Unicode表示

可以通过直接在Icon类上调用它们来访问属性（例如，$icon->name）。

版本控制

此库将根据语义版本控制指南进行维护。

版本号将采用以下格式

<major>.<minor>.<patch>

并按照以下指南构建

• 破坏向后兼容性会提升主要版本（并重置次要和补丁）
• 不破坏向后兼容性的新功能会提升次要版本（并重置补丁）
• 错误修复和其它更改会提升补丁版本

希望对升级有更细粒度控制的Composer用户应仅使用此require密钥限制安装到补丁更新：

"bca/fontawesomeiterator": "1.0.*"

有关SemVer的更多信息，请访问http://semver.org/。