Class.jaiku.php

From rukapedia
Revision as of 14:31, 28 April 2007 by Peter (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

class.jaiku.php is an PHP5 class that allows for basic interaction with Jaiku. At present the useful functionality is limited to updating your Jaiku presence, and grabbing the current presence message and location for a given Jaiku user (you or someone else).

Jaiku's API is new and is expected to grow in richness; I'll try to evolve this class as this happens.

Source Code

You can browse the source code from a browser, or grab the latest version of the source code using Subversion at:

You can grab the latest version of the source code using Subversion at:

svn://svn.reinvented.net/Jaiku/JaikuPHP

or

http://svn.reinvented.net/Jaiku/JaikuPHP

Requirements

The only additional code required is XMLParser, required to parse the XML presence information returned by Jaiku. This requirement may eventually be eliminated.

Sample Usage

Your username and personal_key are required to use the API.

Your username is your regular Jaiku username.

Your personal_key can be obtained by first signing in to Jaiku and then visiting http://api.jaiku.com.

require_once("class.jaiku.php");
$j = new Jaiku("username","personal_key");
$j->UpdatePresence("Hey, I'm using class.jaiku.php!",'Berlin, Germany', 329);
$p = $j->GetPresence();
print_r($p);

This code should update your Jaiku presence, location and icon and then query Jaiku to retrieve this information and display it.

Known Issues

There's no error reporting at all, so if it fails, you'll never know.

Release Notes

2007-04-28 - v0.15

  • Updated completely to use the new Jaiku API (rather than the old "hack the Javascript badge) to set and retrieve presence. Any code that uses the old version need to be updated.

2006-01-19 - v0.13

  • Small bugfix: the cURL method used to request the presence message JavaScript changed from POST to GET. POST stopped working.

2006-12-24 - v0.12

  • The class now uses the burgeoning Jaiku API to send a presence update if you create the Jaiku object with a developer key (if you don't pass a key, the old school method is used).
  • References to jaikuname have been changed to screenname for consistency with the website terminology.
  • The GetJaikuSession function is now called automatically by UpdatePresence.

2006-12-24 - v0.11

  • Modified the GetPresence function so that it properly handles situations where the presence string parsed out of the JavaScript badge doesn't contain location information -- i.e. doesn't have "in..." at the end.

2006-12-23 - v0.10

  • Added basic "presence getting" functionality by adding the GetPresence() function. This uses the same approach as JaikuAdium to grab presence information via the JavaScript "badge" that's constructed for every Jaiku user.

2006-12-22 - v0.8

  • Incorporated a patch from Andy Smith to handle new Jaiku security features (have to retrieve and send back a value for '_nonce').