sitepoint / the86-php

PHP client for “The 86” discussion API.

the86-php

PHP client library for “The 86” conversation API server.

Uses:

• Guzzle for HTTP transport, JSON decoding etc.
• PHPUnit for testing.
• Composer for dependency management.

Usage

<?php

// Get a configured client.
$client = The86\The86Client::factory(array(
  'domain' => 'the86.example.org',
  'username' => 'your-group-username',
  'password' => 'your-group-password',
));

// List all conversations for a group.
$conversations = $client->getCommand('ListConversations', array(
  'group' => 'example',
))->execute();

// List all recent conversations/posts for a group.
$conversations = $client->getCommand('ListConversations', array(
  'group' => 'example',
  'parameters' => array(
    'posts_since' => '2012-08-08T03:26:52Z',
  ),
))->execute();

// Create a User.
$user = $client->getCommand('CreateUser', array(
  'attributes' => array(
    'name' => 'John Citizen',
  ),
))->execute();
var_dump($user->access_tokens[0]->token); // Keep it secret. Keep it safe.

// Show a User.
$user = $client->getCommand('ShowUser', array('id' => $user->id))->execute();

// Create a Conversation.
$conversation = $client->getCommand('CreateConversation', array(
  'group' => 'example',
  'oauth_token' => 'usersoauthtoken',
  'attributes' => array(
    'content' => 'Hello world!',
  ),
))->execute();
$post = $conversation->posts[0];
var_dump($post->content_html); // HTML, auto-linkified, etc.

// Create a Post.
$post = $client->getCommand('CreatePost', array(
  'group' => 'example',
  'conversation' => 123,
  'oauth_token' => 'usersoauthtoken',
  'attributes' => array(
    'content' => 'Hello world!',
  ),
))->execute();
var_dump($post->content_html); // HTML, auto-linkified, etc.

Development & Testing

You'll need Composer. You can grab a local copy quickly like this:

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

Use composer to install the dependencies:

php composer.phar install --dev

If you don't want to install PHPUnit system-wide, you can clone it to a git-ignored subdirectory of this project (installer requires Ruby 1.9+):

./tests/install.rb

… and run the tests using this wrapper which configures the include paths:

./tests/run.php

Licence

(c) SitePoint, 2012, MIT license.