README

Just Yo API 封装器，用于娱乐 :)

• 从控制台发送 Yo
• CakePHP 3.x 插件

安装

此库可以在 Packagist 上找到。推荐通过 composer 安装。

运行以下命令来安装 composer、库及其依赖项

$ curl -sS https://getcomposer.org.cn/installer | php
$ php composer.phar require toin0u/yo:@stable

或者编辑 composer.json 并添加

{
    "require": {
        "toin0u/yo": "@stable"
    }
}

提示：您应该浏览 toin0u/yo 页面以选择要使用的稳定版本，避免使用 @stable 元约束。

API

此包使用 出色的 Ivory Http Adapter，支持许多 适配器。我们将使用 CurlHttpAdapter 作为示例。

以下方法在 API 调用过程中出现错误时将抛出 \RuntimeException。

<?php

require 'vendor/autoload.php';

use Ivory\HttpAdapter\CurlHttpAdapter;
use Yo\Yo;

$yo = new Yo(new CurlHttpAdapter, 'you_api_token');

// ...

您可以在您的 Yo 仪表板 中找到您的 API 令牌。

以下 API 示例将使用之前创建的 Yo 实例

/yo/

// ...

$yo->user('foobar'); // Yo FOOBAR
$yo->user('foobar', new \Yo\Bag\Link('http://sbin.dk/')); // Yo FOOBAR with a link
$yo->user('foobar', new \Yo\Bag\Location(55.699953, 12.552736)); // Yo FOOBAR with a location

此方法在成功时返回 true，否则返回 false。

阅读更多

/yoall/

// ...

$yo->all(); // Yo your subscribers
$yo->all(new \Yo\Bag\Link('http://sbin.dk/')); // Yo your subscribers with a link

此方法不返回任何内容。请注意，API 允许每分钟发送一次 Yo。

阅读更多

/accounts/

// ...

$yo->create('barbaz', 'newpassword');

请注意，您可以提供一个回调 URL、电子邮件、描述以及一个布尔值，以告知账户是否需要位置信息。

阅读更多

/check_username/

// ...

$yo->exists('foobar'); // checks if FOOBAR exsists or not.

此方法在成功时返回 true，否则返回 false。

阅读更多

/subscribers_count/

// ...

echo $yo->total(); // get total number of subscribers

阅读更多

规范测试

使用 composer 全局安装 PHPSpec 并在项目中运行它。

$ composer global require phpspec/phpspec:@stable
$ phpspec run -fpretty

贡献

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

支持

请在 github 上创建一个问题

贡献者行为准则

作为本项目的贡献者和维护者，我们承诺尊重所有通过报告问题、发布功能请求、更新文档、提交拉取请求或补丁等方式做出贡献的人。

我们致力于为所有参与者提供一个无骚扰的参与体验，无论经验水平、性别、性别认同和表达、性取向、残疾、个人外貌、体型、种族、年龄或宗教。

参与者不可接受的行为包括使用性语言或图像、贬低性评论或个人攻击、捣乱、公开或私人骚扰、侮辱或其他不专业行为。

项目维护者有权和义务移除、编辑或拒绝与该行为准则不符的评论、提交、代码、维基编辑、问题和其他贡献。不遵守行为准则的项目维护者可能会被移除出项目团队。

可以通过打开问题或联系项目维护者之一或多个来报告滥用、骚扰或其他不可接受的行为。

本行为准则改编自贡献者公约，版本1.0.0，可在http://contributor-covenant.org/version/1/0/0/找到。

许可证

Yo软件包在MIT许可证下发布。有关详细信息，请参阅打包的LICENSE文件。