ManuAdminMod Code Documentation

Methods
Properties

Klassenvorlage für eine API

Für die genaue Funktionsweise der API siehe Wiki

copyright	(c) Copyright 2008-2013 by ManuAdminMod (http://www.manuadminmod.de)
license	Creative Commons BY-NC-ND 3.0 (http://www.creativecommons.org/licenses/by-nc-nd/3.0/)
author	manu (manu@manuadminmod.de)
since	1.0
version	1.0

Methods

Erstellt die API mit einem Adapter, einem Converter und weist sie dem Core zu

__construct(\Daemon\Core\Core $Core, \Daemon\API\Adapter $Adapter, \Daemon\API\Converter $Converter)

Parameters

$Core

\Daemon\Core\Core

Der Core, auf den die API registriert wurde

$Adapter

\Daemon\API\Adapter

Der Adapter für die API

$Converter

\Daemon\API\Converter

Der Converter für die API

answerCommandAsError()

answerCommandAsError(\Daemon\API\Request $Request, string $errorstring, int $errorcode)

Parameters

$Request

\Daemon\API\Request

$errorstring

string

$errorcode

int

Exceptions

`\BadMethodCallException`

answerCommandAsSuccess()

answerCommandAsSuccess(\Daemon\API\Request $Request, mixed $answer)

Parameters

$Request

\Daemon\API\Request

$answer

mixed

Exceptions

`\BadMethodCallException`

Prüft, ob ein Command bereits registriert wurde

commandExists(string $command) : boolean

Parameters

$command

string

Returns

boolean

"Frame"-Ausführung: Handelt alle neuen API-Anfragen ab

doTick() : void

Sollte einmal pro Hauptschleifendurchlauf aufgerufen werden

Exceptions

`\Daemon\API\BadMethodCallException`

Liefert eine Liste aller registrierter Commands

getRegisteredCommands() : string[]

Returns

string[]Namen der Commands

Registriert eine neue API-Extension für ein oder mehrere Commands in der API

registerExtension(\Daemon\API\APIExtension $Extension) : void

Wirft eine InvalidArgumentException wenn die Registrierung fehlschlägt, z.B. weil ein Command bereits registriert ist.

Parameters

$Extension

\Daemon\API\APIExtension

Exceptions

`\InvalidArgumentException`

Properties

$Adapter : \Daemon\API\Adapter

$Converter : \Daemon\API\Converter

$Core : \Daemon\Core\Core

$Extensions : \Daemon\API\Extension[]

$extensionRegister : int[]

$waitingForAnswer : boolean