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

add namespaces to docstrings

Browse source
This commit is contained in:
coderkun 2015-04-25 14:09:46 +02:00
parent a93ccec024
commit a4487a1028
16 changed files with 169 additions and 169 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
agents/IntermediateAgent.inc
View file

@ -27,7 +27,7 @@
/**
* Get the layout if it was explicitly defined.
*
* @param string $agentName Name of Agent to get Layout for
* @param string $agentName Agent name
* @return string Layout of the IntermediateAgent
*/
public static function getLayout($agentName)

80
agents/ToplevelAgent.inc
View file

@ -36,19 +36,19 @@
/**
* Current request
*
* @var Request
* @var \nre\core\Request
*/
private $request;
/**
* Current response
*
* @var Response
* @var \nre\core\Response
*/
private $response;
/**
* Layout instace
*
* @var Layout
* @var \nre\core\Layout
*/
private $layout = null;
/**
@ -64,18 +64,18 @@
/**
* Construct a ToplevelAgent.
*
* @throws ServiceUnavailableException
* @throws DatamodelException
* @throws DriverNotValidException
* @throws DriverNotFoundException
* @throws ViewNotFoundException
* @throws ModelNotValidException
* @throws ModelNotFoundException
* @throws ControllerNotValidException
* @throws ControllerNotFoundException
* @param Request $request Current request
* @param Response $response Current response
* @param Logger $log Log-system
* @throws \nre\exceptions\ServiceUnavailableException
* @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 \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)
{
@ -106,10 +106,10 @@
/**
* Run the Controller of this Agent and its SubAgents.
*
* @throws ServiceUnavailableException
* @param Request $request Current request
* @param Response $response Current response
* @return Exception Last occurred exception of SubAgents
* @throws \nre\exceptions\ServiceUnavailableException
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
* @return \Exception Last occurred exception of SubAgents
*/
public function run(\nre\core\Request $request, \nre\core\Response $response)
{
@ -156,7 +156,7 @@
/**
* Return the IntermediateAgent.
*
* @return IntermediateAgent IntermediateAgent
* @return \nre\agents\IntermediateAgent IntermediateAgent
*/
public function getIntermediateAgent()
{
@ -169,10 +169,10 @@
/**
* Load a SubAgent and add it.
*
* @throws ServiceUnavailableException
* @throws FatalDatamodelException
* @throws AgentNotFoundException
* @throws AgentNotValidException
* @throws \nre\exceptions\ServiceUnavailableException
* @throws \nre\exceptions\FatalDatamodelException
* @throws \nre\exceptions\AgentNotFoundException
* @throws \nre\exceptions\AgentNotValidException
* @param string $agentName Name of the Agent to load
* @param mixed … Additional parameters for the agent
*/
@ -198,7 +198,7 @@
/**
* Load IntermediateAgent defined by the current request.
*
* @throws ServiceUnavailableException
* @throws \nre\exceptions\ServiceUnavailableException
*/
private function loadIntermediateAgent()
{
@ -241,7 +241,7 @@
/**
* Load IntermediateAgent defined by the current request.
*
* @throws ServiceUnavailableException
* @throws \nre\exceptions\ServiceUnavailableException
*/
private function _loadIntermediateAgent()
{
@ -276,13 +276,13 @@
/**
* Run the Controller of this Agent and its SubAgents.
*
* @throws AccessDeniedException
* @throws IdNotFoundException
* @throws ServiceUnavailableException
* @throws DatamodelException
* @param Request $request Current request
* @param Response $response Current response
* @return Exception Last occurred exception of SubAgents
* @throws \nre\exceptions\AccessDeniedException
* @throws \nre\exceptions\IdNotFoundException
* @throws \nre\exceptions\ServiceUnavailableException
* @throws \nre\exceptions\DatamodelException
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
* @return \Exception Last occurred exception of SubAgents
*/
private function _run(\nre\core\Request $request, \nre\core\Response $response)
{
@ -304,11 +304,11 @@
/**
* Run IntermediateAgent.
*
* @throws AccessDeniedException
* @throws ParamsNotValidException
* @throws IdNotFoundException
* @throws ServiceUnavailableException
* @throws DatamodelException
* @throws \nre\exceptions\AccessDeniedException
* @throws \nre\exceptions\ParamsNotValidException
* @throws \nre\exceptions\IdNotFoundException
* @throws \nre\exceptions\ServiceUnavailableException
* @throws \nre\exceptions\DatamodelException
*/
private function runIntermediateAgent()
{
@ -323,8 +323,8 @@
* Handle an error that occurred during
* loading/cnostructing/running of the IntermediateAgent.
*
* @throws ServiceUnavailableException
* @param Exception $exception Occurred exception
* @throws \nre\exceptions\ServiceUnavailableException
* @param \Exception $exception Occurred exception
* @param int $httpStatusCode HTTP-statuscode
* @param string $stage Stage of execution
*/

2
apis/WebApi.inc
View file

@ -156,7 +156,7 @@
* Handle an error that orrcurred during the
* loading/constructing/running of the ToplevelAgent.
*
* @param Exception $exception Occurred exception
* @param \Exception $exception Occurred exception
* @param int $httpStatusCode HTTP-statuscode
*/
private function error(\nre\core\Exception $exception, $httpStatusCode)

90
core/Agent.inc
View file

@ -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)
@ -97,17 +97,17 @@
* 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 $response Current response
* @param Response $respone Current respone
* @param Logger $log Log-system
*/
public static function factory($agentName, Request $request, Response $response, Logger $log=null)
@ -156,16 +156,16 @@
/**
* 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 $response Current response
* @param Response $respone Current response
* @param Logger $log Log-system
*/
protected function __construct(Request $request, Response $response, Logger $log=null)
@ -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
*/
@ -500,9 +500,9 @@
/**
* Handle the exception of a SubAgent.
*
* @param Agent $subAgent SubAgent to handle error of
* @param array $subAgent Original (Sub-) Agent
* @param Request $request Current request
* @param Exception $exception Occurred exception
* @param Excepiton $exception Occurred exception
* @return array InlineError-SubAgent
*/
private function errorInline($subAgent, $request, $exception)
@ -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()
{

6
core/ClassLoader.inc
View file

@ -26,8 +26,8 @@
/**
* Load a class.
*
* @throws ClassNotFoundException
* @param string $fullClassName Name of the class to load
* @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)

52
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,16 +84,16 @@
/**
* 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
* @param string $agent Name of Agent
* @param string $agent Corresponding Agent
*/
public static function factory($controllerName, $layoutName, $action, $agent)
{
@ -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
*/

6
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)
@ -55,7 +55,7 @@
* Instantiate a Driver (Factory Pattern).
*
* @param string $driverName Name of the Driver to instantiate
* @param mixed $config Driver configuration
* @param array $config Configuration settings
*/
public static function factory($driverName, $config)
{

12
core/Linker.inc
View file

@ -22,7 +22,7 @@
/**
* Current request
*
* @var Request
* @var \nre\core\Request
*/
private $request;
@ -32,7 +32,7 @@
/**
* Construct a new linker.
*
* @param Request $request Current request
* @param \nre\core\Request $request Current request
*/
function __construct(\nre\requests\WebRequest $request)
{
@ -213,10 +213,10 @@
/**
* Create a link.
*
* @param Request $request Current request
* @param Response $response Current response
* @param bool $absolute Create absolute link
* @param \nre\core\Request $request Current request
* @param \nre\core\Response $response Current response
* @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)
@ -276,7 +276,7 @@
* Adapt a link to the environment.
*
* @param string $url URL
* @param Request $request Current request
* @param \nre\core\Request $request Current request
* @param bool $absolute Create absolute URL
* @return string Adapted URL
*/

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

2
drivers/DatabaseDriver.inc
View file

@ -77,7 +77,7 @@
/**
* Establish a connect to a MqSQL-database.
*
* @throws DatamodelException
* @throws \nre\exceptions\DatamodelException
* @param array $config Connection and login settings
*/
protected abstract function connect($config);

6
drivers/MysqliDriver.inc
View file

@ -26,7 +26,7 @@
/**
* Construct a MySQL-driver.
*
* @throws DatamodelException
* @throws \nre\exceptions\DatamodelException
* @param array $config Connection and login settings
*/
function __construct($config)
@ -40,7 +40,7 @@
/**
* Execute a SQL-query.
*
* @throws DatamodelException
* @throws \nre\exceptions\DatamodelException
* @param string $query Query to run
* @param mixed … Params
* @return array Result
@ -135,7 +135,7 @@
/**
* Establish a connect to a MqSQL-database.
*
* @throws DatamodelException
* @throws \nre\exceptions\DatamodelException
* @param array $config Connection and login settings
*/
protected function connect($config)

4
exceptions/ServiceUnavailableException.inc
View file

@ -45,7 +45,7 @@
/**
* Construct a new exception.
*
* @param Exception $exception Exception that has occurred
* @param \Exception $exception Exception that has occurred
*/
function __construct($exception)
{
@ -65,7 +65,7 @@
/**
* Get the exception that hat occurred
*
* @return Exception Exception that has occurred
* @return \Exception Exception that has occurred
*/
public function getException()
{

12
models/DatabaseModel.inc
View file

@ -33,9 +33,9 @@
/**
* Construct a new datamase model.
*
* @throws DatamodelException
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @param string $type Database type
* @param array $config Connection settings
*/
@ -56,8 +56,8 @@
/**
* Load the database driver.
*
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @param string $driverName Name of the database driver
*/
private function loadDriver($driverName)
@ -69,7 +69,7 @@
/**
* Establish a connection to the database.
*
* @throws DatamodelException
* @throws \nre\exceptions\DatamodelException
* @param string $driverName Name of the database driver
* @param array $config Connection settings
*/