SourceAPI

Raidplaner PHP API

General usage

The Raidplaner PHP Api can be used by including "lib/private/api.php" into your source.
It also allows writing plugins that react on raid events such as create, modify and delete. These plugins must contain a class derived from the "Plugin" interface contained in "lib/private/plugin.class.php". Plugins must be placed in "lib/private/plugins" and follow a simple registration scheme to be loaded.

Authentication

In contrast to the remote API, no authentication is required. You have to use the API to generate tokens for the remote API though.

API functions

You will find additional documentation in the file "lib/private/api.php".

Functions

Function	Description
Api::getPrivateToken	Returns the private token and creates it if no token is present
Api::getPublicToken	Returns a public token for a given, normalized parameter set
Api::tryGeneratePublicToken	Generate a new public base token if necessary
Api::testPrivateToken	Check a private token for validity
Api::testPublicToken	Check a public token for a given, normalized parameter set for validity
Api::normalizeArgsLocation	Normalize a parameter array for location queries
Api::normalizeArgsUser	Normalize a parameter array for user queries
Api::normalizeArgsRaid	Normalize a parameter array for raid queries
Api::normalizeArgsStatistic	Normalize a parameter array for statistic queries
Api::queryLocation	Issue a location query with a given parameter set
Api::queryUser	Issue a user query with a given parameter set
Api::queryRaid	Issue a raid query with a given parameter set
Api::queryStatistic	Issue a attendance statistic query with a given parameter set

Public token example

$Parameters = Array(
    "raid"    => "10", // Query raid with id 10
    "attends" => true  // Include attendance information
);

$Normalized = Api::normalizeArgsRaid($Parameters);
$Key = Api::getPublicToken($Normalized);

// $Key is now valid for "apihub.php?query=raid&raid=10&attends=true"

Plugins

How to write

To write a plugin, create a new php file in "lib/private/plugins".
In that file, create a class and derive it from "Plugin".
Last but not least, register the name of your class to the PluginRegistry so it can be instantiated automatically when needed. Note that only classes derived from "Plugin" will be instantiated.

You can use the Api method Api::queryRaid to retrieve data from the raid passed to each of the plugin functions.

Functions

Function	Description
onRaidCreate	Gets called after a raid has been created
onRaidModify	Gets called after a raid has been updated by a raidlead or admin
onRaidRemove	Gets called before a raid is deleted

Example

<?php
    array_push(PluginRegistry::$Classes, "ExamplePlugin");

    class ExamplePlugin extends Plugin
    {
        public function onRaidCreate($aRaidId)
        {
            $RaidRequest = Api::queryRaid(Array(
                "raid" => strval($aRaidId)
            ));
            // ...
        }

        // ...
    }
?>