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

@ -14,13 +14,15 @@ use ManiaControl\ManiaControl;
*/
class Database implements TimerListener {
/*
* Public Properties
* Public properties
*/
/** @var \mysqli $mysqli */
public $mysqli = null;
/** @var MigrationHelper $migrationHelper */
public $migrationHelper = null;
/*
* Private Properties
* Private properties
*/
private $maniaControl = null;
/** @var Config $config */
@ -181,6 +183,33 @@ class Database implements TimerListener {
return true;
}
/**
* Return the database config
*
* @return Config
*/
public function getConfig() {
return $this->config;
}
/**
* Return the migration helper
*
* @return MigrationHelper
*/
public function getMigrationHelper() {
return $this->migrationHelper;
}
/**
* Return the mysqli instance
*
* @return \mysqli
*/
public function getMysqli() {
return $this->mysqli;
}
/**
* Check whether the Database Connection is still open
*/

View File

@ -15,12 +15,12 @@ use ManiaControl\Utils\ClassUtil;
*/
class MigrationHelper {
/*
* Private Properties
* Private properties
*/
private $maniaControl = null;
/**
* Construct Migration Helper
* Construct a new migration helper instance
*
* @param ManiaControl $maniaControl
*/