coderkun/questlab
1
0
Fork 0
Code Issues 15 Pull requests Projects Releases Wiki Activity

add namespaces to docstring types

Browse source
This commit is contained in:
coderkun 2015-03-06 12:19:07 +01:00
commit 969887da58
98 changed files with 632 additions and 555 deletions
Download patch file Download diff file Expand all files Collapse all files

28
app/Controller.inc
View file

@ -29,13 +29,13 @@
/**
* Logger instance
*
* @var Logger
* @var \nre\core\Logger
*/
protected $log = null;
/**
* Linker instance
*
* @var Linker
* @var \nre\core\Linker
*/
protected $linker = null;
@ -45,14 +45,14 @@
/**
* Construct a new application Controller.
*
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws ViewNotFoundException
* @param string $layoutName Name of the current Layout
* @param string $action Current Action
* @param Agent $agent Corresponding Agent
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @throws \nre\exceptions\ModelNotValidException
* @throws \nre\exceptions\ModelNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @param string $layoutName Name of the current Layout
* @param string $action Current Action
* @param \nre\core\Agent $agent Corresponding Agent
*/
public function __construct($layoutName, $action, $agent)
{
@ -67,8 +67,8 @@
/**
* Prefilter that is executed before running the Controller.
*
* @param Request $request Current request
* @param Response $response Current response
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
*/
public function preFilter(\nre\core\Request $request, \nre\core\Response $response)
{
@ -104,8 +104,8 @@
/**
* Postfilter that is executed after running the Controller.
*
* @param Request $request Current request
* @param Response $response Current response
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
*/
public function postFilter(\nre\core\Request $request, \nre\core\Response $response)
{

10
app/Model.inc
View file

@ -26,11 +26,11 @@
/**
* Construct a new application Model.
*
* @throws DatamodelException
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @throws \nre\exceptions\ModelNotValidException
* @throws \nre\exceptions\ModelNotFoundException
*/
public function __construct()
{

6
app/TextFormatter.inc
View file

@ -22,14 +22,14 @@
/**
* Linker to create links.
*
* @var Linker
* @var \nre\core\Linker
*/
private $linker;
/**
* Media-Model to retrieve media data
*
* @static
* @var model
* @var \nre\core\Model
*/
private static $Media = null;
@ -39,7 +39,7 @@
/**
* Create a new text formatter.
*
* @param Linker $linker Linker to create links with
* @param \nre\core\Linker $linker Linker to create links with
*/
public function __construct(\nre\core\Linker $linker)
{

12
app/Utils.inc
View file

@ -82,12 +82,12 @@
/**
* Send an e‑mail.
*
* @throws MailingException
* @param mixed $to One (string) or many (array) receivers
* @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
* @throws \hhu\z\exceptions\MailingException
* @param mixed $to One (string) or many (array) receivers
* @param string $messageAction Message Action
* @param boolean $html Whether mail should be formatted as HTML or not
* @param array $params Parameters to pass
* @param \nre\core\Linker $linker Linker instance
*/
public static function sendMail($to, $messageAction, $html=false, $params=null, $linker=null)
{

74
app/agents/QuesttypeAgent.inc
View file

@ -22,13 +22,13 @@
/**
* Current request
*
* @var Request
* @var \nre\core\Request
*/
private $request;
/**
* Current response
*
* @var Response
* @var \nre\core\Response
*/
private $response;
@ -39,8 +39,8 @@
* Load a QuesttypeAgent.
*
* @static
* @throws QuesttypeAgentNotFoundException
* @throws QuesttypeAgentNotValidException
* @throws \hhu\z\exceptions\QuesttypeAgentNotFoundException
* @throws \hhu\z\exceptions\QuesttypeAgentNotValidException
* @param string $questtypeName Name of the QuesttypeAgent to load
*/
public static function load($questtypeName)
@ -68,14 +68,14 @@
* Instantiate a QuesttypeAgent (Factory Pattern).
*
* @static
* @throws DatamodelException
* @throws DriverNotValidException
* @throws DriverNotFoundException
* @throws ViewNotFoundException
* @throws QuesttypeModelNotValidException
* @throws QuesttypeModelNotFoundException
* @throws QuesttypeControllerNotValidException
* @throws QuesttypeControllerNotFoundException
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\DriverNotValidException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @throws \hhu\z\exceptions\QuesttypeModelNotValidException
* @throws \hhu\z\exceptions\QuesttypeModelNotFoundException
* @throws \hhu\z\exceptions\QuesttypeControllerNotValidException
* @throws \hhu\z\exceptions\QuesttypeControllerNotFoundException
* @param string $questtypeName Name of the QuesttypeAgent to instantiate
* @param Request $request Current request
* @param Response $response Current respone
@ -129,7 +129,7 @@
* Load the class of a QuesttypeAgent.
*
* @static
* @throws ClassNotFoundException
* @throws \nre\exceptions\ClassNotFoundException
* @param string $questtypeName Name of the QuesttypeAgent to load
* @param string $fullClassName Name of the class to load
*/
@ -159,7 +159,7 @@
* Check inheritance of the QuesttypeAgent-class.
*
* @static
* @throws ClassNotValidException
* @throws \nre\exceptions\ClassNotValidException
* @param string $className Name of the class to check
* @param string $parentClassName Name of the parent class
*/
@ -179,19 +179,19 @@
/**
* Construct a new QuesttypeAgent.
*
* @throws DatamodelException
* @throws DriverNotValidException
* @throws DriverNotFoundException
* @throws ViewNotFoundException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws QuesttypeModelNotValidException
* @throws QuesttypeModelNotFoundException
* @throws QuesttypeControllerNotValidException
* @throws QuesttypeControllerNotFoundException
* @param Request $request Current request
* @param Response $response Current response
* @param Logger $log Log-system
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\DriverNotValidException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @throws \nre\exceptions\ModelNotValidException
* @throws \nre\exceptions\ModelNotFoundException
* @throws \hhu\z\exceptions\QuesttypeModelNotValidException
* @throws \hhu\z\exceptions\QuesttypeModelNotFoundException
* @throws \hhu\z\exceptions\QuesttypeControllerNotValidException
* @throws \hhu\z\exceptions\QuesttypeControllerNotFoundException
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
* @param \nre\core\Logger $log Log-system
*/
protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null)
{
@ -242,16 +242,16 @@
/**
* Load the Controller of this Agent.
*
* @throws DatamodelException
* @throws DriverNotValidException
* @throws DriverNotFoundException
* @throws ViewNotFoundException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws QuesttypeModelNotValidException
* @throws QuesttypeModelNotFoundException
* @throws QuesttypeControllerNotValidException
* @throws QuesttypeControllerNotFoundException
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\DriverNotValidException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @throws \nre\exceptions\ModelNotValidException
* @throws \nre\exceptions\ModelNotFoundException
* @throws \hhu\z\exceptions\QuesttypeModelNotValidException
* @throws \hhu\z\exceptions\QuesttypeModelNotFoundException
* @throws \hhu\z\exceptions\QuesttypeControllerNotValidException
* @throws \hhu\z\exceptions\QuesttypeControllerNotFoundException
*/
protected function loadController()
{

6
app/agents/ToplevelAgent.inc
View file

@ -26,9 +26,9 @@
/**
* Construct a new ToplevlAgent
*
* @param Request $request Current request
* @param Response $response Current response
* @param Logger $log Logger instance
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
* @param \nre\core\Logger $log Logger instance
*/
protected function __construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log=null)
{

4
app/apis/MailApi.inc
View file

@ -46,7 +46,7 @@
/**
* Set linker instance for creating links.
*
* @param Linker $linker Linker instance for creating links
* @param \nre\core\Linker $linker Linker instance for creating links
*/
public function setLinker(\nre\core\Linker $linker)
{
@ -140,7 +140,7 @@
*
* This method runs the generation of mailtext.
*
* @return Exception Occured exception or null
* @return \Exception Occured exception or null
*/
public function run()
{

30
app/controllers/IntermediateController.inc
View file

@ -44,14 +44,14 @@
/**
* Construct a new IntermediateController.
*
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws ViewNotFoundException
* @param string $layoutName Name of the current Layout
* @param string $action Current Action
* @param Agent $agent Corresponding Agent
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @throws \nre\exceptions\ModelNotValidException
* @throws \nre\exceptions\ModelNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @param string $layoutName Name of the current Layout
* @param string $action Current Action
* @param \nre\core\Agent $agent Corresponding Agent
*/
public function __construct($layoutName, $action, $agent)
{
@ -63,8 +63,8 @@
/**
* Prefilter that is executed before running the Controller.
*
* @param Request $request Current request
* @param Response $response Current response
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
*/
public function preFilter(\nre\core\Request $request, \nre\core\Response $response)
{
@ -89,8 +89,8 @@
/**
* Postfilter that is executed after running the Controller.
*
* @param Request $request Current request
* @param Response $response Current response
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
*/
public function postFilter(\nre\core\Request $request, \nre\core\Response $response)
{
@ -153,9 +153,9 @@
/**
* Check user permissions.
*
* @throws AccessDeniedException
* @param Request $request Current request
* @param Response $response Current response
* @throws \nre\exceptions\AccessDeniedException
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
*/
private function checkPermission(\nre\core\Request $request, \nre\core\Response $response)
{

68
app/controllers/QuesttypeController.inc
View file

@ -75,7 +75,7 @@
* @param array $questgroup Current Questgroup data
* @param array $quest Current Quest data
* @param array $character Current Character data
* @param Exception $exception Character submission exception
* @param \Exception $exception Character submission exception
*/
public abstract function quest($seminary, $questgroup, $quest, $character, $exception);
@ -111,8 +111,8 @@
* Load a QuesttypeController.
*
* @static
* @throws QuesttypeControllerNotFoundException
* @throws QuesttypeControllerNotValidException
* @throws \hhu\z\exceptions\QuesttypeControllerNotFoundException
* @throws \hhu\z\exceptions\QuesttypeControllerNotValidException
* @param string $controllerName Name of the QuesttypeController to load
*/
public static function load($controllerName)
@ -140,18 +140,18 @@
* Instantiate a QuesttypeController (Factory Pattern).
*
* @static
* @throws DatamodelException
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws QuesttypeModelNotValidException
* @throws QuesttypeModelNotFoundException
* @throws ViewNotFoundException
* @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
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @throws \nre\exceptions\ModelNotValidException
* @throws \nre\exceptions\ModelNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @throws \hhu\z\exceptions\QuesttypeModelNotValidException
* @throws \hhu\z\exceptions\QuesttypeModelNotFoundException
* @param string $controllerName Name of the QuesttypeController to instantiate
* @param string $layoutName Name of the current Layout
* @param string $action Current Action
* @param \nre\core\Agent $agent Corresponding Agent
*/
public static function factory($controllerName, $layoutName, $action, $agent)
{
@ -183,7 +183,7 @@
* Load the class of a QuesttypeController
*
* @static
* @throws ClassNotFoundException
* @throws \nre\exceptions\ClassNotFoundException
* @param string $questtypeName Name of the QuesttypeController to load
* @param string $fullClassName Name of the class to load
*/
@ -213,7 +213,7 @@
* Check inheritance of the QuesttypeController-class.
*
* @static
* @throws ClassNotValidException
* @throws \nre\exceptions\ClassNotValidException
* @param string $className Name of the class to check
* @param string $parentClassName Name of the parent class
*/
@ -233,13 +233,13 @@
/**
* Construct a new application Controller.
*
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws QuesttypeModelNotValidException
* @throws QuesttypeModelNotFoundException
* @throws ViewNotFoundException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @throws \nre\exceptions\ModelNotValidException
* @throws \nre\exceptions\ModelNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @throws \hhu\z\exceptions\QuesttypeModelNotValidException
* @throws \hhu\z\exceptions\QuesttypeModelNotFoundException
* @param string $layoutName Name of the current Layout
* @param string $action Current Action
* @param Agent $agent Corresponding Agent
@ -255,13 +255,13 @@
/**
* Load the Models of this Controller.
*
* @throws DatamodelException
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws QuesttypeModelNotValidException
* @throws QuesttypeModelNotFoundException
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @throws \nre\exceptions\ModelNotValidException
* @throws \nre\exceptions\ModelNotFoundException
* @throws \hhu\z\exceptions\QuesttypeModelNotValidException
* @throws \hhu\z\exceptions\QuesttypeModelNotFoundException
*/
protected function loadModels()
{
@ -276,8 +276,8 @@
/**
* Load the Model of the Questtype.
*
* @throws QuesttypeModelNotValidException
* @throws QuesttypeModelNotFoundException
* @throws \hhu\z\exceptions\QuesttypeModelNotValidException
* @throws \hhu\z\exceptions\QuesttypeModelNotFoundException
*/
private function loadModel()
{
@ -296,7 +296,7 @@
/**
* Load the View of this QuesttypeController.
*
* @throws ViewNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @param string $layoutName Name of the current Layout
* @param string $action Current Action
*/

34
app/controllers/SeminaryController.inc
View file

@ -51,14 +51,14 @@
/**
* Construct a new Seminary Controller.
*
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws ViewNotFoundException
* @param string $layoutName Name of the current Layout
* @param string $action Current Action
* @param Agent $agent Corresponding Agent
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @throws \nre\exceptions\ModelNotValidException
* @throws \nre\exceptions\ModelNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @param string $layoutName Name of the current Layout
* @param string $action Current Action
* @param \nre\core\Agent $agent Corresponding Agent
*/
public function __construct($layoutName, $action, $agent)
{
@ -70,8 +70,8 @@
/**
* Prefilter that is executed before running the Controller.
*
* @param Request $request Current request
* @param Response $response Current response
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
*/
public function preFilter(\nre\core\Request $request, \nre\core\Response $response)
{
@ -112,8 +112,8 @@
/**
* Postfilter that is executed after running the Controller.
*
* @param Request $request Current request
* @param Response $response Current response
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
*/
public function postFilter(\nre\core\Request $request, \nre\core\Response $response)
{
@ -126,8 +126,8 @@
* Check user permissions.
*
* @throws AccessDeniedException
* @param Request $request Current request
* @param Response $response Current response
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
*/
private function checkPermission(\nre\core\Request $request, \nre\core\Response $response)
{
@ -158,9 +158,9 @@
/**
* Check for newly achieved Achievements.
*
* @param Request $request Current request
* @param Response $response Current response
* @param array $checkConditions Conditions to check
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
* @param array $checkConditions Conditions to check
*/
protected function checkAchievements(\nre\core\Request $request, \nre\core\Response $response, $checkConditions=null)
{

18
app/models/QuesttypeModel.inc
View file

@ -27,8 +27,8 @@
* Load a Model.
*
* @static
* @throws QuesttypeModelNotFoundException
* @throws QuesttypeModelNotValidException
* @throws \hhu\z\exceptions\QuesttypeModelNotFoundException
* @throws \hhu\z\exceptions\QuesttypeModelNotValidException
* @param string $modelName Name of the QuesttypeModel to load
*/
public static function load($modelName)
@ -88,7 +88,7 @@
* Load the class of a QuesttypeModel.
*
* @static
* @throws ClassNotFoundException
* @throws \nre\exceptions\ClassNotFoundException
* @param string $questtypeName Name of the QuesttypeModel to load
* @param string $fullClassName Name of the class to load
*/
@ -118,7 +118,7 @@
* Check inheritance of the QuesttypeModel-class.
*
* @static
* @throws ClassNotValidException
* @throws \nre\exceptions\ClassNotValidException
* @param string $className Name of the class to check
* @param string $parentClassName Name of the parent class
*/
@ -138,11 +138,11 @@
/**
* Construct a new QuesttypeModel.
*
* @throws DatamodelException
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws QuesttypeModelNotValidException
* @throws QuesttypeModelNotFoundException
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @throws \hhu\z\exceptions\QuesttypeModelNotValidException
* @throws \hhu\z\exceptions\QuesttypeModelNotFoundException
*/
public function __construct()
{

4
app/requests/MailRequest.inc
View file

@ -22,7 +22,7 @@
/**
* Linker
*
* @var Linker
* @var \nre\core\Linker
*/
private $linker = null;
@ -80,7 +80,7 @@
/**
* Get linker instance for creating links.
*
* @return Linker Linker instance for creating links
* @return \nre\core\Linker Linker instance for creating links
*/
public function getLinker()
{

4
app/views/QuesttypeView.inc
View file

@ -26,7 +26,7 @@
/**
* Load and instantiate the QuesttypeView of a QuesttypeAgent.
*
* @throws ViewNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @param string $layoutName Name of Layout in use
* @param string $agentName Name of the Agent
* @param string $action Current Action
@ -43,7 +43,7 @@
/**
* Construct a new QuesttypeView.
*
* @throws ViewNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @param string $layoutName Name of Layout in use
* @param string $agentName Name of the Agent
* @param string $action Current Action