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

78
core/Agent.inc
View file

@ -97,14 +97,14 @@
* Instantiate an Agent (Factory Pattern).
*
* @static
* @throws DatamodelException
* @throws DriverNotValidException
* @throws DriverNotFoundException
* @throws ViewNotFoundException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws ControllerNotValidException
* @throws ControllerNotFoundException
* @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 \nre\exceptions\ControllerNotValidException
* @throws \nre\exceptions\ControllerNotFoundException
* @param string $agentName Name of the Agent to instantiate
* @param Request $request Current request
* @param Response $respone Current respone
@ -156,14 +156,14 @@
/**
* Construct a new Agent.
*
* @throws DatamodelException
* @throws DriverNotValidException
* @throws DriverNotFoundException
* @throws ViewNotFoundException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws ControllerNotValidException
* @throws ControllerNotFoundException
* @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 \nre\exceptions\ControllerNotValidException
* @throws \nre\exceptions\ControllerNotFoundException
* @param Request $request Current request
* @param Response $respone Current response
* @param Logger $log Log-system
@ -188,13 +188,13 @@
/**
* Run the Controller of this Agent and its SubAgents.
*
* @throws ParamsNotValidException
* @throws IdNotFoundException
* @throws DatamodelException
* @throws ActionNotFoundException
* @throws \nre\exceptions\ParamsNotValidException
* @throws \nre\exceptions\IdNotFoundException
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\ActionNotFoundException
* @param Request $request Current request
* @param Response $response Current response
* @return Exception Last occurred exception of SubAgents
* @return \Exception Last occurred exception of SubAgents
*/
public function run(Request $request, Response $response)
{
@ -302,14 +302,14 @@
/**
* Load the Controller of this Agent.
*
* @throws DatamodelException
* @throws DriverNotValidException
* @throws DriverNotFoundException
* @throws ViewNotFoundException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws ControllerNotValidException
* @throws ControllerNotFoundException
* @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 \nre\exceptions\ControllerNotValidException
* @throws \nre\exceptions\ControllerNotFoundException
*/
protected function loadController()
{
@ -342,7 +342,7 @@
/**
* Log an error.
*
* @param Exception $exception Occurred exception
* @param \Exception $exception Occurred exception
* @param int $logMode Log mode
*/
protected function log($exception, $logMode)
@ -361,9 +361,9 @@
/**
* Load a SubAgent and add it.
*
* @throws ServiceUnavailableException
* @throws AgentNotFoundException
* @throws AgentNotValidException
* @throws \nre\exceptions\ServiceUnavailableException
* @throws \nre\exceptions\AgentNotFoundException
* @throws \nre\exceptions\AgentNotValidException
* @param string $agentName Name of the Agent to load
* @param mixed … Additional parameters for the agent
*/
@ -387,10 +387,10 @@
/**
* Load a SubAgent and add it.
*
* @throws ServiceUnavailableException
* @throws DatamodelException
* @throws AgentNotFoundException
* @throws AgentNotValidException
* @throws \nre\exceptions\ServiceUnavailableException
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\AgentNotFoundException
* @throws \nre\exceptions\AgentNotValidException
* @param string $agentName Name of the Agent to load
* @param mixed … Additional parameters for the agent
*/
@ -444,7 +444,7 @@
/**
* Create a new SubAgent.
*
* @throws DatamodelException
* @throws \nre\exceptions\DatamodelException
* @param string $agentName Agent name
* @return array SubAgent
*/
@ -533,7 +533,7 @@
* Create a new InlineError.
*
* @param string $label Name of the original Agent
* @param Exception $exception Occurred exception
* @param \Exception $exception Occurred exception
*/
private function newInlineError($label, $exception)
{

32
core/Api.inc
View file

@ -31,7 +31,7 @@
/**
* Der Toplevelagent
*
* @var ToplevelAgent
* @var \nre\agents\ToplevelAgent
*/
private $toplevelAgent = null;
/**
@ -74,17 +74,17 @@
/**
* Run the application.
*
* @throws DatamodelException
* @throws DriverNotValidException
* @throws DriverNotFoundException
* @throws ViewNotFoundException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws ControllerNotValidException
* @throws ControllerNotFoundException
* @throws AgentNotValidException
* @throws AgentNotFoundException
* @return Exception Last occurred exception of an subagent
* @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 \nre\exceptions\ControllerNotValidException
* @throws \nre\exceptions\ControllerNotFoundException
* @throws \nre\exceptions\AgentNotValidException
* @throws \nre\exceptions\AgentNotFoundException
* @return \Exception Last occurred exception of an subagent
*/
public function run()
{
@ -116,7 +116,7 @@
/**
* Log an exception
*
* @param Exception $exception Occurred exception
* @param \Exception $exception Occurred exception
* @param int $logMode Log-mode
*/
protected function log($exception, $logMode)
@ -133,9 +133,9 @@
/**
* Load the ToplevelAgent specified by the request.
*
* @throws ServiceUnavailableException
* @throws AgentNotValidException
* @throws AgentNotFoundException
* @throws \nre\exceptions\ServiceUnavailableException
* @throws \nre\exceptions\AgentNotValidException
* @throws \nre\exceptions\AgentNotFoundException
*/
private function loadToplevelAgent()
{

4
core/ClassLoader.inc
View file

@ -26,7 +26,7 @@
/**
* Load a class.
*
* @throws ClassNotFoundException
* @throws \nre\exceptions\ClassNotFoundException
* @param string $className Name of the class to load
*/
public static function load($fullClassName)
@ -55,7 +55,7 @@
/**
* Check inheritance of a class.
*
* @throws ClassNotValidException
* @throws \nre\exceptions\ClassNotValidException
* @param string $className Name of the class to check
* @param string $parentClassName Name of the parent class
*/

4
core/Component.inc
View file

@ -26,8 +26,8 @@
/**
* Load the class of a Component.
*
* @throws ComponentNotFoundException
* @throws ComponentNotValidException
* @throws \nre\exceptions\ComponentNotFoundException
* @throws \nre\exceptions\ComponentNotValidException
* @param string $componentName Name of the Component to load
*/
public static function load($componentName)

50
core/Controller.inc
View file

@ -56,8 +56,8 @@
/**
* Load the class of a Controller.
*
* @throws ControllerNotFoundException
* @throws ControllerNotValidException
* @throws \nre\exceptions\ControllerNotFoundException
* @throws \nre\exceptions\ControllerNotValidException
* @param string $controllerName Name of the Controller to load
*/
public static function load($controllerName)
@ -84,12 +84,12 @@
/**
* Instantiate a Controller (Factory Pattern).
*
* @throws DatamodelException
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws ViewNotFoundException
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @throws \nre\exceptions\ModelNotValidException
* @throws \nre\exceptions\ModelNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @param string $controllerName Name of the Controller to instantiate
* @param string $layoutName Name of the current Layout
* @param string $action Current Action
@ -125,11 +125,11 @@
/**
* Construct a new Controller.
*
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws ViewNotFoundException
* @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 Agent $agent Corresponding Agent
@ -186,10 +186,10 @@
* This method executes the Action of the Controller defined by
* the current Request.
*
* @throws ParamsNotValidException
* @throws IdNotFoundException
* @throws DatamodelException
* @throws ActionNotFoundException
* @throws \nre\exceptions\ParamsNotValidException
* @throws \nre\exceptions\IdNotFoundException
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\ActionNotFoundException
* @param Request $request Current request
* @param Response $response Current response
*/
@ -309,8 +309,8 @@
/**
* Load the Components of this Controller.
*
* @throws ComponentNotValidException
* @throws ComponentNotFoundException
* @throws \nre\exceptions\ComponentNotValidException
* @throws \nre\exceptions\ComponentNotFoundException
*/
private function loadComponents()
{
@ -348,11 +348,11 @@
/**
* Load the Models of this Controller.
*
* @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
*/
protected function loadModels()
{
@ -405,7 +405,7 @@
/**
* Load the View of this Controller.
*
* @throws ViewNotFoundException
* @throws \nre\exceptions\ViewNotFoundException
* @param string $layoutName Name of the current Layout
* @param string $action Current Action
*/

4
core/Driver.inc
View file

@ -26,8 +26,8 @@
/**
* Load the class of a Driver.
*
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @param string $driverName Name of the Driver to load
*/
public static function load($driverName)

24
core/Model.inc
View file

@ -26,8 +26,8 @@
/**
* Load the class of a Model.
*
* @throws ModelNotFoundException
* @throws ModelNotValidException
* @throws \nre\exceptions\ModelNotFoundException
* @throws \nre\exceptions\ModelNotValidException
* @param string $modelName Name of the Model to load
*/
public static function load($modelName)
@ -88,11 +88,11 @@
*
* TODO Catch exception
*
* @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
*/
protected function __construct()
{
@ -106,11 +106,11 @@
/**
* Load the Models of this 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
*/
private function loadModels()
{

4
core/View.inc
View file

@ -34,7 +34,7 @@
/**
* Load and instantiate the View of an Agent.
*
* @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
@ -51,7 +51,7 @@
/**
* Construct a new View.
*
* @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