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

correct docstrings

Browse source
This commit is contained in:
coderkun 2015-03-06 11:09:35 +01:00
commit 01a9c81f81
78 changed files with 275 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

3
agents/IntermediateAgent.inc
View file

@ -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)
{

2
agents/ToplevelAgent.inc
View file

@ -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)

3
agents/bottomlevel/MailreceiverAgent.inc
View file

@ -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)
{

3
agents/bottomlevel/MenuAgent.inc
View file

@ -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)
{

3
agents/bottomlevel/QuestgroupshierarchypathAgent.inc
View file

@ -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)
{

3
agents/bottomlevel/SeminarybarAgent.inc
View file

@ -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)
{

3
agents/bottomlevel/SeminarymenuAgent.inc
View file

@ -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)
{

3
agents/bottomlevel/UserrolesAgent.inc
View file

@ -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)
{

3
agents/intermediate/AchievementsAgent.inc
View file

@ -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)
{

3
agents/intermediate/CharactergroupsAgent.inc
View file

@ -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)
{

3
agents/intermediate/CharactergroupsquestsAgent.inc
View file

@ -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)
{

6
agents/intermediate/CharactersAgent.inc
View file

@ -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)
{

3
agents/intermediate/CharactertypesAgent.inc
View file

@ -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)
{

3
agents/intermediate/ErrorAgent.inc
View file

@ -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)
{

3
agents/intermediate/IntroductionAgent.inc
View file

@ -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)
{

3
agents/intermediate/LibraryAgent.inc
View file

@ -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)
{

3
agents/intermediate/MailAgent.inc
View file

@ -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)
{

3
agents/intermediate/MediaAgent.inc
View file

@ -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)
{

12
agents/intermediate/QuestgroupsAgent.inc
View file

@ -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)
{

24
agents/intermediate/QuestsAgent.inc
View file

@ -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)
{

3
agents/intermediate/SeminariesAgent.inc
View file

@ -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)
{

3
agents/intermediate/UploadsAgent.inc
View file

@ -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)
{

6
agents/intermediate/UsersAgent.inc
View file

@ -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)
{

3
agents/intermediate/XplevelsAgent.inc
View file

@ -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)
{

15
agents/toplevel/AjaxAgent.inc
View file

@ -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

10
agents/toplevel/BinaryAgent.inc
View file

@ -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)
{

3
agents/toplevel/FaultAgent.inc
View file

@ -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)
{

15
agents/toplevel/HtmlAgent.inc
View file

@ -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

7
agents/toplevel/HtmlmailAgent.inc
View file

@ -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)
{

7
agents/toplevel/TextmailAgent.inc
View file

@ -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)
{

2
apis/WebApi.inc
View file

@ -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)
{

6
app/Utils.inc
View file

@ -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)
{

4
app/agents/QuesttypeAgent.inc
View file

@ -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)

7
app/agents/ToplevelAgent.inc
View file

@ -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);

4
app/apis/MailApi.inc
View file

@ -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)
{

2
app/controllers/IntermediateController.inc
View file

@ -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)
{

1
app/controllers/QuesttypeController.inc
View file

@ -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)
{

6
app/controllers/SeminaryController.inc
View file

@ -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)
{

4
app/exceptions/FileUploadException.inc
View file

@ -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)
{

4
app/exceptions/MailingException.inc
View file

@ -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)
{

3
app/exceptions/MaxFilesizeException.inc
View file

@ -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)
{

2
app/exceptions/QuesttypeAgentNotFoundException.inc
View file

@ -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)
{

2
app/exceptions/QuesttypeAgentNotValidException.inc
View file

@ -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)
{

2
app/exceptions/QuesttypeControllerNotFoundException.inc
View file

@ -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)
{

2
app/exceptions/QuesttypeControllerNotValidException.inc
View file

@ -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)
{

2
app/exceptions/QuesttypeModelNotFoundException.inc
View file

@ -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)
{

2
app/exceptions/QuesttypeModelNotValidException.inc
View file

@ -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)
{

2
app/exceptions/SubmissionNotValidException.inc
View file

@ -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)
{

4
app/exceptions/WrongFiletypeException.inc
View file

@ -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)
{

1
controllers/CharactersController.inc
View file

@ -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)
{

3
controllers/MailController.inc
View file

@ -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)
{

2
controllers/MailreceiverController.inc
View file

@ -26,6 +26,8 @@
/**
* Action: index.
*
* @param $array $user User receiving mail
*/
public function index($user)
{

40
controllers/QuestsController.inc
View file

@ -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);
}
/**

1
controllers/UploadsController.inc
View file

@ -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)
{

2
controllers/UsersController.inc
View file

@ -49,6 +49,8 @@
/**
* Action: index.
*
* @param string $all Whether to list all users at once or not (optional)
*/
public function index($all=null)
{

7
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)
@ -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
*/

1
core/Controller.inc
View file

@ -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)
{

1
core/Driver.inc
View file

@ -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)
{

2
core/Linker.inc
View file

@ -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)

2
exceptions/ClassNotFoundException.inc
View file

@ -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)
{

2
exceptions/ClassNotValidException.inc
View file

@ -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)
{

8
models/AchievementsModel.inc
View file

@ -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)

1
models/CharactergroupsModel.inc
View file

@ -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')

9
models/CharactersModel.inc
View file

@ -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

2
models/QuestgroupsModel.inc
View file

@ -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.

3
models/QuestgroupshierarchyModel.inc
View file

@ -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
*/

2
models/QuestsModel.inc
View file

@ -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

7
models/QuesttextsModel.inc
View file

@ -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) {

2
models/SeminariesModel.inc
View file

@ -106,7 +106,7 @@
}
/*
/**
* Calculate sum of XPs for a Seminary.
*
* @param int $seminaryId ID of Seminary

1
models/SeminarycharacterfieldsModel.inc
View file

@ -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
*/

5
models/UsersModel.inc
View file

@ -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)
{

1
questtypes/bossfight/BossfightQuesttypeController.inc
View file

@ -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)

1
questtypes/choiceinput/ChoiceinputQuesttypeController.inc
View file

@ -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)

1
questtypes/crossword/CrosswordQuesttypeController.inc
View file

@ -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)

1
questtypes/dragndrop/DragndropQuesttypeController.inc
View file

@ -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)

1
questtypes/multiplechoice/MultiplechoiceQuesttypeController.inc
View file

@ -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)

2
questtypes/submit/SubmitQuesttypeModel.inc
View file

@ -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)
{

1
questtypes/textinput/TextinputQuesttypeController.inc
View file

@ -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)