various phpdoc improvements and additions

added some getter methods for properties
This commit is contained in:
Steffen Schröder
2014-07-25 16:28:47 +02:00
parent 29f89ec15f
commit 002b537b47
38 changed files with 381 additions and 188 deletions

View File

@ -44,17 +44,20 @@ class Configurator implements CallbackListener, CommandListener, ManialinkPageAn
const MENU_NAME = 'Configurator';
/*
* Private Properties
* Private properties
*/
private $maniaControl = null;
/** @var ScriptSettings $scriptSettings */
private $scriptSettings = null;
/** @var ServerOptionsMenu $serverOptionsMenu */
private $serverOptionsMenu = null;
/** @var ManiaControlSettings $maniaControlSettings */
private $maniaControlSettings = null;
/** @var ConfiguratorMenu[] $menus */
private $menus = array();
/**
* Create a new Configurator
* Create a new configurator instance
*
* @param ManiaControl $maniaControl
*/

View File

@ -38,12 +38,12 @@ class ManiaControlSettings implements ConfiguratorMenu, CallbackListener {
const CACHE_CLASS_OPENED = 'ClassOpened';
/*
* Private Properties
* Private properties
*/
private $maniaControl = null;
/**
* Create a new Script Settings Instance
* Create a new ManiaControl Settings Instance
*
* @param ManiaControl $maniaControl
*/

View File

@ -37,12 +37,12 @@ class ScriptSettings implements ConfiguratorMenu, CallbackListener {
const SETTING_PERMISSION_CHANGE_SCRIPT_SETTINGS = 'Change Script-Settings';
/*
* Private Properties
* Private properties
*/
private $maniaControl = null;
/**
* Create a new Script Settings Instance
* Construct a new script settings instance
*
* @param ManiaControl $maniaControl
*/
@ -50,17 +50,17 @@ class ScriptSettings implements ConfiguratorMenu, CallbackListener {
$this->maniaControl = $maniaControl;
$this->initTables();
// Register for callbacks
// Callbacks
$this->maniaControl->callbackManager->registerCallbackListener(Callbacks::ONINIT, $this, 'onInit');
$this->maniaControl->callbackManager->registerCallbackListener(Callbacks::BEGINMAP, $this, 'onBeginMap');
$this->maniaControl->settingManager->initSetting($this, self::SETTING_LOAD_DEFAULT_SETTINGS_MAP_BEGIN, true);
$this->maniaControl->settingManager->initSetting($this, self::SETTING_LOAD_DEFAULT_SETTINGS_MAP_BEGIN, false);
//Permission for Change Script-Settings
// Permissions
$this->maniaControl->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_CHANGE_SCRIPT_SETTINGS, AuthenticationManager::AUTH_LEVEL_ADMIN);
}
/**
* Create all necessary Database Tables
* Create all necessary database tables
*
* @return boolean
*/