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

fix many docstrings and their formatting

Browse source
This commit is contained in:
oliver 2016-05-28 12:30:53 +02:00
parent e50c2bb5e6
commit 7085de8fe2
36 changed files with 679 additions and 659 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
app/agents/StationtypeAgent.inc
View file

@ -199,12 +199,12 @@
/**
* Save the answer of a Character group for a Station.
*
* @param array $seminary Current Seminary data
* @param array $questgroup Current Questgroup data
* @param array $quest Current Quest data
* @param array $station Current Station data
* @param array $group Current Character data
* @param array $answers Character answers for the Quest
* @param array $seminary Current Seminary data
* @param array $groupsgroup Current Groups group data
* @param array $quest Current Quest data
* @param array $station Current Station data
* @param array $charactergroup Current Character group data
* @param array $answer Character group answer for the Station
*/
public function saveAnswer($seminary, $groupsgroup, $quest, $station, $group, $answer)
{
@ -223,12 +223,12 @@
* Check if the answer of a Character group for a Station matches the
* correct one.
*
* @param array $seminary Current Seminary data
* @param array $questgroup Current Questgroup data
* @param array $quest Current Quest data
* @param array $station Current Station data
* @param array $group Current Character group data
* @param array $answers Character answers for the Quest
* @param array $seminary Current Seminary data
* @param array $groupsgroup Current Groups group data
* @param array $quest Current Quest data
* @param array $station Current Station data
* @param array $charactergroup Current Character group data
* @param array $answer Character group answer for the Station
*/
public function matchAnswer($seminary, $groupsgroup, $quest, $station, $group, $answer)
{

4
controllers/CharactergroupsqueststationsController.inc
View file

@ -996,7 +996,7 @@
*
* @param string $stationtypeClassname Name of the class for the Stationtype of a Station
* @param array $seminary Seminary data
* @param array $questgroup Questgroup data
* @param array $groupsgroup Groups-group data
* @param array $quest Quest data
* @param array $station Station data
* @param array $charactergroup Charactergroup data
@ -1164,7 +1164,7 @@
* Create a response for the Stationtype rendering.
*
* @param string $action Action to run
* @param mixed $param Additional parameters to add to the response
* @param mixed $param1 Additional parameters to add to the response
* @return \nre\core\Response Generated response
*/
private function createStationtypeResponse($action, $param1)

12
controllers/LibraryController.inc
View file

@ -67,7 +67,7 @@
* List Questtopics of a Seminary.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary
* @param string $seminaryUrl URL-Title of Seminary
*/
public function index($seminaryUrl)
{
@ -111,7 +111,7 @@
* Show a Questtopic and its Quests with Questsubtopics.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $eminaryUrl URL-Title of Seminary
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questtopicUrl URL-Title of Questtopic
*/
public function topic($seminaryUrl, $questtopicUrl)
@ -159,7 +159,7 @@
* Manage a Questtopic and its Quests with Questsubtopics.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $eminaryUrl URL-Title of Seminary
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questtopicUrl URL-Title of Questtopic
*/
public function manage($seminaryUrl, $questtopicUrl)
@ -233,7 +233,7 @@
* Create a new Questtopic for a Seminary.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary
* @param string $seminaryUrl URL-Title of Seminary
*/
public function create($seminaryUrl)
{
@ -296,7 +296,7 @@
* Edit a Questtopic of a Seminary and its Questsubtopics.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $eminaryUrl URL-Title of Seminary
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questtopicUrl URL-Title of Questtopic
*/
public function edit($seminaryUrl, $questtopicUrl)
@ -472,7 +472,7 @@
* Delete a Questtopic of a Seminary.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $eminaryUrl URL-Title of Seminary
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questtopicUrl URL-Title of Questtopic
*/
public function delete($seminaryUrl, $questtopicUrl)

2
controllers/MailController.inc
View file

@ -45,7 +45,7 @@
* Generate a mail message to notify of a new user registration.
*
* @param array $receiver User that the message will be send to
* @param array $neUser Newly registered user
* @param array $newUser Newly registered user
*/
public function userregistration($receiver, $newUser)
{

2
controllers/MailreceiverController.inc
View file

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

22
controllers/MediaController.inc
View file

@ -117,8 +117,8 @@
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-title of the Seminary
* @param string $category Category to show moodpic of
* @param string $action Action for processing the media
* @param string $category Category to show moodpic of
* @param string $action Action for processing the media
*/
public function seminarymoodpic($seminaryUrl, $category=null, $action=null)
{
@ -209,8 +209,8 @@
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-title of the Seminary
* @param string $mediaUrl URL-name of the medium
* @param string $action Action for processing the media
* @param string $mediaUrl URL-name of the medium
* @param string $action Action for processing the media
*/
public function seminary($seminaryUrl, $mediaUrl, $action=null)
{
@ -250,8 +250,8 @@
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-title of the Seminary
* @param string $charactertypeUrl URL-title of Character type
* @param int $xplevel XP-level
* @param string $action Size to show (avatar or portrait)
* @param int $xplevel XP-level
* @param string $action Size to show (avatar or portrait)
*/
public function avatar($seminaryUrl, $charactertypeUrl, $xplevel, $action='avatar')
{
@ -301,7 +301,7 @@
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-title of the Seminary
* @param string $achievementUrl URL-title of the Achievement
* @param string $action Action for processing the media
* @param string $locked Whether to display the locked version or not
*/
public function achievement($seminaryUrl, $achievementUrl, $locked=null)
{
@ -358,7 +358,7 @@
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of a Seminary
* @param string $groupsgroupUrl URL-Title of a Character groups-group
* @param string $groupUrl URL-Title of a Character group
* @param string $groupUrl URL-Title of a Character group
*/
public function charactergroup($seminaryUrl, $groupsgroupUrl, $groupUrl)
{
@ -403,7 +403,7 @@
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of a Seminary
* @param string $groupsgroupUrl URL-Title of a Character groups-group
* @param string $questUrl URL-Title of a Character groups Quest
* @param string $questUrl URL-Title of a Character groups Quest
*/
public function charactergroupsquest($seminaryUrl, $groupsgroupUrl, $questUrl)
{
@ -530,7 +530,7 @@
* @param string $seminaryUrl URL-title of Seminary
* @param string $groupsgroupUrl URL-title of Character groups-group
* @param string $achievementUrl URL-title of the Achievement
* @param string $action Action for processing the media
* @param string $locked Whether to show the locked version or not
*/
public function charactergroupsachievement($seminaryUrl, $groupsgroupUrl, $achievementUrl, $locked=null)
{
@ -573,7 +573,7 @@
* caching accordingly.
*
* @param string $fileName Filename
* @return boolean HTTP-status 304 was set (in cache)
* @return boolean HTTP-status 304 was set (in cache)
*/
private function setCacheHeaders($fileName)
{

3
controllers/MoodpicController.inc
View file

@ -47,6 +47,7 @@
* Show moodpic of a Seminary.
*
* @param string $seminaryUrl URL of Seminary to show moodpic of
* @param string $agentName Name of Agent to show moodpic for
*/
public function seminary($seminaryUrl, $agentName=null)
{
@ -86,7 +87,7 @@
* Show moodpic of a Questgroup.
*
* @param string $seminaryUrl URL of Seminary
* @param string $quesgroupUrl URL of Questgroup to show moodpic of
* @param string $questgroupUrl URL of Questgroup to show moodpic of
*/
public function questgroup($seminaryUrl, $questgroupUrl)
{

21
controllers/QrcodesController.inc
View file

@ -53,8 +53,8 @@
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of a Seminary
* @param string $groupsgroupUrl URL-Title of a Character groups-group
* @param string $achievementUrl URL of Achievement
* @param int $size QR-code size
*/
public function achievement($seminaryUrl, $achievementUrl, $size=1)
{
@ -129,6 +129,7 @@
* @param string $groupsgroupUrl URL-Title of a Character groups-group
* @param string $questUrl URL-Title of a Character groups Quest
* @param string $stationUrl URL of Character groups Quest station
* @param int $size QR-code size
*/
public function charactergroupsqueststation($seminaryUrl, $groupsgroupUrl, $questUrl, $stationUrl, $size=1)
{
@ -166,6 +167,7 @@
* @param string $seminaryUrl URL-Title of a Seminary
* @param string $groupsgroupUrl URL-Title of a Character groups-group
* @param string $achievementUrl URL of Achievement
* @param int $size QR-code size
*/
public function charactergroupsachievements($seminaryUrl, $groupsgroupUrl, $achievementUrl, $size=1)
{
@ -201,7 +203,7 @@
* caching accordingly.
*
* @param string $fileName Filename
* @return boolean HTTP-status 304 was set (in cache)
* @return boolean HTTP-status 304 was set (in cache)
*/
private function setCacheHeaders($fileName)
{
@ -233,6 +235,13 @@
}
/**
* Generate QR-code with given text and in given size.
*
* @param string $text QR-code content
* @param int $size QR-code size
* @return mixed Null
*/
private function generateQRcode($text, $size)
{
\hhu\z\lib\Phpqrcode::load();
@ -250,7 +259,7 @@
* @throws \nre\exceptions\ParamsNotValidException
* @param array $media Medium to get file for
* @param string $action Action for processing the media
* @return object File for the medium (or null if medium is cached)
* @return object File for the medium (or null if medium is cached)
*/
private function getMediaFile($media, $action=null)
{
@ -327,9 +336,9 @@
*
* @param string $fileName Absolute pathname of image to resize
* @param string $mimeType Mimetype of target image
* @param int $width Max. width to resize to
* @param int $height Max. height to resize to
* @return mixed Resized image
* @param int $width Max. width to resize to
* @param int $height Max. height to resize to
* @return mixed Resized image
*/
private static function resizeImage($fileName, $mimeType, $width, $height)
{

74
controllers/QuestsController.inc
View file

@ -88,7 +88,7 @@
* List all Quests for a Seminary.
*
* @param string $seminaryUrl URL-Title of Seminary
* @param string $all Show all Quests
* @param string $all Show all Quests
*/
public function index($seminaryUrl, $all=null)
{
@ -155,9 +155,9 @@
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup
* @param string $questUrl URL-Title of Quest
* @param string $questUrl URL-Title of Quest
* @param string $questtexttypeUrl URL-Title of Questtexttype
* @param int $questtextPos Position of Questtext
* @param int $questtextPos Position of Questtext
*/
public function quest($seminaryUrl, $questgroupUrl, $questUrl, $questtexttypeUrl=null, $questtextPos=1)
{
@ -366,7 +366,7 @@
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup
* @param string $questUrl URL-Title of Quest
* @param string $questUrl URL-Title of Quest
*/
public function submissions($seminaryUrl, $questgroupUrl, $questUrl)
{
@ -414,7 +414,7 @@
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup
* @param string $questUrl URL-Title of Quest
* @param string $questUrl URL-Title of Quest
* @param string $characterUrl URL-Title of Character
*/
public function submission($seminaryUrl, $questgroupUrl, $questUrl, $characterUrl)
@ -616,8 +616,8 @@
* Edit a Quest of a Seminary.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup
* @param string $questUrl URL-Title of Quest
*/
public function edit($seminaryUrl, $questgroupUrl, $questUrl)
@ -790,8 +790,8 @@
* Edit the task of a Quest of a Seminary.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup
* @param string $questUrl URL-Title of Quest
*/
public function edittask($seminaryUrl, $questgroupUrl, $questUrl)
@ -833,8 +833,8 @@
* Edit the texts of a Quest of a Seminary.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup
* @param string $questUrl URL-Title of Quest
*/
public function edittexts($seminaryUrl, $questgroupUrl, $questUrl)
@ -1058,8 +1058,8 @@
* Delete a Quest of a Seminary.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup
* @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup
* @param string $questUrl URL-Title of Quest
*/
public function delete($seminaryUrl, $questgroupUrl, $questUrl)
@ -1112,11 +1112,11 @@
* Render and handle the task of a Quest.
*
* @param string $questtypeClassname Name of the class for the Questtype of a Quest
* @param array $seminary Seminary data
* @param array $questgroup Questgroup data
* @param array $quest Quest data
* @param array $character Character data
* @return string Rendered output
* @param array $seminary Seminary data
* @param array $questgroup Questgroup data
* @param array $quest Quest data
* @param array $character Character data
* @return string Rendered output
*/
private function renderTask($questtypeClassname, $seminary, $questgroup, $quest, $character)
{
@ -1223,11 +1223,11 @@
* Render and handle a Character submission for a Quest.
*
* @param string $questtypeClassname Name of the class for the Questtype of a Quest
* @param array $seminary Seminary data
* @param array $questgroup Questgroup data
* @param array $quest Quest data
* @param array $character Character data
* @return string Rendered output
* @param array $seminary Seminary data
* @param array $questgroup Questgroup data
* @param array $quest Quest data
* @param array $character Character data
* @return string Rendered output
*/
private function renderTaskSubmission($questtypeClassname, $seminary, $questgroup, $quest, $character)
{
@ -1303,10 +1303,10 @@
* Render editing of a Quest.
*
* @param string $questtypeClassname Name of the class for the Questtype of a Quest
* @param array $seminary Seminary data
* @param array $questgroup Questgroup data
* @param array $quest Quest data
* @return string Rendered output
* @param array $seminary Seminary data
* @param array $questgroup Questgroup data
* @param array $quest Quest data
* @return string Rendered output
*/
private function renderTaskEditing($questtypeClassname, $seminary, $questgroup, $quest)
{
@ -1356,9 +1356,9 @@
/**
* Create a response for the Questtype rendering.
*
* @param string $action Action to run
* @param mixed $param Additional parameters to add to the response
* @return \nre\core\Response Generated response
* @param string $action Action to run
* @param mixed $param1 Additional parameters to add to the response
* @return \nre\core\Response Generated response
*/
private function createQuesttypeResponse($action, $param1)
{
@ -1387,10 +1387,10 @@
/**
* Load and construct the QuesttypeAgent for a Questtype.
*
* @param string $questtypeClassname Name of the class for the Questtype of a Quest
* @param \nre\core\Request $request Request
* @param \nre\core\Response $response Response
* @return \hhu\z\agents\QuesttypeAgent Questtype Agent
* @param string $questtypeClassname Name of the class for the Questtype of a Quest
* @param \nre\core\Request $request Request
* @param \nre\core\Response $response Response
* @return \hhu\z\agents\QuesttypeAgent Questtype Agent
*/
private function loadQuesttypeAgent($questtypeClassname, $request, $response)
{
@ -1407,9 +1407,9 @@
* Run and render the Agent for a QuesttypeAgent and return ist output.
*
* @param \nre\core\Agent $questtypeAgent QuesttypeAgent to run and render
* @param \nre\core\Request $request Request
* @param \nre\core\Response $response Response
* @return string Rendered output
* @param \nre\core\Request $request Request
* @param \nre\core\Response $response Response
* @return string Rendered output
*/
private function runQuesttypeAgent($questtypeAgent, $request, $response)
{

12
controllers/components/ValidationComponent.inc
View file

@ -46,7 +46,7 @@
*
* @param mixed $input User input to validate
* @param array $settings Validation setting
* @return mixed True or the settings the validation fails on
* @return mixed True or the settings the validation fails on
*/
public function validate($input, $settings)
{
@ -80,7 +80,7 @@
*
* @param array $params User input parameters
* @param array $index Names of parameter to validate and to validate against
* @return mixed True or the parameter with settings the validation failed on
* @return mixed True or the parameter with settings the validation failed on
*/
public function validateParam($params, $index)
{
@ -104,7 +104,7 @@
*
* @param array $params User input parameters
* @param array $indices Names of parameters to validate and to validate against
* @return mixed True or the parameters with settings the validation failed on
* @return mixed True or the parameters with settings the validation failed on
*/
public function validateParams($params, $indices)
{
@ -128,7 +128,7 @@
* @param string $index Name of parameter of the custom validation result
* @param string $setting Name of setting of the custom validation result
* @param mixed $result Validation result
* @return mixed The altered validation array
* @return mixed The altered validation array
*/
public function addValidationResult($validation, $index, $setting, $result)
{
@ -155,8 +155,8 @@
*
* @param mixed $validation Validation array to add result to
* @param string $index Name of parameter of the custom validation result
* @param mixed $result Validation result
* @return mixed The altered validation array
* @param mixed $results Validation result
* @return mixed The altered validation array
*/
public function addValidationResults($validation, $index, $results)
{

274
models/AchievementsModel.inc
View file

@ -43,9 +43,9 @@
/**
* Get an Achievement by its URL.
*
* @param int $seminaryId ID of Seminary
* @param int $seminaryId ID of Seminary
* @param string $achievementUrl URL-title of Achievement
* @return array Achievement data
* @return array Achievement data
*/
public function getAchievementByUrl($seminaryId, $achievementUrl)
{
@ -69,8 +69,8 @@
/**
* Get an Achievement by its ID.
*
* @param int $achievementId ID of Achievement
* @return array Achievement data
* @param int $achievementId ID of Achievement
* @return array Achievement data
*/
public function getAchievementById($achievementId)
{
@ -95,8 +95,8 @@
* Get all not yet achieved Achievements for a Seminary that can
* only be achieved once (only by one Character).
*
* @param int $seminaryId ID of Seminary
* @return array Achievements data
* @param int $seminaryId ID of Seminary
* @return array Achievements data
*/
public function getUnachievedOnlyOnceAchievementsForSeminary($seminaryId)
{
@ -118,8 +118,8 @@
/**
* Get all Achievements that have a deadline.
*
* @param int $seminaryId ID of Seminary
* @return array Achievements data
* @param int $seminaryId ID of Seminary
* @return array Achievements data
*/
public function getDeadlineAchievements($seminaryId)
{
@ -138,10 +138,10 @@
/**
* Get seldom Achievements.
*
* @param int $seminaryId ID of Seminary
* @param int $count Number of Achievements to retrieve
* @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
* @return array List of seldom Achievements
*/
public function getSeldomAchievements($seminaryId, $count, $alsoWithDeadline=true)
{
@ -167,9 +167,9 @@
/**
* Get all achieved Achievements for a Character.
*
* @param int $characterId ID of Character
* @param int $characterId ID of Character
* @param bool $alsoWithDeadline Include Achievements with deadline (optional)
* @return array Achievements data
* @return array Achievements data
*/
public function getAchievedAchievementsForCharacter($characterId, $alsoWithDeadline=true)
{
@ -189,11 +189,11 @@
/**
* Get all not yet achieved Achievements for a Character.
*
* @param int $seminaryId ID of Seminary
* @param int $characterId ID of Character
* @param int $seminaryId ID of Seminary
* @param int $characterId ID of Character
* @param boolean $includeOnlyOnce Include Achievements that can only be achieved by one Character
* @param boolean $alsoWithDeadline Include milestone Achievements
* @return array Achievements data
* @return array Achievements data
*/
public function getUnachhievedAchievementsForCharacter($seminaryId, $characterId, $includeOnlyOnce=false, $alsoWithDeadline=true)
{
@ -221,10 +221,10 @@
/**
* Get the amount of Achievement for a Seminary.
*
* @param int $seminaryId ID of Seminary
* @param int $seminaryId ID of Seminary
* @param boolean $includeOnlyOnce Include Achievements that can only be achieved by one Character
* @param boolean $alsoWithDeadline Include milestone Achievements
* @return int Count of Achievements
* @return int Count of Achievements
*/
public function getAchievementsCountForSeminary($seminaryId, $includeOnlyOnce=false, $alsoWithDeadline=true)
{
@ -249,8 +249,8 @@
/**
* Get all Achievements for a Seminary.
*
* @param int $seminaryId ID of Seminary
* @return array List of Achievements
* @param int $seminaryId ID of Seminary
* @return array List of Achievements
*/
public function getAchievementsForSeminary($seminaryId)
{
@ -270,8 +270,8 @@
* Get the rank for the number of achieved Achievements.
*
* @param int $seminaryId ID of Seminary
* @param int $xps Amount of achieved Achievements
* @return int Rank of Achievements count
* @param int $count Amount of achieved Achievements
* @return int Rank of Achievements count
*/
public function getCountRank($seminaryId, $count)
{
@ -301,8 +301,8 @@
/**
* Get all date conditions for an Achievement.
*
* @param int $achievementId ID of Achievement
* @return array Date conditions
* @param int $achievementId ID of Achievement
* @return array Date conditions
*/
public function getAchievementConditionsDate($achievementId)
{
@ -319,7 +319,7 @@
/**
* Check a date condition.
*
* @param string $select SELECT-string with date-functions
* @param string $select SELECT-string with date-functions
* @return boolean Result
*/
public function checkAchievementConditionDate($select)
@ -339,9 +339,9 @@
/**
* Add a new date condition.
*
* @param int $userId ID of creating user
* @param int $achievementId ID of Achievement to add condition to
* @param string $select SELECT-string for condition
* @param int $userId ID of creating user
* @param int $achievementId ID of Achievement to add condition to
* @param string $select SELECT-string for condition
*/
public function addAchievementConditionDate($userId, $achievementId, $select)
{
@ -362,8 +362,8 @@
/**
* Edit a date condition.
*
* @param int $conditionId ID of condition to edit
* @param string $select New SELECT-string for condition
* @param int $conditionId ID of condition to edit
* @param string $select New SELECT-string for condition
*/
public function editAchievementConditionDate($conditionId, $select)
{
@ -414,8 +414,8 @@
/**
* Get all Character conditions for an Achievement.
*
* @param int $achievementId ID of Achievement
* @return array Character conditions
* @param int $achievementId ID of Achievement
* @return array Character conditions
*/
public function getAchievementConditionsCharacter($achievementId)
{
@ -432,10 +432,10 @@
/**
* Check a Character condition.
*
* @param string $field Field to check
* @param int $value The value the field has to match
* @param int $characterId ID of Character
* @return boolean Result
* @param string $field Field to check
* @param int $value The value the field has to match
* @param int $characterId ID of Character
* @return boolean Result
*/
public function checkAchievementConditionCharacter($field, $value, $characterId)
{
@ -470,10 +470,10 @@
/**
* Get the progress for a Character condition.
*
* @param string $field Field to check
* @param int $value The value the field has to match
* @param int $characterId ID of Character
* @return float Percentage progress
* @param string $field Field to check
* @param int $value The value the field has to match
* @param int $characterId ID of Character
* @return float Percentage progress
*/
public function getAchievementConditionCharacterProgress($field, $value, $characterId)
{
@ -505,10 +505,10 @@
/**
* Add a new Character condition.
*
* @param int $userId ID of creating user
* @param int $achievementId ID of Achievement to add condition to
* @param string $field Field to match
* @param string $value Value to match
* @param int $userId ID of creating user
* @param int $achievementId ID of Achievement to add condition to
* @param string $field Field to match
* @param string $value Value to match
*/
public function addAchievementConditionCharacter($userId, $achievementId, $field, $value)
{
@ -530,9 +530,9 @@
/**
* Edit a Character condition.
*
* @param int $conditionId ID of condition to edit
* @param string $field Field to match
* @param string $value Value to match
* @param int $conditionId ID of condition to edit
* @param string $field Field to match
* @param string $value Value to match
*/
public function editAchievementConditionCharacter($conditionId, $field, $value)
{
@ -584,8 +584,8 @@
/**
* Get all Quest conditions for an Achievement.
*
* @param int $achievementId ID of Achievement
* @return array Quest conditions
* @param int $achievementId ID of Achievement
* @return array Quest conditions
*/
public function getAchievementConditionsQuest($achievementId)
{
@ -602,14 +602,14 @@
/**
* Check a Quest condition.
*
* @param string $field Field to check
* @param boolean $count Conut field-value
* @param int $value The value the field has to match
* @param int $status Status of Quest or NULL
* @param string $groupby Field to group or NULL
* @param int $questId ID of related Quest or NULL
* @param int $characterId ID of Character
* @return boolean Result
* @param string $field Field to check
* @param boolean $count Conut field-value
* @param int $value The value the field has to match
* @param int $status Status of Quest or NULL
* @param string $groupby Field to group or NULL
* @param int $questId ID of related Quest or NULL
* @param int $characterId ID of Character
* @return boolean Result
*/
public function checkAchievementConditionQuest($field, $count, $value, $status, $groupby, $questId, $characterId)
{
@ -644,14 +644,14 @@
/**
* Get the progress for a Quest condition.
*
* @param string $field Field to check
* @param boolean $count Conut field-value
* @param int $value The value the field has to match
* @param int $status Status of Quest or NULL
* @param string $groupby Field to group or NULL
* @param int $questId ID of related Quest or NULL
* @param int $characterId ID of Character
* @return float Percentage progress
* @param string $field Field to check
* @param boolean $count Conut field-value
* @param int $value The value the field has to match
* @param int $status Status of Quest or NULL
* @param string $groupby Field to group or NULL
* @param int $questId ID of related Quest or NULL
* @param int $characterId ID of Character
* @return float Percentage progress
*/
public function getAchievementConditionQuestProgress($field, $count, $value, $status, $groupby, $questId, $characterId)
{
@ -688,14 +688,14 @@
/**
* Add a new Quest condition.
*
* @param int $userId ID of creating user
* @param int $achievementId ID of Achievement to add condition to
* @param string $field Field to match
* @param boolean $count Count the value
* @param string $value Value to match
* @param int $questId ID of Quest (optional)
* @param int $status Quest status (optional)
* @param string $groupby Field to group by (optional)
* @param int $userId ID of creating user
* @param int $achievementId ID of Achievement to add condition to
* @param string $field Field to match
* @param boolean $count Count the value
* @param string $value Value to match
* @param int $questId ID of Quest (optional)
* @param int $status Quest status (optional)
* @param string $groupby Field to group by (optional)
*/
public function addAchievementConditionQuest($userId, $achievementId, $field, $count, $value, $questId=null, $status=null, $groupby=null)
{
@ -721,13 +721,13 @@
/**
* Edit a Quest condition.
*
* @param int $conditionId ID of condition to edit
* @param string $field Field to match
* @param boolean $count Count the value
* @param string $value Value to match
* @param int $questId ID of Quest (optional)
* @param int $status Quest status (optional)
* @param string $groupby Field to group by (optional)
* @param int $conditionId ID of condition to edit
* @param string $field Field to match
* @param boolean $count Count the value
* @param string $value Value to match
* @param int $questId ID of Quest (optional)
* @param int $status Quest status (optional)
* @param string $groupby Field to group by (optional)
*/
public function editAchievementConditionQuest($conditionId, $field, $count, $value, $questId=null, $status=null, $groupby=null)
{
@ -807,8 +807,8 @@
/**
* Get all Metaachievement conditions for an Achievement.
*
* @param int $achievementId ID of Achievement
* @return array Metaachievement conditions
* @param int $achievementId ID of Achievement
* @return array Metaachievement conditions
*/
public function getAchievementConditionsAchievement($achievementId)
{
@ -825,13 +825,13 @@
/**
* Check a Metaachievement condition.
*
* @param string $field Field to check
* @param boolean $count Conut field-value
* @param int $value The value the field has to match
* @param string $groupby Field to group or NULL
* @param int $metaAchievementId ID of related Achievement or NULL
* @param int $characterId ID of Character
* @return boolean Result
* @param string $field Field to check
* @param boolean $count Conut field-value
* @param int $value The value the field has to match
* @param string $groupby Field to group or NULL
* @param int $metaAchievementId ID of related Achievement or NULL
* @param int $characterId ID of Character
* @return boolean Result
*/
public function checkAchievementConditionAchievement($field, $count, $value, $groupby, $metaAchievementId, $characterId)
{
@ -865,13 +865,13 @@
/**
* Get the progress for a Metaachievement condition.
*
* @param string $field Field to check
* @param boolean $count Conut field-value
* @param int $value The value the field has to match
* @param string $groupby Field to group or NULL
* @param int $metaAchievementId ID of related Achievement or NULL
* @param int $characterId ID of Character
* @return float Percentage progress
* @param string $field Field to check
* @param boolean $count Conut field-value
* @param int $value The value the field has to match
* @param string $groupby Field to group or NULL
* @param int $metaAchievementId ID of related Achievement or NULL
* @param int $characterId ID of Character
* @return float Percentage progress
*/
public function getAchievementConditionAchievementProgress($field, $count, $value, $groupby, $metaAchievementId, $characterId)
{
@ -907,13 +907,13 @@
/**
* Add a new Achievement condition.
*
* @param int $userId ID of creating user
* @param int $achievementId ID of Achievement to add condition to
* @param string $field Field to match
* @param boolean $count Count the value
* @param string $value Value to match
* @param int $metaAchievementId ID of Meta-Achievement (optional)
* @param string $groupby Field to group by (optional)
* @param int $userId ID of creating user
* @param int $achievementId ID of Achievement to add condition to
* @param string $field Field to match
* @param boolean $count Count the value
* @param string $value Value to match
* @param int $metaAchievementId ID of Meta-Achievement (optional)
* @param string $groupby Field to group by (optional)
*/
public function addAchievementConditionAchievement($userId, $achievementId, $field, $count, $value, $metaAchievementId=null, $groupby=null)
{
@ -938,12 +938,12 @@
/**
* Edit a Achievement condition.
*
* @param int $conditionId ID of condition to edit
* @param string $field Field to match
* @param boolean $count Count the value
* @param string $value Value to match
* @param int $metaAchievementId ID of Achievement (optional)
* @param string $groupby Field to group by (optional)
* @param int $conditionId ID of condition to edit
* @param string $field Field to match
* @param boolean $count Count the value
* @param string $value Value to match
* @param int $metaAchievementId ID of Achievement (optional)
* @param string $groupby Field to group by (optional)
*/
public function editAchievementConditionAchievement($conditionId, $field, $count, $value, $metaAchievementId=null, $groupby=null)
{
@ -1022,8 +1022,8 @@
/**
* Get all QR-code conditions for an Achievement.
*
* @param int $achievementId ID of Achievement
* @return array List of QR-code conditions
* @param int $achievementId ID of Achievement
* @return array List of QR-code conditions
*/
public function getAchievementConditionsQrcode($achievementId)
{
@ -1145,9 +1145,9 @@
/**
* Check if a Character has achieved an Achievement.
*
* @param int $achievementId ID of Achievement
* @param int $characterId ID of Character
* @return boolean Whether Character has achieved the Achievement or not
* @param int $achievementId ID of Achievement
* @param int $characterId ID of Character
* @return boolean Whether Character has achieved the Achievement or not
*/
public function hasCharacterAchievedAchievement($achievementId, $characterId)
{
@ -1184,10 +1184,10 @@
/**
* Check if an Achievement title already exists.
*
* @param int $seminaryId ID of Seminary
* @param string $title Achievement title to check
* @param int $characterId Do not check this ID (for editing)
* @return boolean Whether Achievement title exists or not
* @param int $seminaryId ID of Seminary
* @param string $title Achievement title to check
* @param int $achievementId Do not check this ID (for editing)
* @return boolean Whether Achievement title exists or not
*/
public function achievementTitleExists($seminaryId, $title, $achievementId=null)
{
@ -1209,17 +1209,17 @@
/**
* Create a new Achievement for a Seminary.
*
* @param int $userId ID of creating user
* @param int $seminaryId ID of Seminary
* @param int $conditionId ID of Achievement condition
* @param string $title Title of new Achievement
* @param int $userId ID of creating user
* @param int $seminaryId ID of Seminary
* @param int $conditionId ID of Achievement condition
* @param string $title Title of new Achievement
* @param string $description Description of new Achievement
* @param boolean $progress Show progress
* @param boolean $hidden Secret Achievement
* @param boolean $onlyOnce Only achieveable by one user
* @param boolean $progress Show progress
* @param boolean $hidden Secret Achievement
* @param boolean $onlyOnce Only achieveable by one user
* @param boolean $allConditions Achievement must match all conditions
* @param string $deadline Deadline for Achievement
* @return int ID of newly created Achievement
* @param string $deadline Deadline for Achievement
* @return int ID of newly created Achievement
*/
public function createAchievement($userId, $seminaryId, $conditionId, $title, $description, $progress, $hidden, $onlyOnce, $allConditions, $deadline)
{
@ -1265,7 +1265,7 @@
* (increment position).
*
* @param array $achievement Achievement to move
* @param boolean $up True for moving up, false for down
* @param boolean $up True for moving up, false for down
*/
public function moveAchievement($achievement, $up)
{
@ -1313,15 +1313,15 @@
/**
* Edit an Achievement of a Seminary.
*
* @param int $achievementId ID of Achievement to edit
* @param int $conditionId ID of Achievement condition
* @param string $title New title of Achievement
* @param int $achievementId ID of Achievement to edit
* @param int $conditionId ID of Achievement condition
* @param string $title New title of Achievement
* @param string $description New description of Achievement
* @param boolean $progress Show progress
* @param boolean $hidden Secret Achievement
* @param boolean $onlyOnce Only achieveable by one user
* @param boolean $progress Show progress
* @param boolean $hidden Secret Achievement
* @param boolean $onlyOnce Only achieveable by one user
* @param boolean $allConditions Achievement must match all conditions
* @param string $deadline Deadline for Achievement
* @param string $deadline Deadline for Achievement
*/
public function editAchievement($achievementId, $conditionId, $title, $description, $progress, $hidden, $onlyOnce, $allConditions, $deadline)
{
@ -1347,7 +1347,7 @@
/**
* Set unachieved media for an Achievement.
*
* @param int $achievementId ID of Achievement to set media for
* @param int $achievementId ID of Achievement to set media for
* @param int $achievementsmediaId ID of achievementsmedia to set
*/
public function setUnachievedMediaForAchievement($achievementId, $achievementsmediaId)
@ -1366,7 +1366,7 @@
/**
* Set achieved media for an Achievement.
*
* @param int $achievementId ID of Achievement to set media for
* @param int $achievementId ID of Achievement to set media for
* @param int $achievementsmediaId ID of achievementsmedia to set
*/
public function setAchievedMediaForAchievement($achievementId, $achievementsmediaId)

68
models/CharactergroupsModel.inc
View file

@ -44,8 +44,8 @@
/**
* Get Character groups-groups of a Seminary.
*
* @param int $seminaryId ID of the corresponding Seminary
* @return array Character groups-groups data
* @param int $seminaryId ID of the corresponding Seminary
* @return array Character groups-groups data
*/
public function getGroupsroupsForSeminary($seminaryId)
{
@ -63,9 +63,9 @@
* Get a Character groups-group by its URL.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of the corresponding Seminary
* @param int $seminaryId ID of the corresponding Seminary
* @param string $groupsgroupUrl URL-name of the Character groups-group
* @return array Character groups-group data
* @return array Character groups-group data
*/
public function getGroupsgroupByUrl($seminaryId, $groupsgroupUrl)
{
@ -90,7 +90,7 @@
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $groupsgroupId ID of the Character groups-group
* @return array Character groups-group data
* @return array Character groups-group data
*/
public function getGroupsgroupById($groupsgroupId)
{
@ -138,11 +138,11 @@
/**
* Create a new Character groups-group.
*
* @param int $userId ID of user
* @param int $seminaryId ID of Seminary
* @param int $userId ID of user
* @param int $seminaryId ID of Seminary
* @param string $name Name of new groups-group
* @param boolean $preferred Whether groups-group is preferred or not
* @return int ID of newly created groups-group
* @return int ID of newly created groups-group
*/
public function createGroupsgroup($userId, $seminaryId, $name, $preferred)
{
@ -167,9 +167,9 @@
/**
* Edit a Character groups-group.
*
* @param int $groupsgroupId ID of groups-group to edit
* @param string $name New name of groups-group
* @param boolean $preferred Whether groups-group is preferred or not
* @param int $groupsgroupId ID of groups-group to edit
* @param string $name New name of groups-group
* @param boolean $preferred Whether groups-group is preferred or not
*/
public function editGroupsgroup($groupsgroupId, $name, $preferred)
{
@ -261,9 +261,9 @@
/**
* 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
* @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')
{
@ -297,8 +297,8 @@
/**
* Get Character groups for a Character.
*
* @param int $characterId ID of the Character
* @return array Character groups
* @param int $characterId ID of the Character
* @return array Character groups
*/
public function getGroupsForCharacter($characterId)
{
@ -322,9 +322,9 @@
* Get a Character group by its URL.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $groupsgroupId ID of the Character groups-group
* @param string $groupUrl URL-name of the Character group
* @return array Character group data
* @param int $groupsgroupId ID of the Character groups-group
* @param string $groupUrl URL-name of the Character group
* @return array Character group data
*/
public function getGroupByUrl($groupsgroupId, $groupUrl)
{
@ -351,8 +351,8 @@
* Get a Character group by its ID.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $groupsgroupId ID of the Character group
* @return array Character group data
* @param int $groupId ID of the Character group
* @return array Character group data
*/
public function getGroupById($groupId)
{
@ -378,8 +378,8 @@
/**
* Get the Character groups for a Quest.
*
* @param int $questId ID of the Character groups Quest
* @return array Character groups
* @param int $questId ID of the Character groups Quest
* @return array Character groups
*/
public function getGroupsForQuest($questId)
{
@ -452,11 +452,11 @@
/**
* Create a new Character group.
*
* @param int $userId ID of user
* @param int $groupsgroupId ID of Character groups-group
* @param string $name Name of new group
* @param string $motto Motto of new group
* @return int ID of newly created group
* @param int $userId ID of user
* @param int $groupsgroupId ID of Character groups-group
* @param string $name Name of new group
* @param string $motto Motto of new group
* @return int ID of newly created group
*/
public function createGroup($userId, $groupsgroupId, $name, $motto)
{
@ -500,7 +500,7 @@
/**
* Edit a Character group.
*
* @param int $groupId ID of Character group to edit
* @param int $groupId ID of Character group to edit
* @param string $name New name of group
* @param string $motto New motto of group
*/
@ -544,9 +544,9 @@
/**
* Get the rank of a XP-value of a Character.
*
* @param int $seminaryId ID of Seminary
* @param int $xps XP-value to get rank for
* @return int Rank of XP-value
* @param int $groupsgroupId ID of Seminary
* @param int $xps XP-value to get rank for
* @return int Rank of XP-value
*/
public function getXPRank($groupsgroupId, $xps)
{
@ -570,7 +570,7 @@
/**
* Add a Character to a Character group.
*
* @param int $groupId ID of Character group
* @param int $groupId ID of Character group
* @param int $characterId ID of Character to add
*/
public function addCharacterToCharactergroup($groupId, $characterId)
@ -590,7 +590,7 @@
/**
* Remove a Character from a Character group.
*
* @param int $groupId ID of Character group
* @param int $groupId ID of Character group
* @param int $characterId ID of Character to remove
*/
public function removeCharacterFromCharactergroup($groupId, $characterId)

10
models/CharactergroupsachievementsModel.inc
View file

@ -269,7 +269,7 @@
* position).
*
* @param array $achievement Achievement to move
* @param boolean $up True for moving up, false for down
* @param boolean $up True for moving up, false for down
*/
public function moveAchievement($achievement, $up)
{
@ -358,11 +358,9 @@
/**
* Copy all Achievements of a Seminary.
*
* @param int $userId ID of creating user
* @param int $sourceSeminaryId Seminary to copy from
* @param int $targetSeminaryId Seminary to copy to
* @param array $seminaryMediaIds Mapping of Seminarymedia-IDs from source Seminary to target Seminary
* @param array $questIds Mapping of Quest-IDs from source Seminary to target Seminary (optional)
* @param int $userId ID of creating user
* @param array $characterGroupsgroupIds Mapping of Character groups-group IDs from source Seminary to target Seminary
* @param array $seminaryMediaIds Mapping of Seminarymedia-IDs from source Seminary to target Seminary
*/
public function copyAchievementsOfSeminary($userId, $characterGroupsgroupIds, $seminaryMediaIds=null)
{

60
models/CharactergroupsquestsModel.inc
View file

@ -44,8 +44,8 @@
/**
* Get Character groups Quests of a Character groups-groups.
*
* @param int $groupsgroupId ID of the Character groups-group
* @return array Character groups Quest data
* @param int $groupsgroupId ID of the Character groups-group
* @return array Character groups Quest data
*/
public function getQuestsForCharactergroupsgroup($groupsgroupId)
{
@ -64,9 +64,9 @@
* Get a Character groups Quest by its URL.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $groupsgroupId ID of the Character groups-group
* @param string $questUrl URL-title of the Character groups Quest
* @return array Character groups Quest data
* @param int $groupsgroupId ID of the Character groups-group
* @param string $questUrl URL-title of the Character groups Quest
* @return array Character groups Quest data
*/
public function getQuestByUrl($groupsgroupId, $questUrl)
{
@ -91,8 +91,8 @@
* Get a Character groups Quest by its ID.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $questId ID of the Character groups Quest
* @return array Character groups Quest data
* @param int $questId ID of the Character groups Quest
* @return array Character groups Quest data
*/
public function getQuestById($questId)
{
@ -115,8 +115,8 @@
/**
* Get Character groups Quests for a Character group.
*
* @param int $groupId ID of the Character group
* @return array Character groups Quests
* @param int $groupId ID of the Character group
* @return array Character groups Quests
*/
public function getQuestsForGroup($groupId)
{
@ -141,9 +141,9 @@
/**
* Get XPs of a Character group for a Character groups Quest.
*
* @param int $questId ID of Character groups Quest
* @param int $groupId ID of Character group to get XPs of
* @return array XP-record
* @param int $questId ID of Character groups Quest
* @param int $groupId ID of Character group to get XPs of
* @return array XP-record
*/
public function getXPsOfGroupForQuest($questId, $groupId)
{
@ -171,8 +171,8 @@
/**
* Set XPs of a Character group for a Character groups Quest.
*
* @param int $questId ID of Character groups Quest
* @param int $groupId ID of Character group to set XPs of
* @param int $questId ID of Character groups Quest
* @param int $groupId ID of Character group to set XPs of
* @param float $xpsFactor XPs-factor
*/
public function setXPsOfGroupForQuest($questId, $groupId, $xpsFactor)
@ -214,7 +214,7 @@
* Check if a Character groups Quest title already exists.
*
* @param int $groupsgroupId ID of Character groups-group
* @param string $name Character groups Quest title to check
* @param string $title Character groups Quest title to check
* @param int $questId Do not check this ID (for editing)
* @return boolean Whether Character groups Quest title exists or not
*/
@ -256,12 +256,12 @@
/**
* Upload a media for a Character groups Quest.
*
* @param int $userId ID of user that does the upload
* @param int $seminaryId ID of Seminary
* @param int $questId ID of Quest to upload media for
* @param int $userId ID of user that does the upload
* @param int $seminaryId ID of Seminary
* @param int $questId ID of Quest to upload media for
* @param array $file File-array of file to upload
* @param string $filename Filename for media
* @return boolean Whether upload succeeded or not
* @return boolean Whether upload succeeded or not
*/
public function uploadMediaForQuest($userId, $seminaryId, $questId, $file, $filename)
{
@ -289,8 +289,8 @@
/**
* Get uploaded Medai for a Character groups Quest.
*
* @param int $questId ID of Quest to get media for
* @return array Seminary uploads
* @param int $questId ID of Quest to get media for
* @return array Seminary uploads
*/
public function getMediaForQuest($questId)
{
@ -307,16 +307,16 @@
/**
* Create a new Character groups Quest.
*
* @param int $userId ID of user
* @param int $groupsgroupId ID of Character groups-group
* @param int $questgroupId ID of Quest group
* @param string $title Title of new Quest
* @param int $userId ID of user
* @param int $groupsgroupId ID of Character groups-group
* @param int $questgroupId ID of Quest group
* @param string $title Title of new Quest
* @param string $description Description of new Quset
* @param int $xps Amount of XPs for new Quest
* @param string $rules Rules of new Quest
* @param string $wonText Won-text of new Quset
* @param string $lostText Lost-text of new Quest
* @return int ID of newly created Quest
* @param int $xps Amount of XPs for new Quest
* @param string $rules Rules of new Quest
* @param string $wonText Won-text of new Quset
* @param string $lostText Lost-text of new Quest
* @return int ID of newly created Quest
*/
public function createQuest($userId, $groupsgroupId, $questgroupId, $title, $description, $xps, $rules, $wonText, $lostText)
{

6
models/CharactergroupsqueststationsModel.inc
View file

@ -116,8 +116,8 @@
* Get a Station by its Hash.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $stationUrl Hash of Station to get
* @return array Station data
* @param string $stationHash Hash of Station to get
* @return array Station data
*/
public function getStationByHash($stationHash)
{
@ -332,7 +332,7 @@
/**
* Check if a Character group has solved a Station.
*
* @param int $questId ID of Quest to check
* @param int $stationId ID of Quest to check
* @param int $groupId ID of Character to check
* @result boolean Whether Character has solved the Quest or not
*/

8
models/CharacterrolesModel.inc
View file

@ -37,8 +37,8 @@
/**
* Get all characterroles for a Character referenced by its ID.
*
* @param int $userId ID of an user
* @return array Characterroles for a Character
* @param int $characterId ID of Character
* @return array Characterroles for a Character
*/
public function getCharacterrolesForCharacterById($characterId)
{
@ -56,7 +56,7 @@
/**
* Add a role to a Character.
*
* @param int $characterId ID of Character to add role to
* @param int $characterId ID of Character to add role to
* @param string $characterrole Role to add
*/
public function addCharacterroleToCharacter($characterId, $characterrole)
@ -77,7 +77,7 @@
/**
* Remove a role from a Character.
*
* @param int $characterId ID of Character to remove role from
* @param int $characterId ID of Character to remove role from
* @param string $characterrole Role to remove
*/
public function removeCharacterroleFromCharacter($characterId, $characterrole)

88
models/CharactersModel.inc
View file

@ -37,8 +37,8 @@
/**
* Get all characters for an user.
*
* @param int $userId ID of the user
* @return array Characters
* @param int $userId ID of the user
* @return array Characters
*/
public function getCharactersForUser($userId)
{
@ -63,9 +63,9 @@
/**
* Get count of Characters for a Seminary.
*
* @param int $seminaryId ID of the Seminary
* @param int $seminaryId ID of the Seminary
* @param string $charactername Only get Characters with the given name (optional)
* @return int Count of Characters
* @return int Count of Characters
*/
public function getCharactersForSeminaryCount($seminaryId, $charactername=null)
{
@ -91,9 +91,9 @@
/**
* Get Characters for a Seminary.
*
* @param int $seminaryId ID of the Seminary
* @param int $seminaryId ID of the Seminary
* @param bool $onlyWithRole Only Characters that have at least one role assigned (optional)
* @return array Characters
* @return array Characters
*/
public function getCharactersForSeminary($seminaryId, $onlyWithRole=false)
{
@ -119,12 +119,12 @@
/**
* Get Characters for a Seminary sorted and optionally limited.
*
* @param int $seminaryId ID of the Seminary
* @param string $sort Field to sort by
* @param int $seminaryId ID of the Seminary
* @param string $sort Field to sort by
* @param string $charactername Only get Characters with the given name (optional)
* @param int $limit Limit amount of Characters (optional)
* @param int $offset Offset (optional)
* @return array Characters
* @param int $limit Limit amount of Characters (optional)
* @param int $offset Offset (optional)
* @return array Characters
*/
public function getCharactersForSeminarySorted($seminaryId, $sort, $charactername='', $limit=null, $offset=0)
{
@ -215,8 +215,8 @@
/**
* Get Characters for a Character group.
*
* @param int $groupId ID of the Character group
* @return array Characters
* @param int $groupId ID of the Character group
* @return array Characters
*/
public function getCharactersForGroup($groupId)
{
@ -242,9 +242,9 @@
* Get the character of a user for a Seminary.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $userId ID of the user
* @param int $seminaryId ID of the Seminary
* @return array Character data
* @param int $userId ID of the user
* @param int $seminaryId ID of the Seminary
* @return array Character data
*/
public function getCharacterForUserAndSeminary($userId, $seminaryId)
{
@ -274,9 +274,9 @@
* Get a Character by its Url.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of the Seminary
* @param int $seminaryId ID of the Seminary
* @param string $characterUrl URL-name of the Character
* @return array Character data
* @return array Character data
*/
public function getCharacterByUrl($seminaryId, $characterUrl)
{
@ -307,7 +307,7 @@
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $characterId ID of the Character
* @return array Character data
* @return array Character data
*/
public function getCharacterById($characterId)
{
@ -357,10 +357,10 @@
/**
* Get Characters with the most amount of Achievements.
*
* @param int $seminaryId ID of Seminary
* @param int $conut Amount of Characters to retrieve
* @param int $seminaryId ID of Seminary
* @param int $count Amount of Characters to retrieve
* @param bool $alsoWithDeadline Include Achievements with deadline (optional)
* @return array List of Characters
* @return array List of Characters
*/
public function getCharactersWithMostAchievements($seminaryId, $count, $alsoWithDeadline=true)
{
@ -396,7 +396,7 @@
*
* @param int $seminaryId ID of Seminary
* @param int $xps XP-value to get rank for
* @return int Rank of XP-value
* @return int Rank of XP-value
*/
public function getXPRank($seminaryId, $xps)
{
@ -424,10 +424,10 @@
/**
* Get the superior $count Characters in the ranking.
*
* @param int $seminaryId ID of Seminary
* @param int $xps XP-value of Character
* @param int $count Count of Characters to determine
* @return array List of superior Characters
* @param int $seminaryId ID of Seminary
* @param int $xps XP-value of Character
* @param int $count Count of Characters to determine
* @return array List of superior Characters
*/
public function getSuperiorCharacters($seminaryId, $xps, $count)
{
@ -459,11 +459,11 @@
/**
* 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
* @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
*/
public function getInferiorCharacters($seminaryId, $characterId, $xps, $count)
{
@ -491,8 +491,8 @@
/**
* Get Characters that solved a Quest.
*
* @param int $questId ID of Quest to get Characters for
* @return array Characters data
* @param int $questId ID of Quest to get Characters for
* @return array Characters data
*/
public function getCharactersSolvedQuest($questId)
{
@ -522,8 +522,8 @@
/**
* Get Characters that did not solv a Quest.
*
* @param int $questId ID of Quest to get Characters for
* @return array Characters data
* @param int $questId ID of Quest to get Characters for
* @return array Characters data
*/
public function getCharactersUnsolvedQuest($questId)
{
@ -553,8 +553,8 @@
/**
* Get Characters that sent a submission for a Quest.
*
* @param int $questId ID of Quest to get Characters for
* @return array Characters data
* @param int $questId ID of Quest to get Characters for
* @return array Characters data
*/
public function getCharactersSubmittedQuest($questId)
{
@ -584,9 +584,9 @@
/**
* Get Characters with the given Character role.
*
* @param int $seminaryId ID of Seminary
* @param string $characterrole Character role
* @return array List of users
* @param int $seminaryId ID of Seminary
* @param string $characterrole Character role
* @return array List of users
*/
public function getCharactersWithCharacterRole($seminaryId, $characterrole)
{
@ -613,9 +613,9 @@
/**
* Check if a Character name already exists.
*
* @param string $name Character name to check
* @param int $characterId Do not check this ID (for editing)
* @return boolean Whether Character name exists or not
* @param string $name Character name to check
* @param int $characterId Do not check this ID (for editing)
* @return boolean Whether Character name exists or not
*/
public function characterNameExists($name, $characterId=null)
{

30
models/CharactertypesModel.inc
View file

@ -37,8 +37,8 @@
/**
* Get all Character types of a Seminary.
*
* @param int $seminaryId ID of Seminary to get types of
* @return array Character types
* @param int $seminaryId ID of Seminary to get types of
* @return array Character types
*/
public function getCharacterTypesForSeminary($seminaryId)
{
@ -56,9 +56,9 @@
/**
* Get Character type by its URL.
*
* @param int $seminaryId ID of Seminary
* @param string $charactretypeUrl URL-title of Character type
* @return array Character type data
* @param int $seminaryId ID of Seminary
* @param string $charactertypeUrl URL-title of Character type
* @return array Character type data
*/
public function getCharactertypeByUrl($seminaryId, $charactertypeUrl)
{
@ -83,7 +83,7 @@
* Get Character type by its ID.
*
* @param string $charactertypeId ID of Character type
* @return array Character type data
* @return array Character type data
*/
public function getCharactertypeById($charactertypeId)
{
@ -106,10 +106,10 @@
/**
* Check if a Charactertype name already exists.
*
* @param int $seminaryId ID of Seminary
* @param string $name Charactertype name to check
* @param int $charactertypeId Do not check this ID (for editing)
* @return boolean Whether Charactertype name exists or not
* @param int $seminaryId ID of Seminary
* @param string $name Charactertype name to check
* @param int $charactertypeId Do not check this ID (for editing)
* @return boolean Whether Charactertype name exists or not
*/
public function charactertypeNameExists($seminaryId, $name, $charactertypeId=null)
{
@ -130,10 +130,10 @@
/**
* Create a new Charactertype for a Seminary.
*
* @param int $userId ID of creating user
* @param int $seminaryId ID of Seminary
* @param int $userId ID of creating user
* @param int $seminaryId ID of Seminary
* @param string $name Name for new Charactertype
* @return int ID of newly created Charactertype
* @return int ID of newly created Charactertype
*/
public function createCharactertype($userId, $seminaryId, $name)
{
@ -184,8 +184,8 @@
/**
* Edit a Charactertype.
*
* @param int $charactertypeId ID of Charactertype to edit
* @param string $name New name of Charactertype
* @param int $charactertypeId ID of Charactertype to edit
* @param string $name New name of Charactertype
*/
public function editCharactertype($charactertypeId, $name)
{

16
models/MediaModel.inc
View file

@ -38,7 +38,7 @@
* Get a medium by its URL.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $mediaURL URL-name of the Medium
* @param string $mediaUrl URL-name of the Medium
* @return array Medium data
*/
public function getMediaByUrl($mediaUrl)
@ -63,8 +63,8 @@
* Get a medium by its ID.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $mediaId ID of the Medium
* @return array Medium data
* @param int $mediaId ID of the Medium
* @return array Medium data
*/
public function getMediaById($mediaId)
{
@ -115,8 +115,8 @@
* Get a Seminary medium by its ID.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryMediaId ID of the Seminary medium
* @return array Seminary medium data
* @param int $mediaId ID of the Seminary medium
* @return array Seminary medium data
*/
public function getSeminaryMediaById($mediaId)
{
@ -326,7 +326,7 @@
* Copy an Avatar picture.
*
* @param int $userId ID of creating user
* @param int $seminaryMediaId ID of Seminary media to copy
* @param int $avatarpictureId ID of Avatar picture
*/
public function copyAvatarpicture($userId, $avatarpictureId)
{
@ -402,8 +402,8 @@
/**
* Copy a Questgroup picture.
*
* @param int $userId ID of creating user
* @param int $seminaryMediaId ID of Seminary media to copy
* @param int $userId ID of creating user
* @param int $questgroupspictureId ID of Questgroup picture
*/
public function copyQuestgroupspicture($userId, $questgroupspictureId)
{

6
models/PagesModel.inc
View file

@ -68,7 +68,7 @@
/**
* Get a page by its ID.
*
* @param string $pageid ID of page to get
* @param string $pageId ID of page to get
* @return array Page data
*/
public function getPageById($pageId)
@ -216,10 +216,10 @@
/*
/**
* Mask parameters to be used in an URL.
*
* @param string $param1 First parameter
* @param string $param First parameter
* @return string Masked parameters as string
*/
private static function createLinkParam($param)

102
models/QuestgroupsModel.inc
View file

@ -52,7 +52,7 @@
*
* @param int $hierarchyId ID of the Questgroup hierarchy to get Questgroups for
* @param int $parentQuestgroupId ID of the parent Questgroup hierarchy
* @return array Questgroups for the given hierarchy
* @return array Questgroups for the given hierarchy
*/
public function getQuestgroupsForHierarchy($hierarchyId, $parentQuestgroupId=null)
{
@ -112,8 +112,8 @@
* Get a Questgroup by its ID.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $questgroupId ID of a Questgroup
* @return array Questgroup data
* @param int $questgroupId ID of a Questgroup
* @return array Questgroup data
*/
public function getQuestgroupById($questgroupId)
{
@ -137,9 +137,9 @@
* Get a Questgroup by its URL.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of the corresponding seminary
* @param string $questgroupURL URL-title of a Questgroup
* @return array Questgroup data
* @param int $seminaryId ID of the corresponding seminary
* @param string $questgroupUrl URL-title of a Questgroup
* @return array Questgroup data
*/
public function getQuestgroupByUrl($seminaryId, $questgroupUrl)
{
@ -166,9 +166,9 @@
* on the same level as the given Quest then the followed-up
* Questgroup from a higher hierarchy level is returned.
*
* @param int $seminaryId ID of Seminary
* @param int $questgroupId ID of Questgroup to get next Questgroup of
* @return array Questgroup data
* @param int $seminaryId ID of Seminary
* @param int $questgroupId ID of Questgroup to get next Questgroup of
* @return array Questgroup data
*/
public function getNextQuestgroup($seminaryId, $questgroupId)
{
@ -196,9 +196,9 @@
* followed-up Questgroup from a higher hierarchy level is
* returned.
*
* @param int $seminaryId ID of Seminary
* @param int $questgroupId ID of Questgroup to get previous Questgroup of
* @return array Questgroup data
* @param int $seminaryId ID of Seminary
* @param int $questgroupId ID of Questgroup to get previous Questgroup of
* @return array Questgroup data
*/
public function getPreviousQuestgroup($seminaryId, $questgroupId)
{
@ -221,7 +221,7 @@
/**
* Mark a Questgroup as entered for a Character.
*
* @param int $questId ID of Quest to mark as entered
* @param int $questgroupId ID of Questgroup to mark as entered
* @param int $characterId ID of Character that entered the Quest
*/
public function setQuestgroupEntered($questgroupId, $characterId)
@ -235,7 +235,7 @@
*
* @param int $questgroupId ID of Questgroup to check
* @param int $characterId ID of Character to check
* @result boolean Whether Character has entered the Questgroup or not
* @result boolean Whether Character has entered the Questgroup or not
*/
public function hasCharacterEnteredQuestgroup($questgroupId, $characterId)
{
@ -259,7 +259,7 @@
*
* @param int $questgroupId ID of Questgroup to check
* @param int $characterId ID of Character to check
* @result boolean Whether Character has solved the Questgroup or not
* @result boolean Whether Character has solved the Questgroup or not
*/
public function hasCharacterSolvedQuestgroup($questgroupId, $characterId)
{
@ -321,8 +321,8 @@
/**
* Get all related Questgroups of a Questtext.
*
* @param int $questtextId ID of the Questtext
* @return array Related Questgroups for the Questtext
* @param int $questtextId ID of the Questtext
* @return array Related Questgroups for the Questtext
*/
public function getRelatedQuestsgroupsOfQuesttext($questtextId)
{
@ -340,8 +340,8 @@
/**
* Get all related Questgroups of a Quest.
*
* @param int $questId ID of the Quest
* @return array Related Quests for the Quest
* @param int $questId ID of the Quest
* @return array Related Quests for the Quest
*/
public function getRelatedQuestsgroupsOfQuest($questId)
{
@ -361,8 +361,8 @@
/**
* Get all related Questgroups of a Questgroup.
*
* @param int $questgroupId ID of the Questgroup
* @return array Related Questgroups for the Questgroup
* @param int $questgroupId ID of the Questgroup
* @return array Related Questgroups for the Questgroup
*/
public function getRelatedQuestsgroupsOfQuestgroup($questgroupId)
{
@ -385,7 +385,7 @@
*
* @param int $questgroupId ID of Questgroup
* @param int $characterId ID of Character
* @return int Sum of XPs
* @return int Sum of XPs
*/
public function getAchievedXPsForQuestgroup($questgroupId, $characterId)
{
@ -419,10 +419,10 @@
/**
* Check if a Questgroups title already exists for a Seminary.
*
* @param int $seminaryId ID of Seminary
* @param string $title Questgroup title to check
* @param int $questgroupId Do not check this ID (for editing)
* @return boolean Whether Questgroup title exists or not
* @param int $seminaryId ID of Seminary
* @param string $title Questgroup title to check
* @param int $questgroupId Do not check this ID (for editing)
* @return boolean Whether Questgroup title exists or not
*/
public function questgroupTitleExists($seminaryId, $title, $questgroupId=null)
{
@ -443,10 +443,10 @@
/**
* Create a new Questgroup.
*
* @param int $userId User-ID that creates the new character
* @param int $seminaryId ID of Seminary
* @param int $userId User-ID that creates the new character
* @param int $seminaryId ID of Seminary
* @param string $title Title for new Questgroup
* @return int ID of new Questgroup
* @return int ID of new Questgroup
*/
public function createQuestgroup($userId, $seminaryId, $title)
{
@ -471,7 +471,7 @@
* Set the moodpic for a Questgroup.
*
* @param int $questgroupId ID of Questgroup to set moodpic for
* @param int $mediaId ID of moodpic media
* @param int $mediaId ID of moodpic media
*/
public function setMoodpicForQuestgroup($questgroupId, $mediaId)
{
@ -599,7 +599,7 @@
* position).
*
* @param array $questgroup Questgroup to move
* @param boolean $up True for moving up, false for down
* @param boolean $up True for moving up, false for down
*/
public function moveQuestgroup($questgroup, $up)
{
@ -662,8 +662,8 @@
* Edit a Questgroup.
*
* @throws \nre\exceptions\DatamodelException
* @param int $questgroupId ID of Questgroup to edit
* @param string $title New title of Questgroup
* @param int $questgroupId ID of Questgroup to edit
* @param string $title New title of Questgroup
*/
public function editQuestgroup($questgroupId, $title)
{
@ -800,10 +800,10 @@
/**
* Get the next (direct) Questgroup.
*
* @param int $seminaryId ID of Seminary
* @param int $parentQuestgroupId ID of parent Questgroup to get next Questgroup of
* @param int $questgroupPos Position of Questgroup to get next Questgroup of
* @return array Data of next Questgroup or NULL
* @param int $seminaryId ID of Seminary
* @param int $parentQuestgroupId ID of parent Questgroup to get next Questgroup of
* @param int $questgroupPos Position of Questgroup to get next Questgroup of
* @return array Data of next Questgroup or NULL
*/
private function _getNextQuestgroup($seminaryId, $parentQuestgroupId, $questgroupPos)
{
@ -841,10 +841,10 @@
/**
* Get the previous (direct) Questgroup.
*
* @param int $seminaryId ID of Seminary
* @param int $parentQuestgroupId ID of parent Questgroup to get previous Questgroup of
* @param int $questgroupPos Position of Questgroup to get previous Questgroup of
* @return array Data of previous Questgroup or NULL
* @param int $seminaryId ID of Seminary
* @param int $parentQuestgroupId ID of parent Questgroup to get previous Questgroup of
* @param int $questgroupPos Position of Questgroup to get previous Questgroup of
* @return array Data of previous Questgroup or NULL
*/
private function _getPreviousQuestgroup($seminaryId, $parentQuestgroupId, $questgroupPos)
{
@ -882,10 +882,10 @@
/**
* Mark a Questgroup for a Character.
*
* @param int $questgroupId ID of Questgroup to mark
* @param int $characterId ID of Character to mark the Questgroup for
* @param int $status Questgroup status to mark
* @param boolean $repeated Insert although status is already set for this Questgroup and Character
* @param int $questgroupId ID of Questgroup to mark
* @param int $characterId ID of Character to mark the Questgroup for
* @param int $status Questgroup status to mark
* @param boolean $repeated Insert although status is already set for this Questgroup and Character
*/
private function setQuestgroupStatus($questgroupId, $characterId, $status, $repeated=true)
{
@ -925,9 +925,9 @@
* Questgroup, its sub-Questgroups, related Questgroups etc. and
* store this value in the database.
*
* @param int $questgroupId ID of Questgroup
* @param int $questgroupId ID of Questgroup
* @param array $calculatedQuests Already calculated Quests
* @return int Sum of calculated XPs
* @return int Sum of calculated XPs
*/
public function calculateXPsForQuestgroup($questgroupId, &$calculatedQuests=array())
{
@ -969,7 +969,7 @@
*
* @param int $questgroupId ID of Questgroup
* @param int $characterId ID of Character
* @return int Sum of XPs of Quests
* @return int Sum of XPs of Quests
*/
private function _getAchievedXPsForQuestgroup($questgroupId, $characterId)
{
@ -994,9 +994,9 @@
* its following Quests by choosing the path with the highest
* amount of XPs.
*
* @param int $quest Quest data
* @param int $quest Quest data
* @param array $calculatedQuests Already calculated Quests
* @return int Sum of calculated XPs
* @return int Sum of calculated XPs
*/
private function _calculateXPsForQuestgroup($quest, &$calculatedQuests=array())
{
@ -1029,7 +1029,7 @@
* Set achievable XPs for a Questgroup.
*
* @param int $questgroupId ID of Questgroup
* @param int $xps XPs to set
* @param int $xps XPs to set
*/
private function setXPsForQuestgroup($questgroupId, $xps)
{

52
models/QuestgroupshierarchyModel.inc
View file

@ -38,8 +38,8 @@
* Get a Questgroup hierarchy by its ID.
*
* throws \nre\exceptions\IdNotFoundException
* @param int $questgroupshierarchyId ID of a Questgroup hierarchy
* @return array Questgroup hierarchy
* @param int $questgroupshierarchyId ID of a Questgroup hierarchy
* @return array Questgroup hierarchy
*/
public function getHierarchyById($questgroupshierarchyId)
{
@ -63,9 +63,9 @@
* Get a Questgroup hierarchy by its URL.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of Seminary
* @param int $questgroupshierarchyURL URL of a Questgroup hierarchy
* @return array Questgroup hierarchy
* @param int $seminaryId ID of Seminary
* @param int $questgroupshierarchyUrl URL of a Questgroup hierarchy
* @return array Questgroup hierarchy
*/
public function getHierarchyByUrl($seminaryId, $questgroupshierarchyUrl)
{
@ -89,8 +89,8 @@
/**
* Get the toplevel hierarchy entries of a Seminary.
*
* @param int $seminaryId ID of the seminary to get hierarchy for
* @return array Toplevel hierarchy
* @param int $seminaryId ID of the seminary to get hierarchy for
* @return array Toplevel hierarchy
*/
public function getHierarchyOfSeminary($seminaryId)
{
@ -110,8 +110,8 @@
/**
* Get the Questgroup-Hierarchy for a Questgroup.
*
* @param int $questgroupId ID of Questgroup
* @return array Hierarchy for Questgroup
* @param int $questgroupId ID of Questgroup
* @return array Hierarchy for Questgroup
*/
public function getHierarchyForQuestgroup($questgroupId)
{
@ -135,8 +135,8 @@
/**
* Get the child hierarchy entries of a Questgroup hierarchy.
*
* @param int $questgroupshierarchyId ID of a Questgroup hierarchy
* @return array Child Questgroup hierarchy entries
* @param int $questgroupshierarchyId ID of a Questgroup hierarchy
* @return array Child Questgroup hierarchy entries
*/
public function getChildQuestgroupshierarchy($questgroupshierarchyId)
{
@ -155,10 +155,10 @@
* Check if a title for a Questgroupshierarchy already exists
* for a Seminary.
*
* @param string $title
* @param int $seminaryId
* @param int $questgroupshierarchyId Do not check this Questgroupshierarchy (for editing)
* @return Whether title already exists or not
* @param string $title Title to check
* @param int $seminaryId ID of Seminary
* @param int $questgroupshierarchyId Do not check this Questgroupshierarchy (for editing)
* @return Whether title already exists or not
*/
public function questgroupshierarchyTitleSingularExists($title, $seminaryId, $questgroupshierarchyId=null)
{
@ -180,11 +180,11 @@
/**
* Create a new Questgroupshierarchy for a Seminary
*
* @param int $userId ID of creating user
* @param int $seminaryId ID of Seminary
* @param int $parentQuestgroupsierarchyId ID of parent Questgroupshierarchy
* @param string $title Title (singular)
* @param string $course Title (plural)
* @param int $userId ID of creating user
* @param int $seminaryId ID of Seminary
* @param int $parentQuestgroupsierarchyId ID of parent Questgroupshierarchy
* @param string $titleSingular Title (singular)
* @param string $titlePlural Title (plural)
*/
public function createQuestgroupshierarchy($userId, $seminaryId, $parentQuestgroupsierarchyId, $titleSingular, $titlePlural)
{
@ -223,9 +223,9 @@
/**
* Edit a Questgroupshierarchy.
*
* @param int $questgroupshierarchyId ID of Questgroupshierarchy to edit
* @param string $title New title (singular)
* @param string $course New title (plural)
* @param int $questgroupshierarchyId ID of Questgroupshierarchy to edit
* @param string $titleSingular New title (singular)
* @param string $titlePlural New title (plural)
*/
public function editQuestgroupshierarchy($questgroupshierarchyId, $titleSingular, $titlePlural)
{
@ -247,7 +247,7 @@
* (increment position).
*
* @param array $questgroupshierarchy Questgroupshierarchy to move
* @param boolean $up True for moving up, false for down
* @param boolean $up True for moving up, false for down
*/
public function moveQuestgroupshierarchy($questgroupshierarchy, $up)
{
@ -331,7 +331,7 @@
/**
* Delete a Questgroupshierarchy.
*
* @param int $seminaryId ID of the seminary to delete
* @param int $questgroupshierarchyId ID of Questgroups hierarchy to delete
*/
public function deleteQuestgroupshierarchy($questgroupshierarchyId)
{
@ -359,7 +359,7 @@
* @param int $sourceSeminaryId ID of Seminary to copy hierarchy from
* @param int $targetSeminaryId ID of Seminary to copy hierarchy to
* @param array $hierarchy Hierarchy to copy
* @return array $hierarchyIds Mapping of hierarchy IDs from source Seminary to target Seminary
* @param array $hierarchyIds Mapping of hierarchy IDs from source Seminary to target Seminary
*/
private function copyHierarchy($userId, $sourceSeminaryId, $targetSeminaryId, $hierarchy, &$hierarchyIds)
{

146
models/QuestsModel.inc
View file

@ -69,10 +69,10 @@
* Get a Quest and its data by its URL.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of the corresponding Seminary
* @param int $questgroupId ID of the corresponding Questgroup
* @param string $questURL URL-title of a Quest
* @return array Quest data
* @param int $seminaryId ID of the corresponding Seminary
* @param int $questgroupId ID of the corresponding Questgroup
* @param string $questUrl URL-title of a Quest
* @return array Quest data
*/
public function getQuestByUrl($seminaryId, $questgroupId, $questUrl)
{
@ -98,7 +98,7 @@
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $questId ID of a Quest
* @return array Quest data
* @return array Quest data
*/
public function getQuestById($questId)
{
@ -122,8 +122,8 @@
/**
* Get the first Quest of a Qusetgroup.
*
* @param int $questId ID of Questgroup
* @return array Data of first Quest
* @param int $questgroupId ID of Questgroup
* @return array Data of first Quest
*/
public function getFirstQuestOfQuestgroup($questgroupId)
{
@ -148,8 +148,8 @@
* Get all Quests a Qusetgroup that do not have a following
* Quest.
*
* @param int $questId ID of Questgroup
* @return array List of last Quests
* @param int $questgroupId ID of Questgroup
* @return array List of last Quests
*/
public function getLastQuestsOfQuestgroup($questgroupId)
{
@ -170,8 +170,8 @@
/**
* Get Quests that follow-up a Quest.
*
* @param int $questId ID of Quest to get next Quests of
* @return array Quests data
* @param int $questId ID of Quest to get next Quests of
* @return array Quests data
*/
public function getNextQuests($questId)
{
@ -190,8 +190,8 @@
/**
* Get Quests that the given Quests follows-up to.
*
* @param int $questId ID of Quest to get previous Quests of
* @return array Quests data
* @param int $questId ID of Quest to get previous Quests of
* @return array Quests data
*/
public function getPreviousQuests($questId)
{
@ -210,7 +210,7 @@
/**
* Set the previous Quest for a Quest.
*
* @param int $questId ID of Quest to set previous Quest for
* @param int $questId ID of Quest to set previous Quest for
* @param int $previousQuestId Id of previous Quest
*/
public function setPreviousQuest($questId, $previousQuestId)
@ -230,7 +230,7 @@
/**
* Mark a Quest as entered for a Character.
*
* @param int $questId ID of Quest to mark as entered
* @param int $questId ID of Quest to mark as entered
* @param int $characterId ID of Character that entered the Quest
*/
public function setQuestEntered($questId, $characterId)
@ -242,7 +242,7 @@
/**
* Mark a Quest as submitted for a Character.
*
* @param int $questId ID of Quest to mark as unsolved
* @param int $questId ID of Quest to mark as unsolved
* @param int $characterId ID of Character that unsolved the Quest
*/
public function setQuestSubmitted($questId, $characterId)
@ -254,7 +254,7 @@
/**
* Mark a Quest as unsolved for a Character.
*
* @param int $questId ID of Quest to mark as unsolved
* @param int $questId ID of Quest to mark as unsolved
* @param int $characterId ID of Character that unsolved the Quest
*/
public function setQuestUnsolved($questId, $characterId)
@ -266,7 +266,7 @@
/**
* Mark a Quest as solved for a Character.
*
* @param int $questId ID of Quest to mark as solved
* @param int $questId ID of Quest to mark as solved
* @param int $characterId ID of Character that solved the Quest
*/
public function setQuestSolved($questId, $characterId)
@ -278,9 +278,9 @@
/**
* Determine if the given Character has entered a Quest.
*
* @param int $questId ID of Quest to check
* @param int $characterId ID of Character to check
* @result boolean Whether Character has entered the Quest or not
* @param int $questId ID of Quest to check
* @param int $characterId ID of Character to check
* @result boolean Whether Character has entered the Quest or not
*/
public function hasCharacterEnteredQuest($questId, $characterId)
{
@ -302,9 +302,9 @@
/**
* Determine if the given Character has tried to solve a Quest.
*
* @param int $questId ID of Quest to check
* @param int $characterId ID of Character to check
* @result boolean Whether Character has tried to solved the Quest or not
* @param int $questId ID of Quest to check
* @param int $characterId ID of Character to check
* @result boolean Whether Character has tried to solved the Quest or not
*/
public function hasCharacterTriedQuest($questId, $characterId)
{
@ -326,9 +326,9 @@
/**
* Determine if the given Character has solved the given Quest.
*
* @param int $questId ID of Quest to check
* @param int $characterId ID of Character to check
* @result boolean Whether Character has solved the Quest or not
* @param int $questId ID of Quest to check
* @param int $characterId ID of Character to check
* @result boolean Whether Character has solved the Quest or not
*/
public function hasCharacterSolvedQuest($questId, $characterId)
{
@ -350,8 +350,8 @@
/**
* Get the last Quests for a Character.
*
* @param int $characterId ID of Character
* @retrun array Quest data
* @param int $characterId ID of Character
* @retrun array Quest data
*/
public function getLastQuestForCharacter($characterId)
{
@ -378,8 +378,8 @@
/**
* Get all Quests for a Seminary.
*
* @param int $seminaryId ID of Seminary
* @return array Quests for this Seminary
* @param int $seminaryId ID of Seminary
* @return array Quests for this Seminary
*/
public function getQuestsForSeminary($seminaryId)
{
@ -398,11 +398,11 @@
/**
* Get count of all Quests for a Seminary.
*
* @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
* @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)
{
@ -430,13 +430,13 @@
* Get all Quests for a Seminary order by their count of open
* submissions.
*
* @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
* @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
*/
public function getQuestsForSeminaryByOpenSubmissions($seminaryId, $questgroupId=null, $questtypeId=null, $title=null, $limit=null, $offset=0)
{
@ -468,8 +468,8 @@
/**
* Get all Quests that are linked to a Questtopic.
*
* @param int $questtopicId ID of Questtopic
* @return array Quests for this Questtopic
* @param int $questtopicId ID of Questtopic
* @return array Quests for this Questtopic
*/
public function getQuestsForQuesttopic($questtopicId)
{
@ -491,10 +491,10 @@
/**
* Mark a Quest for a Character.
*
* @param int $questId ID of Quest to mark
* @param int $characterId ID of Character to mark the Quest for
* @param int $status Quest status to mark
* @param boolean $repeated Insert although status is already set for this Quest and Character
* @param int $questId ID of Quest to mark
* @param int $characterId ID of Character to mark the Quest for
* @param int $status Quest status to mark
* @param boolean $repeated Insert although status is already set for this Quest and Character
*/
private function setQuestStatus($questId, $characterId, $status, $repeated=true)
{
@ -532,9 +532,9 @@
/**
* Get the last status of a Quest for a Character.
*
* @param int $questId ID of Quest
* @param int $questId ID of Quest
* @param int $characterId ID of Character to get status for
* @return int Last status
* @return int Last status
*/
public function getLastQuestStatus($questId, $characterId)
{
@ -560,9 +560,9 @@
* Check if a Quest title already exists.
*
* @param string $title Quest title to check
* @param int $seminaryId ID of Seminary
* @param int $questId Do not check this ID (for editing)
* @return boolean Whether Quest title exists or not
* @param int $seminaryId ID of Seminary
* @param int $questId Do not check this ID (for editing)
* @return boolean Whether Quest title exists or not
*/
public function questTitleExists($title, $seminaryId, $questId=null)
{
@ -584,15 +584,15 @@
/**
* Create a new Quest.
*
* @param int $userId User-ID that creates the new character
* @param int $questgroupId ID of Questgroup
* @param int $questtypeId ID of Questtype
* @param string $title Title for new Quest
* @param int $xps XPs for new Quest
* @param string $task Task for new Quest
* @param string $entrytext Entrytext for new Quest
* @param string $wrongtext Wrongtext for new Quest
* @return int ID of new Quest
* @param int $userId User-ID that creates the new character
* @param int $questgroupId ID of Questgroup
* @param int $questtypeId ID of Questtype
* @param string $title Title for new Quest
* @param int $xps XPs for new Quest
* @param string $task Task for new Quest
* @param string $entrytext Entrytext for new Quest
* @param string $wrongtext Wrongtext for new Quest
* @return int ID of new Quest
*/
public function createQuest($userId, $questgroupId, $questtypeId, $title, $xps, $task, $entrytext, $wrongtext)
{
@ -636,8 +636,8 @@
/**
* Set the media for a Quest.
*
* @param int $questId ID of Quest to set media for
* @param int $questmediaId ID of Questsmedia to set
* @param int $questId ID of Quest to set media for
* @param int $questsmediaId ID of Questsmedia to set
*/
public function setQuestmedia($questId, $questsmediaId)
{
@ -655,13 +655,13 @@
/**
* Edit a new Quest.
*
* @param int $questId ID of Quest to edit
* @param int $questtypeId ID of Questtype
* @param string $title New title for Quest
* @param int $xps XPs for Quest
* @param string $task New task for Quest
* @param string $entrytext New entrytext for Quest
* @param string $wrongtext New wrongtext for Quest
* @param int $questId ID of Quest to edit
* @param int $questtypeId ID of Questtype
* @param string $title New title for Quest
* @param int $xps XPs for Quest
* @param string $task New task for Quest
* @param string $entrytext New entrytext for Quest
* @param string $wrongtext New wrongtext for Quest
*/
public function editQuest($questId, $questtypeId, $title, $xps, $task, $entrytext, $wrongtext)
{
@ -686,7 +686,7 @@
* Copy all Quests from a Seminary.
*
* @param int $userId ID of creating user
* @param int $seminaryId ID of Seminary to copy from
* @param int $sourceSeminaryId ID of Seminary to copy from
* @param array $questgroupIds Mapping of Questgroup-IDs from source Seminary to target Seminary
* @param array $seminaryMediaIds Mapping of Seminary-media-IDs from source Seminary to target Seminary (optional)
* @return array Mapping of Quest-IDs from source Seminary to target Seminary

32
models/QuesttextsModel.inc
View file

@ -43,8 +43,8 @@
/**
* Get the first text of a Quest.
*
* @param int $questId ID of a Quest
* @return string First text of this Quest or NULL
* @param int $questId ID of a Quest
* @return string First text of this Quest or NULL
*/
public function getFirstQuestText($questId)
{
@ -61,9 +61,9 @@
/**
* Get all Questtexts for a Quest.
*
* @param int $questId ID of the Quest
* @param int $questId ID of the Quest
* @param string $questtexttypeUrl URL of the Questtexttype
* @return array All Questtexts for a Quest
* @return array All Questtexts for a Quest
*/
public function getQuesttextsOfQuest($questId, $questtexttypeUrl=null)
{
@ -96,9 +96,9 @@
/**
* Get count of Questtexts for a Quest.
*
* @param int $questId ID of the Quest
* @param int $questId ID of the Quest
* @param string $questtexttypeUrl URL of the Questtexttype
* @return int Amount of Questtexts for a Quest
* @return int Amount of Questtexts for a Quest
*/
public function getQuesttextCountOfQuest($questId, $questtexttypeUrl=null)
{
@ -138,8 +138,8 @@
* Get corresponding Questtexts for a Questgroup.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $questgroupId ID of Questgroup to get the Questtexst for
* @param array List of Questtexts
* @param int $questgroupId ID of Questgroup to get the Questtexst for
* @param array List of Questtexts
*/
public function getRelatedQuesttextsForQuestgroup($questgroupId)
{
@ -158,9 +158,9 @@
/**
* 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
* @param int $characterId ID of Character
* @param array $questtexts List of Questtexts to look into
* @return array Questtext data
*/
public function pickQuesttextLastEnteredByCharacter($characterId, $questtexts)
{
@ -212,7 +212,7 @@
* Get a Questtexttype by its URL.
*
* @param string $questtexttypeUrl URL-type of Questtexttype
* @return array Questtexttype data
* @return array Questtexttype data
*/
public function getQuesttexttypeByUrl($questtexttypeUrl)
{
@ -235,10 +235,10 @@
/**
* Add a Questtexts to a Quest.
*
* @param int $userId ID of user
* @param int $questId ID of Quest to add texts to
* @param int $userId ID of user
* @param int $questId ID of Quest to add texts to
* @param string $questtexttypeUrl URL-type of Questtexttype of texts
* @param string $text Text to add.
* @param string $text Text to add.
*/
public function addQuesttextToQuest($userId, $questId, $questtexttypeUrl, $text)
{
@ -278,7 +278,7 @@
* Set the media for a Quest text.
*
* @param int $questtextId ID of Quest text to set media for
* @param int $questmediaId ID of Questsmedia to set
* @param int $questsmediaId ID of Questsmedia to set
*/
public function setQuestmedia($questtextId, $questsmediaId)
{

64
models/QuesttopicsModel.inc
View file

@ -37,9 +37,9 @@
/**
* Get a Questtopic by its URL.
*
* @param int $seminaryId ID of Seminary
* @param int $seminaryId ID of Seminary
* @param string $questtopicUrl URL-Title of Questtopic
* @return array Questtopic data
* @return array Questtopic data
*/
public function getQuesttopicByUrl($seminaryId, $questtopicUrl)
{
@ -62,8 +62,8 @@
/**
* Get a Questtopic by its ID.
*
* @param int $questtopicId ID of Questtopic
* @return array Questtopic data
* @param int $questtopicId ID of Questtopic
* @return array Questtopic data
*/
public function getQuesttopicById($questtopicId)
{
@ -86,8 +86,8 @@
/**
* Get all Questtopics for a Seminary.
*
* @param int $seminaryId ID of Seminary
* @return array List of Questtopics
* @param int $seminaryId ID of Seminary
* @return array List of Questtopics
*/
public function getQuesttopicsForSeminary($seminaryId)
{
@ -181,7 +181,7 @@
* Get count of Quests that are linked to a Questtopic.
*
* @param int $questtopicId ID of Questtopic
* @return int Count of Quests
* @return int Count of Quests
*/
public function getQuestCountForQuesttopic($questtopicId)
{
@ -208,7 +208,7 @@
*
* @param int $questtopicId ID of Questtopic
* @param int $characterId ID of Character
* @return int Count of Quests
* @return int Count of Quests
*/
public function getCharacterQuestCountForQuesttopic($questtopicId, $characterId)
{
@ -234,8 +234,8 @@
/**
* Get alle Questsubtopics for a Questtopic.
*
* @param int $questtopicId ID of Questtopic
* @return array List of Questsubtopics for this Questtopic
* @param int $questtopicId ID of Questtopic
* @return array List of Questsubtopics for this Questtopic
*/
public function getSubtopicsForQuesttopic($questtopicId)
{
@ -253,8 +253,8 @@
/**
* Get all Questsubtopics for a Quest.
*
* @param int $questId ID of Quest
* @return array List of Questsubtopics
* @param int $questId ID of Quest
* @return array List of Questsubtopics
*/
public function getQuestsubtopicsForQuest($questId)
{
@ -273,7 +273,7 @@
/**
* Set Questsubtopics for a Quest.
*
* @param int $questId ID of Quest to set subtopics for
* @param int $questId ID of Quest to set subtopics for
* @param array $questsubtopicIds List of IDs of subtopics to set
*/
public function setQuestsubtopicsForQuest($questId, $questsubtopicIds)
@ -314,9 +314,9 @@
/**
* Check if a Questtopic title already exists.
*
* @param string $title Questtopic title to check
* @param int $questtopicId Do not check this ID (for editing)
* @return boolean Whether Questtopic title exists or not
* @param string $title Questtopic title to check
* @param int $questtopicId Do not check this ID (for editing)
* @return boolean Whether Questtopic title exists or not
*/
public function questtopicTitleExists($title, $questtopicId=null)
{
@ -336,10 +336,10 @@
/**
* Create a new Questtopic for a Seminary.
*
* @param int $userId ID of creating user
* @param int $seminaryId ID of Seminary
* @param int $userId ID of creating user
* @param int $seminaryId ID of Seminary
* @param string $title Title for new Questtopic
* @return int ID of newly created Questtopic
* @return int ID of newly created Questtopic
*/
public function createQuesttopic($userId, $seminaryId, $title)
{
@ -362,8 +362,8 @@
/**
* Edit a Questtopic.
*
* @param int $questtopicId ID of Questtopic to edit
* @param string $title New title of Questtopic
* @param int $questtopicId ID of Questtopic to edit
* @param string $title New title of Questtopic
*/
public function editQuesttopic($questtopicId, $title)
{
@ -393,10 +393,10 @@
/**
* Check if a Questsubtopic title already exists.
*
* @param int $questtopicId ID of Questtopic
* @param string $title Questsubtopic title to check
* @param int $questsubtopicId Do not check this ID (for editing)
* @return boolean Whether Questsubtopic title exists or not
* @param int $questtopicId ID of Questtopic
* @param string $title Questsubtopic title to check
* @param int $questsubtopicId Do not check this ID (for editing)
* @return boolean Whether Questsubtopic title exists or not
*/
public function questsubtopicTitleExists($questtopicId, $title, $questsubtopicId=null)
{
@ -417,10 +417,10 @@
/**
* Create a new Questsubtopic for a Questtopic.
*
* @param int $userId ID of creating user
* @param int $questtopicId ID of Qusttopic
* @param string $title Title for new Questtopic
* @return int ID of newly created Questsubtopic
* @param int $userId ID of creating user
* @param int $questtopicId ID of Qusttopic
* @param string $title Title for new Questtopic
* @return int ID of newly created Questsubtopic
*/
public function createQuestsubtopic($userId, $questtopicId, $title)
{
@ -443,8 +443,8 @@
/**
* Edit a Questsubtopic.
*
* @param int $questsubtopicId ID of Questsubtopic to edit
* @param string $title New title of Questsubtopic
* @param int $questsubtopicId ID of Questsubtopic to edit
* @param string $title New title of Questsubtopic
*/
public function editQuestsubtopic($questsubtopicId, $title)
{
@ -463,7 +463,7 @@
/**
* Delete a Questsubtopic.
*
* @param int $questsubtopicId ID of Questsubtopic to delete
* @param int $questtopicId ID of Questsubtopic to delete
*/
public function deleteQuestsubtopic($questtopicId)
{

26
models/SeminariesModel.inc
View file

@ -61,7 +61,7 @@
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryId ID of a seminary
* @return array Seminary
* @return array Seminary
*/
public function getSeminaryById($seminaryId)
{
@ -86,7 +86,7 @@
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of a seminary
* @return array Seminary
* @return array Seminary
*/
public function getSeminaryByUrl($seminaryUrl)
{
@ -110,7 +110,7 @@
* Calculate sum of XPs for a Seminary.
*
* @param int $seminaryId ID of Seminary
* @return int Total sum of XPs
* @return int Total sum of XPs
*/
public function getTotalXPs($seminaryId)
{
@ -136,8 +136,8 @@
* Check if a Seminary title already exists.
*
* @param string $title Seminary title to check
* @param int $seminaryId Do not check this ID (for editing)
* @return boolean Whether Seminary title exists or not
* @param int $seminaryId Do not check this ID (for editing)
* @return boolean Whether Seminary title exists or not
*/
public function seminaryTitleExists($title, $seminaryId=null)
{
@ -157,11 +157,11 @@
/**
* Create a new Seminary.
*
* @param int $userId ID of creating user
* @param string $title Title of Seminary to create
* @param string $course Course of Seminary
* @param int $userId ID of creating user
* @param string $title Title of Seminary to create
* @param string $course Course of Seminary
* @param string $description Description of new Seminary
* @return int ID of the newly created Seminary
* @return int ID of the newly created Seminary
*/
public function createSeminary($userId, $title, $course, $description)
{
@ -304,10 +304,12 @@
* Edit a seminary.
*
* @throws \nre\exceptions\DatamodelException
* @param int $seminaryId ID of Seminary to edit
* @param string $title New title of Seminary
* @param string $course New course of Seminary
* @param int $seminaryId ID of Seminary to edit
* @param string $title New title of Seminary
* @param string $course New course of Seminary
* @param string $description New description of Seminary
* @param float $latitude GPS-latitude of point to zoom map to
* @param float $longitude GPS-longitude of point to zoom map to
*/
public function editSeminary($seminaryId, $title, $course, $description, $latitude, $longitude)
{

6
models/SeminarycharacterfieldsModel.inc
View file

@ -57,9 +57,9 @@
/**
* Set the value of a Seminary field for a Character.
*
* @param int $characterId ID of Character
* @param int $seminarycharacterfieldId ID of seminarycharacterfield to set value of
* @param string $value Value to set
* @param int $seminarycharacterfieldId ID of seminarycharacterfield to set value of
* @param int $characterId ID of Character
* @param string $value Value to set
*/
public function setSeminaryFieldOfCharacter($seminarycharacterfieldId, $characterId, $value)
{

22
models/UploadsModel.inc
View file

@ -37,13 +37,13 @@
/**
* Upload a file and create a database record.
*
* @param int $userId ID of user that uploads the file
* @param int $seminaryId ID of Seminary
* @param string $name Name of file to upload
* @param string $filename Filename of file to upload
* @param int $userId ID of user that uploads the file
* @param int $seminaryId ID of Seminary
* @param string $name Name of file to upload
* @param string $filename Filename of file to upload
* @param string $tmpFilename Name of temporary uploaded file
* @param string $mimetype Mimetype of file to upload
* @return mixed ID of database record or false
* @param string $mimetype Mimetype of file to upload
* @return mixed ID of database record or false
*/
public function uploadSeminaryFile($userId, $seminaryId, $name, $filename, $tmpFilename, $mimetype)
{
@ -89,8 +89,8 @@
* Get an upload by its ID.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $uploadId ID of the uploaded file
* @return array Upload data
* @param int $seminaryuploadId ID of the uploaded file
* @return array Upload data
*/
public function getSeminaryuploadById($seminaryuploadId)
{
@ -114,9 +114,9 @@
* Get an upload by its URL.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of Seminary
* @param int $uploadId ID of the uploaded file
* @return array Upload data
* @param int $seminaryId ID of Seminary
* @param int $seminaryuploadUrl ID of the uploaded file
* @return array Upload data
*/
public function getSeminaryuploadByUrl($seminaryId, $seminaryuploadUrl)
{

36
models/UsersModel.inc
View file

@ -38,7 +38,9 @@
* Get count of registered users.
*
* @param string $username Only get users with the given username (optional)
* @return int Count of users
* @param string $name Only get users with the given name (optional)
* @param string $email Only get users with the given email address (optional)
* @return int Count of users
*/
public function getUsersCount($username=null, $name=null, $email=null)
{
@ -75,9 +77,11 @@
* @throws \nre\exceptions\ParamsNotValidException
* @param string $sort Field to sort by
* @param string $username Only get users with the given username (optional)
* @param int $limit Limit amount of Characters (optional)
* @param int $offset Offset (optional)
* @return array Users
* @param string $name Only get users with the given name (optional)
* @param string $email Only get users with the given email address (optional)
* @param int $limit Limit amount of Characters (optional)
* @param int $offset Offset (optional)
* @return array Users
*/
public function getUsers($sort, $username=null, $name=null, $email=null, $limit=null, $offset=0)
{
@ -133,7 +137,7 @@
* Get users with the given user role.
*
* @param string $userrole User role
* @return array List of users
* @return array List of users
*/
public function getUsersWithRole($userrole)
{
@ -154,8 +158,8 @@
* Get a user and its data by its ID.
*
* @throws \nre\exceptions\IdNotFoundException
* @param int $userId ID of an user
* @return array Userdata
* @param int $userId ID of an user
* @return array Userdata
*/
public function getUserById($userId)
{
@ -181,7 +185,7 @@
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $userUrl URL-Username of an user
* @return array Userdata
* @return array Userdata
*/
public function getUserByUrl($userUrl)
{
@ -229,8 +233,8 @@
* Check if an username already exists.
*
* @param string $username Username to check
* @param int $userId Do not check this ID (for editing)
* @return boolean Whether username exists or not
* @param int $userId Do not check this ID (for editing)
* @return boolean Whether username exists or not
*/
public function usernameExists($username, $userId=null)
{
@ -252,8 +256,8 @@
* Check if an e‑mail address already exists.
*
* @param string $email E‑mail address to check
* @param int $userId Do not check this ID (for editing)
* @return boolean Whether e‑mail address exists or not
* @param int $userId Do not check this ID (for editing)
* @return boolean Whether e‑mail address exists or not
*/
public function emailExists($email, $userId=null)
{
@ -278,7 +282,7 @@
* @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
* @return int ID of the newly created user
*/
public function createUser($username, $prename, $surname, $email, $password)
{
@ -329,7 +333,7 @@
* Edit a user.
*
* @throws \nre\exceptions\DatamodelException
* @param int $userId ID of the user to delete
* @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
@ -395,7 +399,7 @@
* Hash a password.
*
* @param string $password Plaintext password
* @return string Hashed password
* @return string Hashed password
*/
public function hash($password)
{
@ -413,7 +417,7 @@
*
* @param string $password Plaintext password to verify
* @param string $hash Hashed password to match with
* @return boolean Verified
* @return boolean Verified
*/
private function verify($password, $hash)
{

1
phpdoc.dist.xml
View file

@ -22,6 +22,7 @@
</logging>
<files>
<directory>.</directory>
<ignore>app/lib/*</ignore>
<ignore>doc/*</ignore>
<ignore>logs/*</ignore>
<ignore>media/*</ignore>

26
questtypes/bossfight/BossfightQuesttypeModel.inc
View file

@ -82,8 +82,8 @@
/**
* Get a Boss-Fight.
*
* @param int $questId ID of Quest
* @return array Boss-Fight data
* @param int $questId ID of Quest
* @return array Boss-Fight data
*/
public function getBossFight($questId)
{
@ -105,8 +105,8 @@
/**
* Get the first Stage to begin the Boss-Fight with.
*
* @param int $questId ID of Quest
* @return array Data of first Stage
* @param int $questId ID of Quest
* @return array Data of first Stage
*/
public function getFirstStage($questId)
{
@ -129,8 +129,8 @@
/**
* Get a Stage by its ID.
*
* @param int $stageId ID of Stage
* @return array Stage data or null
* @param int $stageId ID of Stage
* @return array Stage data or null
*/
public function getStageById($stageId)
{
@ -153,8 +153,8 @@
/**
* Get the follow-up Stages for a Stage.
*
* @param int $parentStageId ID of Stage to get follow-up Stages for
* @return array List of follow-up Stages
* @param int $parentStageId ID of Stage to get follow-up Stages for
* @return array List of follow-up Stages
*/
public function getChildStages($parentStageId)
{
@ -171,7 +171,7 @@
/**
* Reset all Character submissions of a Boss-Fight.
*
* @param int $questId ID of Quest
* @param int $questId ID of Quest
* @param int $characterId ID of Character
*/
public function clearCharacterSubmissions($questId, $characterId)
@ -193,7 +193,7 @@
/**
* Save Character’s submitted answer for one Boss-Fight-Stage.
*
* @param int $regexId ID of list
* @param int $stageId ID of list
* @param int $characterId ID of Character
*/
public function setCharacterSubmission($stageId, $characterId)
@ -214,9 +214,9 @@
/**
* Get answer of one Boss-Fight-Stage submitted by Character.
*
* @param int $regexId ID of list
* @param int $characterId ID of Character
* @return boolean Stage taken
* @param int $stageId ID of list
* @param int $characterId ID of Character
* @return boolean Stage taken
*/
public function getCharacterSubmission($stageId, $characterId)
{

34
questtypes/choiceinput/ChoiceinputQuesttypeModel.inc
View file

@ -111,8 +111,8 @@
/**
* Get choiceinput-text for a Quest.
*
* @param int $questId ID of Quest
* @return array Choiceinput-text
* @param int $questId ID of Quest
* @return array Choiceinput-text
*/
public function getChoiceinputQuest($questId)
{
@ -135,8 +135,8 @@
/**
* Get all lists of input values for a choiceinput-text.
*
* @param int $questId ID of Quest
* @return array List
* @param int $questId ID of Quest
* @return array List
*/
public function getChoiceinputLists($questId)
{
@ -154,8 +154,8 @@
/**
* Get the list of values for a choiceinput-list.
*
* @param int $listId ID of list
* @return array Input values
* @param int $listId ID of list
* @return array Input values
*/
public function getChoiceinputChoices($listId)
{
@ -173,9 +173,9 @@
/**
* Save Character’s submitted answer for one choiceinput-list.
*
* @param int $regexId ID of list
* @param int $characterId ID of Character
* @param string $answer Submitted answer for this list
* @param int $listId ID of list
* @param int $characterId ID of Character
* @param string $answer Submitted answer for this list
*/
public function setCharacterSubmission($listId, $characterId, $answer)
{
@ -211,9 +211,9 @@
/**
* Get answer of one choiceinput-list submitted by Character.
*
* @param int $regexId ID of list
* @param int $characterId ID of Character
* @return int Submitted answer for this list or null
* @param int $listId ID of list
* @param int $characterId ID of Character
* @return int Submitted answer for this list or null
*/
public function getCharacterSubmission($listId, $characterId)
{
@ -236,8 +236,8 @@
/**
* Set the text for a Quest and correct choice input lists count.
*
* @param int $userId ID of user setting text
* @param int $questId ID of Quest to set text for
* @param int $userId ID of user setting text
* @param int $questId ID of Quest to set text for
* @param string $text Text for Quest
*/
public function setTextForQuest($userId, $questId, $text)
@ -300,10 +300,10 @@
/**
* Set list of choices for a text.
*
* @param int $questId ID of Quest to set choices for
* @param int $number List number
* @param int $questId ID of Quest to set choices for
* @param int $number List number
* @param array $choices List of choices
* @param int $correctPos Position of correct answer
* @param int $correctPos Position of correct answer
*/
public function setListForText($questId, $number, $choices, $correctPos)
{

16
questtypes/crossword/CrosswordQuesttypeModel.inc
View file

@ -61,8 +61,8 @@
/**
* Get all words for a crossword-Quest.
*
* @param int $questId ID of Quest
* @return array Words
* @param int $questId ID of Quest
* @return array Words
*/
public function getWordsForQuest($questId)
{
@ -79,9 +79,9 @@
/**
* Save Character’s submitted answer for one crossword-word.
*
* @param int $regexId ID of word
* @param int $characterId ID of Character
* @param string $answer Submitted answer for this word
* @param int $wordId ID of word
* @param int $characterId ID of Character
* @param string $answer Submitted answer for this word
*/
public function setCharacterSubmission($wordId, $characterId, $answer)
{
@ -102,9 +102,9 @@
/**
* Get answer of one crossword-word submitted by Character.
*
* @param int $regexId ID of lisword
* @param int $characterId ID of Character
* @return int Submitted answer for this word or null
* @param int $wordId ID of word
* @param int $characterId ID of Character
* @return int Submitted answer for this word or null
*/
public function getCharacterSubmission($wordId, $characterId)
{

5
questtypes/textinput/TextinputQuesttypeController.inc
View file

@ -32,6 +32,11 @@
*/
const KEY_QUESTTYPEDATA_N_CORRECT_ANSWRES = 'nCorrectAnswers';
/**
* Number of correct answers
*
* @var int
*/
private $nCorrectAnswers = null;

14
stationtypes/multiplechoice/MultiplechoiceStationtypeController.inc
View file

@ -31,7 +31,7 @@
* Save the answer of a Character group for a Station.
*
* @param array $seminary Current Seminary data
* @param array $questgroup Current Questgroup data
* @param array $groupsgroup Current Groups group data
* @param array $quest Current Quest data
* @param array $station Current Station data
* @param array $charactergroup Current Character group data
@ -53,7 +53,7 @@
* Check if answer of a Character group for a Station matches the correct one.
*
* @param array $seminary Current Seminary data
* @param array $questgroup Current Questgroup data
* @param array $groupsgroup Current Groups group data
* @param array $quest Current Quest data
* @param array $station Current Station data
* @param array $charactergroup Current Character group data
@ -92,11 +92,11 @@
*
* Show the task of a Station.
*
* @param array $seminary Current Seminary data
* @param array $questgroup Current Questgroup data
* @param array $quest Current Quest data
* @param array $station Current Station data
* @param array $charactergroup Current Character group data
* @param array $seminary Current Seminary data
* @param array $groupsgroup Current Groups group data
* @param array $quest Current Quest data
* @param array $station Current Station data
* @param array $charactergroup Current Character group data
*/
public function quest($seminary, $groupsgroup, $quest, $station, $charactergroup)
{

14
stationtypes/singlechoice/SinglechoiceStationtypeController.inc
View file

@ -31,7 +31,7 @@
* Save the answer of a Character group for a Station.
*
* @param array $seminary Current Seminary data
* @param array $questgroup Current Questgroup data
* @param array $groupsgroup Current Groups group data
* @param array $quest Current Quest data
* @param array $station Current Station data
* @param array $charactergroup Current Character group data
@ -51,7 +51,7 @@
* Check if answer of a Character group for a Station matches the correct one.
*
* @param array $seminary Current Seminary data
* @param array $questgroup Current Questgroup data
* @param array $groupsgroup Current Groups group data
* @param array $quest Current Quest data
* @param array $station Current Station data
* @param array $charactergroup Current Character group data
@ -74,11 +74,11 @@
*
* Show the task of a Station.
*
* @param array $seminary Current Seminary data
* @param array $questgroup Current Questgroup data
* @param array $quest Current Quest data
* @param array $station Current Station data
* @param array $charactergroup Current Character group data
* @param array $seminary Current Seminary data
* @param array $groupsgroup Current Groups group data
* @param array $quest Current Quest data
* @param array $station Current Station data
* @param array $charactergroup Current Character group data
*/
public function quest($seminary, $groupsgroup, $quest, $station, $charactergroup)
{