/**
 * vimotion API
 *
 * This software is a product of the
 *
 * vimotion GmbH
 * Am Wiesenbach 24
 * 74564 Crailsheim
 *
 * It can be distributed under the following license
 *
 * @license Creative Commons CC BY-NC-ND
 *
 * Changes to this software can be suggested and sent to vimotion to be
 * implemented by vimotion at our own discretion (vim-api@vi-motion.de)
 */

Die Api entweder aus einem verhandenen Repository nach
<ilias root>/Customizing/global/plugins/Services/EventHandling/EventHook
geclont werden oder andersweitig dorthin kopiert werden. Wie jedes andere
Plugin muss sie dann in der Pluginverwaltung installiert und aktiviert werden.

Konfiguration:
Um die Api nutzen zu können muss sie nicht weiter konfiguriert werden.
Die Plugin-Konfiguration beinhaltet Möglichkeiten anderen Plugins eine generelle
Api zur Verfügung zu stellen. Darüber hinaus kann hier ein Selbst-Test konfiguriert
und ausgeführt werden.

Um die Api aus einer Anwendung heraus nutzen zu können muss sie nur wie folgt
eingebunden werden:

    $file = "Customizing/global/plugins/"
    . "Services/EventHandling/EventHook/"
    . "Api/classes/class.ilApiUtil.php";

    require_once($file);

    $this->api = ilApiUtil::includeApi(
        $apiUserLogin,
        $apiUserPassword,
    );

Anschließend ist sie über $this->api ansprechbar und kann zum Beispiel über

    $this->api->user->getData($userId)

genutzt werden um die Daten eines Nutzers zu erhalten.

Die Funktionalität ist in den APIControl-Klassen unter classes/IliasAPIControl/API/
enthalten. Die Methoden dieser Klassen können über den vorderen Namensteil ohne APIControl
angesprochen werden. Der erste Buchstabe der Api-Komponente ist dabei klein.
So werden die Methoden aus UserAPIControl.php über $api->user->method() angesprochen und
die Methoden aus IliasLearningModuleAPIControl.php über $api->iliasLearningModule->method().

Die aktuelle (der installierten Version entsprechende) Dokumentation kann wie
folgt erzeugt werden

cd <ilias root>/Customizing/global/plugins/Services/EventHandling/EventHook/Api
Wenn phpdox noch nicht installiert:
sudo apt-get install phpdox phploc
sudo phpdox

Danach befindet sich die Dokumentation unter:
<ilias-root>/Customizing/global/plugins/Services/EventHandling/EventHook/Api/doc/api/html/index.xhtml

Die relevanten Informationen befinden sich unter dem Reiter Classes