websoftwares/yo

Yo API PHP Package

Yo (v0.2.1)

This package lets u perform actions on the Yo Developers API., _(*1)

, _(*2)

It has no extra dependencies but it can play nice with other curl or http clients by creating an adapter just implement the YoClientInterface and inject it into the Yo class., _(*3)

Documentation

We encourage you to read the documentation carefully before proceeding., _(*4)

Installing via Composer (recommended)

Install composer in your project:, _(*5)

curl -s http://getcomposer.org/installer | php

Create a composer.json file in your project root:, _(*6)

{
    "require": {
        "websoftwares/yo": "~0.2"
    }
}

Install via composer, _(*7)

php composer.phar install

Usage

Basic usage of the Yo class., _(*8)

use Websoftwares\YoClient, Websoftwares\Yo;

// apiKey
$apiKey = 'obtain-valid-api-key-from-yo';

// Instantiate class
$Yo = new Yo(new YoClient($apiKey));

// Perform method
$yo->all();

all();

This will yo all your subscribers, _(*9)

$yo->all();

(optional) provide a link argument This will yo all your subscribers with a link, _(*10)

$yo->all("yo.websoftwar.es");

user();

This will yo an individual user, _(*11)

$yo->user("BORIS010");

(optional) provide a link argument This will yo an individual user with a link, _(*12)

$yo->user("BORIS010", "yo.websoftwar.es");

subscribersCount();

Returns the amount of subscribers, _(*13)

$yo->subscribersCount();

Testing

In the tests folder u can find several tests., _(*14)

Goals

• Unit testing 100%
• PSR compliance
• Implement new methods from Yo API when they are available

License

The MIT License (MIT)., _(*15)