Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.12 KB

README.md

File metadata and controls

34 lines (23 loc) · 1.12 KB
Raw

BadgeUp PHP Client

Build Status

You may also be interested in our WordPress plugin which uses this client.

Example Use

$key = '<API Key>';
$bup = new BadgeUp\Client($key);

$allAchievements = $bup->getAchievements()->wait();
var_dump($allAchievements); // prints the list of achievements

API

getAchievement(string $id)

Retrieves an achievement by ID.

getAchievements()

Retrieves an array of achievements.

getEarnedAchievements(string $subject = null, string $achievementId = null)

Retrieves a list of earned achievements.

createEvent(string $subject, string $key, array $modifier = ['@inc' => 1], $showIncomplete = null)

Creates a single event, returning the event and earned achievement progress records for any achievement affected.

Running Unit Tests

Unit tests are written for PHPUnit

  1. Install and Configure PHPUnit (https://phpunit.de/getting-started.html)
  2. Run 'phpunit' from the project's root directory