correct docstrings
This commit is contained in:
parent
daa33a8f4b
commit
01a9c81f81
78 changed files with 275 additions and 62 deletions
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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);
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue