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

@ -16,12 +16,12 @@ use ManiaControl\ManiaControl;
*/
class Directory implements CallbackListener {
/**
* Private Properties
* Private properties
*/
private $maniaControl = null;
/**
* Create new Server Directory Object
* Create new server directory instance
*
* @param ManiaControl $maniaControl
*/
@ -75,6 +75,15 @@ class Directory implements CallbackListener {
return $this->getGameDataFolder() . '..' . DIRECTORY_SEPARATOR . 'Logs' . DIRECTORY_SEPARATOR;
}
/**
* Retrieve the Game Data Folder Path
*
* @return string
*/
public function getGameDataFolder() {
return $this->maniaControl->client->gameDataDirectory();
}
/**
* @return bool
*/
@ -90,13 +99,4 @@ class Directory implements CallbackListener {
public function getCacheFolder() {
return $this->getGameDataFolder() . '..' . DIRECTORY_SEPARATOR . 'CommonData' . DIRECTORY_SEPARATOR . 'Cache' . DIRECTORY_SEPARATOR;
}
/**
* Retrieve the Game Data Folder Path
*
* @return string
*/
public function getGameDataFolder() {
return $this->maniaControl->client->gameDataDirectory();
}
}