ManuAdminMod Code Documentation
Back to top  

Stellt einen Help-Command zur Verfügung, der die zur Verfügung stehenden Befehle ausgibt

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

Konstruktor

__construct(\Daemon\Core\Core $Core) 
Inherited

Wird automatisch im Core aufgerufen und soll deswegen nicht geändert werden können (final). Für Initialisationen soll die Funktion init() verwendet werden, sie wird noch im Konstruktor aufgerufen

inherited_from \Daemon\Core\Plugin::__construct()

Parameters

$Core

(non-PHPdoc)

executeAPICommand(\Daemon\API\APICommand $Command, \Daemon\User\User $User, \Daemon\API\Request $Request) : void

Muss eine der beiden Funktionen API::answerCommandAsError() oder API::anserCommandAsSuccess() aufrufen, je nach dem, ob die Ausführung fehlerhaft oder erfolgreich war

Wird keine der Funktionen aufgerufen, wird nach der Ausführung eine LogicException geworfen

see \Daemon\API\APIExtension::executeAPICommand()

Parameters

$Command

\Daemon\API\APICommand

Der Command der ausgeführt wurde

$User

\Daemon\User\User

Ausführender Benutzer

$Request

\Daemon\API\Request

Der ursprüngliche Request

(non-PHPdoc)

getAPICommands() : array

Wird von der API aufgerufen

see \Daemon\API\APIExtension::getAPICommands()

Returns

arrayDie Commands als String-Array in lowercase

(non-PHPdoc)

getDescription() : string
see \Daemon\Core\Plugin::getDescription()

Returns

string

(non-PHPdoc)

getName() : string
see \Daemon\Core\Plugin::getName()

Returns

string

(non-PHPdoc)

getVersion() : string

Gibt die komplette Version dieses Plugin als String zurück

see \Daemon\Core\Plugin::getVersion()

Returns

string

(non-PHPdoc)

isCompatible($modMajor, $modMinor) 
see \Daemon\Core\Plugin::isCompatible()

Parameters

$modMajor

$modMinor

(non-PHPdoc)

newVersionAvailable() : boolean
see \Daemon\Core\Plugin::newVersionAvailable()

Returns

boolean

API() 

API() 
Inherited
inherited_from \Daemon\Core\Plugin::API()

Core() 

Core() 
Inherited
inherited_from \Daemon\Core\Plugin::Core()

Bietet Zugriff auf die MySQL-Schnittstelle

MySQL() : \Daemon\Core\MySQL
Inherited
inherited_from \Daemon\Core\Plugin::MySQL()

Returns

\Daemon\Core\MySQL

Output() 

Output() 
Inherited
inherited_from \Daemon\Core\Plugin::Output()

Bietet Zugriff auf den Server, auf den das Plugin registriert wurde

Server() : \Daemon\Server\Server
Inherited
inherited_from \Daemon\Core\Plugin::Server()

Returns

\Daemon\Server\Server

Beitet Zugriff auf die Konfigurationsvariablen dieses Plugins

getConfig() : \Daemon\Lib\Config\Config_MySQL
Inherited
inherited_from \Daemon\Core\Plugin::getConfig()

Returns

\Daemon\Lib\Config\Config_MySQL

(non-PHPdoc)

init() : void

Diese Funktion wird im Konstrutor automatisch aufgerufen

see \Daemon\Core\Plugin::init()

 Properties

 

$Core : \Daemon\Core\Core
Inherited
inherited_from \Daemon\Core\Plugin::$$Core
 

$config : \Daemon\Lib\Config\Config_MySQL
Inherited
inherited_from \Daemon\Core\Plugin::$$config