README

PHP实现的Typekit客户端

安装

通过Composer

composer require webeau/typekit

使用方法

使用您的开发者API令牌初始化客户端。您可以在此处获取API令牌。所有方法调用都返回调用Typekit API的返回值的JSON表示。

$typekit = new \Webeau\Typekit\TypekitClient('<API token>');

获取所有套件

要获取所有套件，请使用以下命令

$typekit->getKits();

获取套件

要获取特定套件的信息，请输入套件ID作为参数

$typekit->getKit($kitId);

创建套件

要创建新的套件，请使用方法 createKit($name, $domains, $families, $optimize=null)。字段 Name 和 domains 是必需的，但 families 和 optimize 字段不是必需的。

参数格式如下

$name: 字符串
$domains: 格式为 ['localhost', '*.domain.com', '127.0.0.1'] 的PHP字符串数组
$families: 包含以下键 => 值的数组集合
- 'id' : 字体家族ID (字符串)
- (可选) 'variations' : 以逗号分隔的变体 (字符串)。
**$optimize: 布尔值

家族格式的一个例子是： $families = [['id' => 'ftnk', 'variations' => 'n3,n4'], ['id' => 'pcpv', 'variations' => 'n4']] 在这种情况下，我们将创建一个包含字体家族Futura-PT和Droid Sans的套件，字体变体分别为正常3（$font-weight:300，不倾斜或加粗），正常4和正常4。

示例用法

$name = 'example typekit kit';

$domains = ['localhost', '*.domain.com'];

$families = [['id' => 'ftnk', 'variations' => 'n3,n4'], ['id' => 'pcpv', 'variations' => 'n4']];

$typekit->createKit($name, $domains, $families);

更新套件

要创建新的套件，请使用方法 updateKit($kitId, $name='', $domains=[], $families=[], $optimize=null)。唯一必需的字段是 $kitId 和 name。字段 domains 和 families 不是必需的。

字段格式与 createKit 相同。

示例用法

$name = 'Example';

$typekit->updateKit($kitId, $name);

删除套件

要删除套件，请使用方法 removeKit($kitId)。必需的字段是 $kitId。

$typekit->removeKit($kitId);

发布套件

要发布套件，请使用方法 publishKit($kitId)。必需的字段是 $kitId。

$typekit->publishKit($kitId);

获取字体家族

要检索有关给定字体家族的信息，请使用方法 getFontFamily($font)。参数 font 是一个字符串，可以是Typekit字体ID或Typekit中命名的字体的slug。此方法不会对输入进行slugify，因此请确保在输入参数之前对其进行slugify。

$typekit->getFontFamily('<font_id>');

获取字体变体

要检索给定字体的所有可能变体，请使用方法 getFontVariations($font)。参数与 getFontFamily($font) 相同。此方法返回一个包含字体所有可能变体的PHP数组。

$variations = $typekit->getFontVariations('futura-pt'); # using font slug

or

$variations = $typekit->getFontVariations('ftnk'); # using font id

OUTPUT:
['n3', 'i3', 'n4', 'i4', 'n5', 'i5', 'n7', 'i7', 'n8', 'i8']

将字体添加到套件

要将字体添加到套件，请使用方法 kitAddFont($kitId, $font, $variations)。此方法的参数格式与上述相同，但变体应为数组。不返回任何内容。

$typekit->kitAddFont('$kitId', 'futura-pt', [n3,n5,n7]);

从套件中删除字体

要将字体添加到套件，请使用方法 kitRemoveFont($kitId, $font)。此方法的参数格式与上述相同，但变体应为数组。不返回任何内容。

$typekit->kitRemoveFont($kitId, 'futura-pt');

其他方法

optimizeKit($kitId, $optimize) - 为套件设置/取消设置优化性能

getKitValues($kitId) - 以格式为：[$name, $domains, $families] 的数组检索套件值

getKitFonts($kitId) - 在给定套件中检索字体ID的数组

kitContainsFont($kitId, $font) - 检查字体是否存在于套件中。

测试

TYPEKIT_TOKEN=<API token> composer test

贡献

有关详细信息，请参阅CONTRIBUTING。

安全性

如果您发现任何与安全相关的问题，请使用联系表单而不是使用问题跟踪器。

致谢

感谢

许可证

MIT 许可证（MIT）。更多信息请参阅许可证文件。

webeau / typekit

维护者

详细信息