README

安装

composer require rolfisub/noun-project-php-client

使用

将一个NounProject\Request对象传递给NounProject\Client，以从API获取数据。您将返回一个MattyRad\Support\Result对象。

示例

use MattyRad\NounProject;

$api = new NounProject\Client($key = 'abc123', $secret= 'xxxx');

$result = $api->send(new NounProject\Request\Icons($term = 'feather', $public_domain = true));

if (! $result->isSuccess()) {
    throw new \Exception($result->getReason());
}

$icons = $result->getIcons();

API和请求类型

集合

返回单个集合（通过集合ID或缩略名）

$result = $api->send(new NounProject\Request\Collection($collection_id_or_slug = 123));

$collection = $result->getCollection();

返回与集合关联的图标列表（通过集合ID或缩略名）

$result = $api->send(new NounProject\Request\IconsInCollection(
    $collection_id_or_slug = 123,
    $offset = 1,
    $page = 2,
    $limit = 3
));

$icons = $result->getIcons();

集合

返回所有集合的列表

$result = $api->send(new NounProject\Request\Collections($offset = 2, $page = 3, $limit = 1000));

$collections = $result->getCollections();

图标

返回单个图标

$result = $api->send(new NounProject\Request\Icon($icon_id_or_term = 123));

$icon = $result->getIcon();

图标

返回图标列表

$result = $api->send(new NounProject\Request\Icons(
    $icon_id_or_term = 'feather'
    $limit_to_public_domain = true;
    $offset = 2;
    $page = 3;
    $limit = 4;
));

$icon = $result->getIcons();

返回最近上传的图标列表

$result = $api->send(new NounProject\Request\RecentIcons);

$icon = $result->getIcons();

使用

返回当前oauth使用情况和限制

$result = $api->send(new NounProject\Request\Usage);

$usage = $result->getUsage();
$limits = $result->getLimits();

发布

通知API已发布的图标ID

$result = $api->send(new NounProject\Request\Publish("1,2");

$published = $result->getPublished();

if($published["result"] === "success") {
    echo "Yay!";
}

用户

待办事项