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

@ -32,12 +32,12 @@ class InstallMenu implements ConfiguratorMenu, ManialinkPageAnswerListener {
const ACTION_REFRESH_LIST = 'PluginInstallMenu.RefreshList';
/*
* Private Properties
* Private properties
*/
private $maniaControl = null;
/**
* Create a new Plugin Install Menu
* Create a new plugin install menu instance
*
* @param ManiaControl $maniaControl
*/

View File

@ -62,7 +62,7 @@ interface Plugin {
/**
* Load the plugin
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param ManiaControl $maniaControl
* @return bool
*/
public function load(ManiaControl $maniaControl);

View File

@ -24,10 +24,12 @@ class PluginManager {
const CB_PLUGIN_UNLOADED = 'PluginManager.PluginUnloaded';
/*
* Private Properties
* Private properties
*/
private $maniaControl = null;
/** @var PluginMenu $pluginMenu */
private $pluginMenu = null;
/** @var InstallMenu $pluginInstallMenu */
private $pluginInstallMenu = null;
/** @var Plugin[] $activePlugins */
private $activePlugins = array();
@ -35,9 +37,9 @@ class PluginManager {
private $pluginClasses = array();
/**
* Construct plugin manager
* Construct a new plugin manager instance
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param ManiaControl $maniaControl
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
@ -459,7 +461,6 @@ class PluginManager {
*/
public function fetchPluginList(callable $function) {
$url = ManiaControl::URL_WEBSERVICE . 'plugins';
$this->maniaControl->fileReader->loadFile($url, function ($dataJson, $error) use (&$function) {
$data = json_decode($dataJson);
call_user_func($function, $data, $error);

View File

@ -46,12 +46,12 @@ class PluginMenu implements CallbackListener, ConfiguratorMenu, ManialinkPageAns
const CACHE_SETTING_CLASS = 'PluginMenuCache.SettingClass';
/*
* Private Properties
* Private properties
*/
private $maniaControl = null;
/**
* Create a new Plugin Menu Instance
* Create a new plugin menu instance
*
* @param ManiaControl $maniaControl
*/
@ -71,7 +71,7 @@ class PluginMenu implements CallbackListener, ConfiguratorMenu, ManialinkPageAns
}
/**
* Return back to the Plugins
* Return back to the plugins overview page
*
* @param array $callback
* @param Player $player