diff --git a/agents/IntermediateAgent.inc b/agents/IntermediateAgent.inc index 7139653d..fa14a5be 100644 --- a/agents/IntermediateAgent.inc +++ b/agents/IntermediateAgent.inc @@ -27,7 +27,8 @@ /** * Get the layout if it was explicitly defined. * - * @return string Layout of the IntermediateAgent + * @param string $agentName Agent name + * @return string Layout of the IntermediateAgent */ public static function getLayout($agentName) { diff --git a/agents/ToplevelAgent.inc b/agents/ToplevelAgent.inc index 9d6d6f8a..d8b21da5 100644 --- a/agents/ToplevelAgent.inc +++ b/agents/ToplevelAgent.inc @@ -74,7 +74,7 @@ * @throws ControllerNotValidException * @throws ControllerNotFoundException * @param Request $request Current request - * @param Response $respone Current response + * @param Response $response Current response * @param Logger $log Log-system */ protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null) diff --git a/agents/bottomlevel/MailreceiverAgent.inc b/agents/bottomlevel/MailreceiverAgent.inc index aab709df..f6cf4afd 100644 --- a/agents/bottomlevel/MailreceiverAgent.inc +++ b/agents/bottomlevel/MailreceiverAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/bottomlevel/MenuAgent.inc b/agents/bottomlevel/MenuAgent.inc index 49512791..cf1bbf18 100644 --- a/agents/bottomlevel/MenuAgent.inc +++ b/agents/bottomlevel/MenuAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/bottomlevel/QuestgroupshierarchypathAgent.inc b/agents/bottomlevel/QuestgroupshierarchypathAgent.inc index a2cb8086..130f5e7c 100644 --- a/agents/bottomlevel/QuestgroupshierarchypathAgent.inc +++ b/agents/bottomlevel/QuestgroupshierarchypathAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/bottomlevel/SeminarybarAgent.inc b/agents/bottomlevel/SeminarybarAgent.inc index 10315ab5..bc2eb038 100644 --- a/agents/bottomlevel/SeminarybarAgent.inc +++ b/agents/bottomlevel/SeminarybarAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/bottomlevel/SeminarymenuAgent.inc b/agents/bottomlevel/SeminarymenuAgent.inc index 375eab1e..ad43aebb 100644 --- a/agents/bottomlevel/SeminarymenuAgent.inc +++ b/agents/bottomlevel/SeminarymenuAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/bottomlevel/UserrolesAgent.inc b/agents/bottomlevel/UserrolesAgent.inc index b6d6e65b..26b2921f 100644 --- a/agents/bottomlevel/UserrolesAgent.inc +++ b/agents/bottomlevel/UserrolesAgent.inc @@ -25,6 +25,9 @@ /** * Action: user. + * + * @param Request $request Current request + * @param Response $response Current response */ public function user(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/AchievementsAgent.inc b/agents/intermediate/AchievementsAgent.inc index e6b965f9..a8609b1e 100644 --- a/agents/intermediate/AchievementsAgent.inc +++ b/agents/intermediate/AchievementsAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/CharactergroupsAgent.inc b/agents/intermediate/CharactergroupsAgent.inc index 77ac5f5a..284aa02d 100644 --- a/agents/intermediate/CharactergroupsAgent.inc +++ b/agents/intermediate/CharactergroupsAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/CharactergroupsquestsAgent.inc b/agents/intermediate/CharactergroupsquestsAgent.inc index bfc87de1..488f1c74 100644 --- a/agents/intermediate/CharactergroupsquestsAgent.inc +++ b/agents/intermediate/CharactergroupsquestsAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/CharactersAgent.inc b/agents/intermediate/CharactersAgent.inc index 25102198..d659b3f2 100644 --- a/agents/intermediate/CharactersAgent.inc +++ b/agents/intermediate/CharactersAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { @@ -33,6 +36,9 @@ /** * Action: character. + * + * @param Request $request Current request + * @param Response $response Current response */ public function character(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/CharactertypesAgent.inc b/agents/intermediate/CharactertypesAgent.inc index 1a3c8b65..19f60a11 100644 --- a/agents/intermediate/CharactertypesAgent.inc +++ b/agents/intermediate/CharactertypesAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/ErrorAgent.inc b/agents/intermediate/ErrorAgent.inc index 85bb6f95..32a973b2 100644 --- a/agents/intermediate/ErrorAgent.inc +++ b/agents/intermediate/ErrorAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/IntroductionAgent.inc b/agents/intermediate/IntroductionAgent.inc index 3a06fdff..aed14562 100644 --- a/agents/intermediate/IntroductionAgent.inc +++ b/agents/intermediate/IntroductionAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/LibraryAgent.inc b/agents/intermediate/LibraryAgent.inc index aedc890a..184969fa 100644 --- a/agents/intermediate/LibraryAgent.inc +++ b/agents/intermediate/LibraryAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/MailAgent.inc b/agents/intermediate/MailAgent.inc index 7bb5eef5..fe53ac3e 100644 --- a/agents/intermediate/MailAgent.inc +++ b/agents/intermediate/MailAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/MediaAgent.inc b/agents/intermediate/MediaAgent.inc index c3fd35ae..c0555e55 100644 --- a/agents/intermediate/MediaAgent.inc +++ b/agents/intermediate/MediaAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/QuestgroupsAgent.inc b/agents/intermediate/QuestgroupsAgent.inc index b7bd3a54..ff4144e3 100644 --- a/agents/intermediate/QuestgroupsAgent.inc +++ b/agents/intermediate/QuestgroupsAgent.inc @@ -25,6 +25,9 @@ /** * Action: questgroup. + * + * @param Request $request Current request + * @param Response $response Current response */ public function questgroup(\nre\core\Request $request, \nre\core\Response $response) { @@ -34,6 +37,9 @@ /** * Action: edit. + * + * @param Request $request Current request + * @param Response $response Current response */ public function edit(\nre\core\Request $request, \nre\core\Response $response) { @@ -43,6 +49,9 @@ /** * Action: edittexts. + * + * @param Request $request Current request + * @param Response $response Current response */ public function edittexts(\nre\core\Request $request, \nre\core\Response $response) { @@ -52,6 +61,9 @@ /** * Action: delete. + * + * @param Request $request Current request + * @param Response $response Current response */ public function delete(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/QuestsAgent.inc b/agents/intermediate/QuestsAgent.inc index c43dcac4..9f3cfe15 100644 --- a/agents/intermediate/QuestsAgent.inc +++ b/agents/intermediate/QuestsAgent.inc @@ -25,6 +25,9 @@ /** * Action: quest. + * + * @param Request $request Current request + * @param Response $response Current response */ public function quest(\nre\core\Request $request, \nre\core\Response $response) { @@ -34,6 +37,9 @@ /** * Action: submissions. + * + * @param Request $request Current request + * @param Response $response Current response */ public function submissions(\nre\core\Request $request, \nre\core\Response $response) { @@ -43,6 +49,9 @@ /** * Action: submission. + * + * @param Request $request Current request + * @param Response $response Current response */ public function submission(\nre\core\Request $request, \nre\core\Response $response) { @@ -52,6 +61,9 @@ /** * Action: create. + * + * @param Request $request Current request + * @param Response $response Current response */ public function create(\nre\core\Request $request, \nre\core\Response $response) { @@ -61,6 +73,9 @@ /** * Action: edit. + * + * @param Request $request Current request + * @param Response $response Current response */ public function edit(\nre\core\Request $request, \nre\core\Response $response) { @@ -70,6 +85,9 @@ /** * Action: edittask. + * + * @param Request $request Current request + * @param Response $response Current response */ public function edittask(\nre\core\Request $request, \nre\core\Response $response) { @@ -79,6 +97,9 @@ /** * Action: edittexts. + * + * @param Request $request Current request + * @param Response $response Current response */ public function edittexts(\nre\core\Request $request, \nre\core\Response $response) { @@ -88,6 +109,9 @@ /** * Action: delete. + * + * @param Request $request Current request + * @param Response $response Current response */ public function delete(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/SeminariesAgent.inc b/agents/intermediate/SeminariesAgent.inc index 53f08124..5a7c8f83 100644 --- a/agents/intermediate/SeminariesAgent.inc +++ b/agents/intermediate/SeminariesAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/UploadsAgent.inc b/agents/intermediate/UploadsAgent.inc index 457b6a49..9419965a 100644 --- a/agents/intermediate/UploadsAgent.inc +++ b/agents/intermediate/UploadsAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/UsersAgent.inc b/agents/intermediate/UsersAgent.inc index a9094490..0a1daca8 100644 --- a/agents/intermediate/UsersAgent.inc +++ b/agents/intermediate/UsersAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { @@ -33,6 +36,9 @@ /** * Action: user. + * + * @param Request $request Current request + * @param Response $response Current response */ public function user(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/intermediate/XplevelsAgent.inc b/agents/intermediate/XplevelsAgent.inc index 087cbade..a6713d80 100644 --- a/agents/intermediate/XplevelsAgent.inc +++ b/agents/intermediate/XplevelsAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/toplevel/AjaxAgent.inc b/agents/toplevel/AjaxAgent.inc index 7c10c112..37f58433 100644 --- a/agents/toplevel/AjaxAgent.inc +++ b/agents/toplevel/AjaxAgent.inc @@ -23,6 +23,13 @@ + /** + * Construct a new AjaxAgent. + * + * @param Request $request Current request + * @param Response $response Current response + * @param Logger $log Logger instance + */ protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null) { parent::__construct($request, $response, $log); @@ -34,6 +41,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { @@ -42,6 +52,11 @@ + /** + * Set requested language. + * + * @param Request $request Current request + */ private function setLanguage(\nre\core\Request $request) { // Set domain diff --git a/agents/toplevel/BinaryAgent.inc b/agents/toplevel/BinaryAgent.inc index 225828e3..728416e2 100644 --- a/agents/toplevel/BinaryAgent.inc +++ b/agents/toplevel/BinaryAgent.inc @@ -23,6 +23,13 @@ + /** + * Construct a new BinaryAgent. + * + * @param Request $request Current request + * @param Response $response Current response + * @param Logger $log Logger instance + */ protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null) { parent::__construct($request, $response, $log); @@ -31,6 +38,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/toplevel/FaultAgent.inc b/agents/toplevel/FaultAgent.inc index 1ceb682e..2d6fbc7f 100644 --- a/agents/toplevel/FaultAgent.inc +++ b/agents/toplevel/FaultAgent.inc @@ -25,6 +25,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/toplevel/HtmlAgent.inc b/agents/toplevel/HtmlAgent.inc index 86b65f3f..a160ea09 100644 --- a/agents/toplevel/HtmlAgent.inc +++ b/agents/toplevel/HtmlAgent.inc @@ -23,6 +23,13 @@ + /** + * Construct a new HtmlAgent. + * + * @param Request $request Current request + * @param Response $response Current response + * @param Logger $log Logger instance + */ protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null) { parent::__construct($request, $response, $log); @@ -34,6 +41,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { @@ -47,6 +57,11 @@ + /** + * Set requested language. + * + * @param Request $request Current request + */ private function setLanguage(\nre\core\Request $request) { // Set domain diff --git a/agents/toplevel/HtmlmailAgent.inc b/agents/toplevel/HtmlmailAgent.inc index 13e6c7a1..ad99c820 100644 --- a/agents/toplevel/HtmlmailAgent.inc +++ b/agents/toplevel/HtmlmailAgent.inc @@ -25,6 +25,10 @@ /** * Construct a new HtmlmailAgent. + * + * @param Request $request Current request + * @param Response $response Current response + * @param Logger $log Logger instance */ protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null) { @@ -34,6 +38,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/agents/toplevel/TextmailAgent.inc b/agents/toplevel/TextmailAgent.inc index b2b0fa90..66c58f30 100644 --- a/agents/toplevel/TextmailAgent.inc +++ b/agents/toplevel/TextmailAgent.inc @@ -25,6 +25,10 @@ /** * Construct a new TextmailAgent. + * + * @param Request $request Current request + * @param Response $response Current response + * @param Logger $log Logger instance */ protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null) { @@ -36,6 +40,9 @@ /** * Action: index. + * + * @param Request $request Current request + * @param Response $response Current response */ public function index(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/apis/WebApi.inc b/apis/WebApi.inc index 6851ee2d..e743b091 100644 --- a/apis/WebApi.inc +++ b/apis/WebApi.inc @@ -223,7 +223,7 @@ * Handle a error which cannot be handles by the system (and * HTTP 503). * - * $param Exception $exception Occurred exception + * @param Exception $exception Occurred exception */ private function errorService($exception) { diff --git a/app/Utils.inc b/app/Utils.inc index f8246340..322c10f4 100644 --- a/app/Utils.inc +++ b/app/Utils.inc @@ -83,11 +83,11 @@ * Send an e‑mail. * * @throws MailingException - * @param string $from Sender of mail * @param mixed $to One (string) or many (array) receivers - * @param string $subject Subject of mail - * @param string $message Message of mail + * @param string $messageAction Message Action * @param boolean $html Whether mail should be formatted as HTML or not + * @param array $params Parameters to pass + * @param Linker $linker Linker instance */ public static function sendMail($to, $messageAction, $html=false, $params=null, $linker=null) { diff --git a/app/agents/QuesttypeAgent.inc b/app/agents/QuesttypeAgent.inc index 36232f6f..ed66d15e 100644 --- a/app/agents/QuesttypeAgent.inc +++ b/app/agents/QuesttypeAgent.inc @@ -78,7 +78,7 @@ * @throws QuesttypeControllerNotFoundException * @param string $questtypeName Name of the QuesttypeAgent to instantiate * @param Request $request Current request - * @param Response $respone Current respone + * @param Response $response Current respone * @param Logger $log Log-system */ public static function factory($questtypeName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null) @@ -190,7 +190,7 @@ * @throws QuesttypeControllerNotValidException * @throws QuesttypeControllerNotFoundException * @param Request $request Current request - * @param Response $respone Current response + * @param Response $response Current response * @param Logger $log Log-system */ protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null) diff --git a/app/agents/ToplevelAgent.inc b/app/agents/ToplevelAgent.inc index dc2810d0..722a7a63 100644 --- a/app/agents/ToplevelAgent.inc +++ b/app/agents/ToplevelAgent.inc @@ -23,6 +23,13 @@ + /** + * Construct a new ToplevlAgent + * + * @param Request $request Current request + * @param Response $response Current response + * @param Logger $log Logger instance + */ protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null) { parent::__construct($request, $response, $log); diff --git a/app/apis/MailApi.inc b/app/apis/MailApi.inc index 4d9238ec..a9ef68de 100644 --- a/app/apis/MailApi.inc +++ b/app/apis/MailApi.inc @@ -56,6 +56,8 @@ /** * Use a ToplevelAgent for HTML-mail + * + * @param bool $html Whether to use HTML or not */ public function setHTML($html=true) { @@ -80,6 +82,8 @@ /** * Set the Action for the message to render. + * + * @param string $messageAgent Agent to handle the message */ public function setMessage($messageAgent) { diff --git a/app/controllers/IntermediateController.inc b/app/controllers/IntermediateController.inc index e2f8c75d..bed0a4fb 100644 --- a/app/controllers/IntermediateController.inc +++ b/app/controllers/IntermediateController.inc @@ -154,6 +154,8 @@ * Check user permissions. * * @throws AccessDeniedException + * @param Request $request Current request + * @param Response $response Current response */ private function checkPermission(\nre\core\Request $request, \nre\core\Response $response) { diff --git a/app/controllers/QuesttypeController.inc b/app/controllers/QuesttypeController.inc index 7c428d9a..1f6beea7 100644 --- a/app/controllers/QuesttypeController.inc +++ b/app/controllers/QuesttypeController.inc @@ -151,6 +151,7 @@ * @param string $controllerName Name of the QuesttypeController to instantiate * @param string $layoutName Name of the current Layout * @param string $action Current Action + * @param Agent $agent Corresponding Agent */ public static function factory($controllerName, $layoutName, $action, $agent) { diff --git a/app/controllers/SeminaryController.inc b/app/controllers/SeminaryController.inc index cd647aad..2810dec3 100644 --- a/app/controllers/SeminaryController.inc +++ b/app/controllers/SeminaryController.inc @@ -126,6 +126,8 @@ * Check user permissions. * * @throws AccessDeniedException + * @param Request $request Current request + * @param Response $response Current response */ private function checkPermission(\nre\core\Request $request, \nre\core\Response $response) { @@ -155,6 +157,10 @@ /** * Check for newly achieved Achievements. + * + * @param Request $request Current request + * @param Response $response Current response + * @param array $checkConditions Conditions to check */ protected function checkAchievements(\nre\core\Request $request, \nre\core\Response $response, $checkConditions=null) { diff --git a/app/exceptions/FileUploadException.inc b/app/exceptions/FileUploadException.inc index 3fb62e6f..c4c6b922 100644 --- a/app/exceptions/FileUploadException.inc +++ b/app/exceptions/FileUploadException.inc @@ -44,6 +44,10 @@ /** * Construct a new exception. + * + * @param string $nestedMessage Nested message + * @param string $message Error message + * @param int $code Error code */ function __construct($nestedMessage=null, $message=self::MESSAGE, $code=self::CODE) { diff --git a/app/exceptions/MailingException.inc b/app/exceptions/MailingException.inc index 4014340e..d68f8149 100644 --- a/app/exceptions/MailingException.inc +++ b/app/exceptions/MailingException.inc @@ -44,6 +44,10 @@ /** * Construct a new exception. + * + * @param int $error Nested error message + * @param string $message Error message + * @param int $code Error code */ function __construct($error, $message=self::MESSAGE, $code=self::CODE) { diff --git a/app/exceptions/MaxFilesizeException.inc b/app/exceptions/MaxFilesizeException.inc index f16f335e..bc7a1383 100644 --- a/app/exceptions/MaxFilesizeException.inc +++ b/app/exceptions/MaxFilesizeException.inc @@ -37,6 +37,9 @@ /** * Construct a new exception. + * + * @param string $message Error message + * @param int $code Error code */ function __construct($message=self::MESSAGE, $code=self::CODE) { diff --git a/app/exceptions/QuesttypeAgentNotFoundException.inc b/app/exceptions/QuesttypeAgentNotFoundException.inc index 5f6f4ea9..0aeaf298 100644 --- a/app/exceptions/QuesttypeAgentNotFoundException.inc +++ b/app/exceptions/QuesttypeAgentNotFoundException.inc @@ -46,6 +46,8 @@ * Construct a new exception. * * @param string $questtypeName Name of the QuesttypeAgent that was not found + * @param string $message Error message + * @param int $code Error code */ function __construct($questtypeName, $message=self::MESSAGE, $code=self::CODE) { diff --git a/app/exceptions/QuesttypeAgentNotValidException.inc b/app/exceptions/QuesttypeAgentNotValidException.inc index 8fa7237f..5efc8c3e 100644 --- a/app/exceptions/QuesttypeAgentNotValidException.inc +++ b/app/exceptions/QuesttypeAgentNotValidException.inc @@ -46,6 +46,8 @@ * Construct a new exception. * * @param string $questtypeName Name of the invalid QuesttypeAgent + * @param string $message Error message + * @param int $code Error code */ function __construct($questtypeName, $message=self::MESSAGE, $code=self::CODE) { diff --git a/app/exceptions/QuesttypeControllerNotFoundException.inc b/app/exceptions/QuesttypeControllerNotFoundException.inc index 6d3a4a36..e0447cc9 100644 --- a/app/exceptions/QuesttypeControllerNotFoundException.inc +++ b/app/exceptions/QuesttypeControllerNotFoundException.inc @@ -46,6 +46,8 @@ * Construct a new exception. * * @param string $questtypeName Name of the QuesttypeController that was not found + * @param string $message Error message + * @param int $code Error code */ function __construct($questtypeName, $message=self::MESSAGE, $code=self::CODE) { diff --git a/app/exceptions/QuesttypeControllerNotValidException.inc b/app/exceptions/QuesttypeControllerNotValidException.inc index 8c6735b8..f4ccbee1 100644 --- a/app/exceptions/QuesttypeControllerNotValidException.inc +++ b/app/exceptions/QuesttypeControllerNotValidException.inc @@ -46,6 +46,8 @@ * Construct a new exception. * * @param string $questtypeName Name of the invalid QuesttypeController + * @param string $message Error message + * @param int $code Error code */ function __construct($questtypeName, $message=self::MESSAGE, $code=self::CODE) { diff --git a/app/exceptions/QuesttypeModelNotFoundException.inc b/app/exceptions/QuesttypeModelNotFoundException.inc index a2aa01c8..9a6d2294 100644 --- a/app/exceptions/QuesttypeModelNotFoundException.inc +++ b/app/exceptions/QuesttypeModelNotFoundException.inc @@ -46,6 +46,8 @@ * Construct a new exception. * * @param string $questtypeName Name of the QuesttypeModel that was not found + * @param string $message Error message + * @param int $code Error code */ function __construct($questtypeName, $message=self::MESSAGE, $code=self::CODE) { diff --git a/app/exceptions/QuesttypeModelNotValidException.inc b/app/exceptions/QuesttypeModelNotValidException.inc index 4a78beb6..911701e8 100644 --- a/app/exceptions/QuesttypeModelNotValidException.inc +++ b/app/exceptions/QuesttypeModelNotValidException.inc @@ -46,6 +46,8 @@ * Construct a new exception. * * @param string $questtypeName Name of the invalid QuesttypeModel + * @param string $message Error message + * @param int $code Error code */ function __construct($questtypeName, $message=self::MESSAGE, $code=self::CODE) { diff --git a/app/exceptions/SubmissionNotValidException.inc b/app/exceptions/SubmissionNotValidException.inc index e2923bdf..0902c78a 100644 --- a/app/exceptions/SubmissionNotValidException.inc +++ b/app/exceptions/SubmissionNotValidException.inc @@ -46,6 +46,8 @@ * Construct a new exception. * * @param string $nestedException Nested exception + * @param string $message Error message + * @param int $code Error code */ function __construct($nestedException, $message=self::MESSAGE, $code=self::CODE) { diff --git a/app/exceptions/WrongFiletypeException.inc b/app/exceptions/WrongFiletypeException.inc index 131356b8..13eb91df 100644 --- a/app/exceptions/WrongFiletypeException.inc +++ b/app/exceptions/WrongFiletypeException.inc @@ -44,6 +44,10 @@ /** * Construct a new exception. + * + * @param string $type Type of file + * @param string $message Error message + * @param int $code Error code */ function __construct($type, $message=self::MESSAGE, $code=self::CODE) { diff --git a/controllers/CharactersController.inc b/controllers/CharactersController.inc index c276827e..63c82bbf 100644 --- a/controllers/CharactersController.inc +++ b/controllers/CharactersController.inc @@ -67,6 +67,7 @@ * * @throws IdNotFoundException * @param string $seminaryUrl URL-Title of a Seminary + * @param string $all Whether to list all Characters at once or not (optional) */ public function index($seminaryUrl, $all=null) { diff --git a/controllers/MailController.inc b/controllers/MailController.inc index bcc4307d..d49d2bb2 100644 --- a/controllers/MailController.inc +++ b/controllers/MailController.inc @@ -66,7 +66,8 @@ * * @param array $receiver User that the message will be send to * @param array $seminary Seminary which the Character was created for - * @param array $newCharacter Newly registered user + * @param arary $user User of the newly registered Character + * @param array $newCharacter Newly registered Character */ public function characterregistration($receiver, $seminary, $user, $newCharacter) { diff --git a/controllers/MailreceiverController.inc b/controllers/MailreceiverController.inc index 6e854b2c..7ae92470 100644 --- a/controllers/MailreceiverController.inc +++ b/controllers/MailreceiverController.inc @@ -26,6 +26,8 @@ /** * Action: index. + * + * @param $array $user User receiving mail */ public function index($user) { diff --git a/controllers/QuestsController.inc b/controllers/QuestsController.inc index 4145192e..80f5b23f 100644 --- a/controllers/QuestsController.inc +++ b/controllers/QuestsController.inc @@ -1108,46 +1108,6 @@ } - /** - * Action: createmedia. - * TODO only temporary for easier data import. - * - * Display a form for creating new Seminary media. - * - * @param string $seminaryUrl URL-title of Seminary - */ - public function createmedia($seminaryUrl) - { - // Get seminary - $seminary = $this->Seminaries->getSeminaryByUrl($seminaryUrl); - - // Create media - $mediaId = null; - $error = null; - if($this->request->getRequestMethod() == 'POST' && !is_null($this->request->getPostParam('submit'))) - { - $file = $_FILES['file']; - $error = $file['error']; - if(empty($error)) - { - $mediaId = $this->Media->createQuestMedia( - $this->Auth->getUserId(), - $seminary['id'], - $file['name'], - $this->request->getPostParam('description'), - $file['type'], - $file['tmp_name'] - ); - } - } - - - // Pass data to view - $this->set('seminary', $seminary); - $this->set('mediaid', $mediaId); - } - - /** diff --git a/controllers/UploadsController.inc b/controllers/UploadsController.inc index 33d6e92b..8b1e3e60 100644 --- a/controllers/UploadsController.inc +++ b/controllers/UploadsController.inc @@ -74,6 +74,7 @@ * @throws IdNotFoundException * @param string $seminaryUrl URL-title of Seminary * @param string $uploadUrl URL-name of the upload + * @param string $action Current action (optional) */ public function seminary($seminaryUrl, $uploadUrl, $action=null) { diff --git a/controllers/UsersController.inc b/controllers/UsersController.inc index 7f72a583..d42b4828 100644 --- a/controllers/UsersController.inc +++ b/controllers/UsersController.inc @@ -49,6 +49,8 @@ /** * Action: index. + * + * @param string $all Whether to list all users at once or not (optional) */ public function index($all=null) { diff --git a/core/Agent.inc b/core/Agent.inc index 00ec1a90..9910c8ae 100644 --- a/core/Agent.inc +++ b/core/Agent.inc @@ -64,8 +64,8 @@ * Load the class of an Agent. * * @static - * @throws AgentNotFoundException - * @throws AgentNotValidException + * @throws \nre\exceptions\AgentNotFoundException + * @throws \nre\exceptions\AgentNotValidException * @param string $agentName Name of the Agent to load */ public static function load($agentName) @@ -500,7 +500,8 @@ /** * Handle the exception of a SubAgent. * - * @param string $label Name of the original Agent + * @param array $subAgent Original (Sub-) Agent + * @param Request $request Current request * @param Excepiton $exception Occurred exception * @return array InlineError-SubAgent */ diff --git a/core/Controller.inc b/core/Controller.inc index 47b5e0a5..c63ea34b 100644 --- a/core/Controller.inc +++ b/core/Controller.inc @@ -93,6 +93,7 @@ * @param string $controllerName Name of the Controller to instantiate * @param string $layoutName Name of the current Layout * @param string $action Current Action + * @param string $agent Corresponding Agent */ public static function factory($controllerName, $layoutName, $action, $agent) { diff --git a/core/Driver.inc b/core/Driver.inc index eec59143..b4d83c7c 100644 --- a/core/Driver.inc +++ b/core/Driver.inc @@ -55,6 +55,7 @@ * Instantiate a Driver (Factory Pattern). * * @param string $driverName Name of the Driver to instantiate + * @param array $config Configuration settings */ public static function factory($driverName, $config) { diff --git a/core/Linker.inc b/core/Linker.inc index a29c5b81..e73b8e42 100644 --- a/core/Linker.inc +++ b/core/Linker.inc @@ -215,8 +215,8 @@ * * @param Request $request Current request * @param Response $response Current response - * @param bool $absolute Create absolute link * @param string $anchor Anchor on target + * @param bool $absolute Create absolute link * @return string Created link */ private static function createLink(Request $request, Response $response, $anchor=null, $absolute=false) diff --git a/exceptions/ClassNotFoundException.inc b/exceptions/ClassNotFoundException.inc index 070f383f..a2042b2b 100644 --- a/exceptions/ClassNotFoundException.inc +++ b/exceptions/ClassNotFoundException.inc @@ -46,6 +46,8 @@ * Construct a new exception * * @param string $className Name of the class that was not found + * @param string $message Error message + * @param int $code Error code */ function __construct($className, $message=self::MESSAGE, $code=self::CODE) { diff --git a/exceptions/ClassNotValidException.inc b/exceptions/ClassNotValidException.inc index bdd36d5e..4e8a424c 100644 --- a/exceptions/ClassNotValidException.inc +++ b/exceptions/ClassNotValidException.inc @@ -46,6 +46,8 @@ * Construct a new exception. * * @param string $className Name of the invalid class + * @param string $message Error message + * @param int $code Error code */ function __construct($className, $message=self::MESSAGE, $code=self::CODE) { diff --git a/models/AchievementsModel.inc b/models/AchievementsModel.inc index 9201fa95..c5bc1006 100644 --- a/models/AchievementsModel.inc +++ b/models/AchievementsModel.inc @@ -132,9 +132,10 @@ /** * Get seldom Achievements. * - * @param int $seminaryId ID of Seminary - * @param int $count Number of Achievements to retrieve - * @return array List of seldom Achievements + * @param int $seminaryId ID of Seminary + * @param int $count Number of Achievements to retrieve + * @param bool $alsoWithDeadline Include Achievements with deadline (optional) + * @return array List of seldom Achievements */ public function getSeldomAchievements($seminaryId, $count, $alsoWithDeadline=true) { @@ -161,6 +162,7 @@ * Get all achieved Achievements for a Character. * * @param int $characterId ID of Character + * @param bool $alsoWithDeadline Include Achievements with deadline (optional) * @return array Achievements data */ public function getAchievedAchievementsForCharacter($characterId, $alsoWithDeadline=true) diff --git a/models/CharactergroupsModel.inc b/models/CharactergroupsModel.inc index 78a0e31f..ba52ff31 100644 --- a/models/CharactergroupsModel.inc +++ b/models/CharactergroupsModel.inc @@ -193,6 +193,7 @@ * Get Character groups for a Character groups-group. * * @param int $groupsgroupId ID of the Character groups-group + * @param string $sortorder Field to sort by (optional) * @return array Character groups */ public function getGroupsForGroupsgroup($groupsgroupId, $sortorder='name') diff --git a/models/CharactersModel.inc b/models/CharactersModel.inc index 7a6c669b..0f2ea012 100644 --- a/models/CharactersModel.inc +++ b/models/CharactersModel.inc @@ -92,6 +92,7 @@ * Get Characters for a Seminary. * * @param int $seminaryId ID of the Seminary + * @param bool $onlyWithRole Only Characters that have at least one role assigned (optional) * @return array Characters */ public function getCharactersForSeminary($seminaryId, $onlyWithRole=false) @@ -356,9 +357,10 @@ /** * Get Characters with the most amount of Achievements. * - * @param int $seminaryId ID of Seminary - * @param int $conut Amount of Characters to retrieve - * @return array List of Characters + * @param int $seminaryId ID of Seminary + * @param int $conut Amount of Characters to retrieve + * @param bool $alsoWithDeadline Include Achievements with deadline (optional) + * @return array List of Characters */ public function getCharactersWithMostAchievements($seminaryId, $count, $alsoWithDeadline=true) { @@ -458,6 +460,7 @@ * Get the inferior $count Characters in the ranking. * * @param int $seminaryId ID of Seminary + * @param int characterId ID of Character * @param int $xps XP-value of Character * @param int $count Count of Characters to determine * @return array List of inferior Characters diff --git a/models/QuestgroupsModel.inc b/models/QuestgroupsModel.inc index 01037715..9935c699 100644 --- a/models/QuestgroupsModel.inc +++ b/models/QuestgroupsModel.inc @@ -811,7 +811,7 @@ } - /* + /** * Calculate the total amount of achievable XPs for a Quest and * its following Quests by choosing the path with the highest * amount of XPs. diff --git a/models/QuestgroupshierarchyModel.inc b/models/QuestgroupshierarchyModel.inc index 72a1c78e..5153c2aa 100644 --- a/models/QuestgroupshierarchyModel.inc +++ b/models/QuestgroupshierarchyModel.inc @@ -62,7 +62,8 @@ /** * Get a Questgroup hierarchy by its URL. * - * throws IdNotFoundException + * @throws IdNotFoundException + * @param int $seminaryId ID of Seminary * @param int $questgroupshierarchyURL URL of a Questgroup hierarchy * @return array Questgroup hierarchy */ diff --git a/models/QuestsModel.inc b/models/QuestsModel.inc index bab9c992..c25d7ee6 100644 --- a/models/QuestsModel.inc +++ b/models/QuestsModel.inc @@ -394,6 +394,7 @@ * @param int $seminaryId ID of Seminary * @param int $questgroupId ID of Questgroup (optional) * @param int $questtypeId ID of Questtype (optional) + * @param string $title Part of the title to filter for (optional) * @return int Count of Quests for this Seminary */ public function getCountForQuestsForSeminaryByOpenSubmissions($seminaryId, $questgroupId=null, $questtypeId=null, $title=null) @@ -425,6 +426,7 @@ * @param int $seminaryId ID of Seminary * @param int $questgroupId ID of Questgroup (optional) * @param int $questtypeId ID of Questtype (optional) + * @param string $title Part of title to filter for (optional) * @param int $limit Limit amount of Quests (optional) * @param int $offset Offset (optional) * @return array Quests for this Seminary diff --git a/models/QuesttextsModel.inc b/models/QuesttextsModel.inc index b66eb284..07711a2c 100644 --- a/models/QuesttextsModel.inc +++ b/models/QuesttextsModel.inc @@ -149,6 +149,13 @@ } + /** + * Get the Questtext that was last entered by a Character. + * + * @param int $characterId ID of Character + * @param array $questtexts List of Questtexts to look into + * @return array Questtext data + */ public function pickQuesttextLastEnteredByCharacter($characterId, $questtexts) { if(count($questtexts) == 0) { diff --git a/models/SeminariesModel.inc b/models/SeminariesModel.inc index 81dcc91c..7c8fd9a6 100644 --- a/models/SeminariesModel.inc +++ b/models/SeminariesModel.inc @@ -106,7 +106,7 @@ } - /* + /** * Calculate sum of XPs for a Seminary. * * @param int $seminaryId ID of Seminary diff --git a/models/SeminarycharacterfieldsModel.inc b/models/SeminarycharacterfieldsModel.inc index 1a17706d..8286e692 100644 --- a/models/SeminarycharacterfieldsModel.inc +++ b/models/SeminarycharacterfieldsModel.inc @@ -82,6 +82,7 @@ /** * Get Seminary Character fields of a Character. * + * @param int $fieldId ID of Seminary Character field * @param int $characterId ID of the Character * @return array Seminary Character fields */ diff --git a/models/UsersModel.inc b/models/UsersModel.inc index d06a2a2e..43eee2a8 100644 --- a/models/UsersModel.inc +++ b/models/UsersModel.inc @@ -248,6 +248,8 @@ * Create a new user. * * @param string $username Username of the user to create + * @param string $prename Prename of the user to create + * @param string $surname Surname of the user to create * @param string $email E‑Mail-Address of the user to create * @param string $password Password of the user to create * @return int ID of the newly created user @@ -303,8 +305,11 @@ * @throws DatamodelException * @param int $userId ID of the user to delete * @param string $username New name of user + * @param string $prename Prename of the user to create + * @param string $surname Surname of the user to create * @param string $email Changed e‑mail-address of user * @param string $password Changed plaintext password of user + * @param bool $mailing Whether to activate mailing or not */ public function editUser($userId, $username, $prename, $surname, $email, $password, $mailing) { diff --git a/questtypes/bossfight/BossfightQuesttypeController.inc b/questtypes/bossfight/BossfightQuesttypeController.inc index 6f3ecfe5..20118002 100644 --- a/questtypes/bossfight/BossfightQuesttypeController.inc +++ b/questtypes/bossfight/BossfightQuesttypeController.inc @@ -74,6 +74,7 @@ * @param array $questgroup Current Questgroup data * @param array $quest Current Quest data * @param array $character Current Character data + * @param array $answers Character answers for the Quest * @return boolean True/false for a right/wrong answer or null for moderator evaluation */ public function matchAnswersOfCharacter($seminary, $questgroup, $quest, $character, $answers) diff --git a/questtypes/choiceinput/ChoiceinputQuesttypeController.inc b/questtypes/choiceinput/ChoiceinputQuesttypeController.inc index f92bd221..f5792a6a 100644 --- a/questtypes/choiceinput/ChoiceinputQuesttypeController.inc +++ b/questtypes/choiceinput/ChoiceinputQuesttypeController.inc @@ -75,6 +75,7 @@ * @param array $questgroup Current Questgroup data * @param array $quest Current Quest data * @param array $character Current Character data + * @param array $answers Character answers for the Quest * @return boolean True/false for a right/wrong answer or null for moderator evaluation */ public function matchAnswersOfCharacter($seminary, $questgroup, $quest, $character, $answers) diff --git a/questtypes/crossword/CrosswordQuesttypeController.inc b/questtypes/crossword/CrosswordQuesttypeController.inc index 352eea7b..8df3ba69 100644 --- a/questtypes/crossword/CrosswordQuesttypeController.inc +++ b/questtypes/crossword/CrosswordQuesttypeController.inc @@ -102,6 +102,7 @@ * @param array $questgroup Current Questgroup data * @param array $quest Current Quest data * @param array $character Current Character data + * @param array $answers Character answers for the Quest * @return boolean True/false for a right/wrong answer or null for moderator evaluation */ public function matchAnswersOfCharacter($seminary, $questgroup, $quest, $character, $answers) diff --git a/questtypes/dragndrop/DragndropQuesttypeController.inc b/questtypes/dragndrop/DragndropQuesttypeController.inc index c08bac6e..ff3fd909 100644 --- a/questtypes/dragndrop/DragndropQuesttypeController.inc +++ b/questtypes/dragndrop/DragndropQuesttypeController.inc @@ -86,6 +86,7 @@ * @param array $questgroup Current Questgroup data * @param array $quest Current Quest data * @param array $character Current Character data + * @param array $answers Character answers for the Quest * @return boolean True/false for a right/wrong answer or null for moderator evaluation */ public function matchAnswersOfCharacter($seminary, $questgroup, $quest, $character, $answers) diff --git a/questtypes/multiplechoice/MultiplechoiceQuesttypeController.inc b/questtypes/multiplechoice/MultiplechoiceQuesttypeController.inc index 8bbca2d8..bcb9cbed 100644 --- a/questtypes/multiplechoice/MultiplechoiceQuesttypeController.inc +++ b/questtypes/multiplechoice/MultiplechoiceQuesttypeController.inc @@ -82,6 +82,7 @@ * @param array $questgroup Current Questgroup data * @param array $quest Current Quest data * @param array $character Current Character data + * @param array $answers Character answers for the Quest * @return boolean True/false for a right/wrong answer or null for moderator evaluation */ public function matchAnswersOfCharacter($seminary, $questgroup, $quest, $character, $answers) diff --git a/questtypes/submit/SubmitQuesttypeModel.inc b/questtypes/submit/SubmitQuesttypeModel.inc index 9b5e9b47..5a00966b 100644 --- a/questtypes/submit/SubmitQuesttypeModel.inc +++ b/questtypes/submit/SubmitQuesttypeModel.inc @@ -34,8 +34,10 @@ * * @param int $seminaryId ID of Seminary * @param int $questId ID of Quest + * @param int $userId ID of user * @param int $characterId ID of Character * @param array $file Submitted upload + * @param string $filename Name of submitted file */ public function setCharacterSubmission($seminaryId, $questId, $userId, $characterId, $file, $filename) { diff --git a/questtypes/textinput/TextinputQuesttypeController.inc b/questtypes/textinput/TextinputQuesttypeController.inc index 3255d30d..2592108c 100644 --- a/questtypes/textinput/TextinputQuesttypeController.inc +++ b/questtypes/textinput/TextinputQuesttypeController.inc @@ -74,6 +74,7 @@ * @param array $questgroup Current Questgroup data * @param array $quest Current Quest data * @param array $character Current Character data + * @param array $answers Character answers for the Quest * @return boolean True/false for a right/wrong answer or null for moderator evaluation */ public function matchAnswersOfCharacter($seminary, $questgroup, $quest, $character, $answers)