olli/questlab
Watch
1
0
Fork
You've already forked questlab
 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
commit 6cda0556da
36 changed files with 679 additions and 659 deletions
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. * Save the answer of a Character group for a Station.
* *
* @param array $seminary Current Seminary data * @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 $quest Current Quest data
* @param array $station Current Station data * @param array $station Current Station data
* @param array $group Current Character data * @param array $charactergroup Current Character group data
* @param array $answers Character answers for the Quest * @param array $answer Character group answer for the Station
*/ */
public function saveAnswer($seminary, $groupsgroup, $quest, $station, $group, $answer) 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 * Check if the answer of a Character group for a Station matches the
* correct one. * correct one.
* *
* @param array $seminary Current Seminary data * @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 $quest Current Quest data
* @param array $station Current Station data * @param array $station Current Station data
* @param array $group Current Character group data * @param array $charactergroup Current Character group data
* @param array $answers Character answers for the Quest * @param array $answer Character group answer for the Station
*/ */
public function matchAnswer($seminary, $groupsgroup, $quest, $station, $group, $answer) 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 string $stationtypeClassname Name of the class for the Stationtype of a Station
* @param array $seminary Seminary data * @param array $seminary Seminary data
* @param array $questgroup Questgroup data * @param array $groupsgroup Groups-group data
* @param array $quest Quest data * @param array $quest Quest data
* @param array $station Station data * @param array $station Station data
* @param array $charactergroup Charactergroup data * @param array $charactergroup Charactergroup data
@ -1164,7 +1164,7 @@
* Create a response for the Stationtype rendering. * Create a response for the Stationtype rendering.
* *
* @param string $action Action to run * @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 * @return \nre\core\Response Generated response
*/ */
private function createStationtypeResponse($action, $param1) private function createStationtypeResponse($action, $param1)

12
controllers/LibraryController.inc
View file

@ -67,7 +67,7 @@
* List Questtopics of a Seminary. * List Questtopics of a Seminary.
* *
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary * @param string $seminaryUrl URL-Title of Seminary
*/ */
public function index($seminaryUrl) public function index($seminaryUrl)
{ {
@ -111,7 +111,7 @@
* Show a Questtopic and its Quests with Questsubtopics. * Show a Questtopic and its Quests with Questsubtopics.
* *
* @throws \nre\exceptions\IdNotFoundException * @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 * @param string $questtopicUrl URL-Title of Questtopic
*/ */
public function topic($seminaryUrl, $questtopicUrl) public function topic($seminaryUrl, $questtopicUrl)
@ -159,7 +159,7 @@
* Manage a Questtopic and its Quests with Questsubtopics. * Manage a Questtopic and its Quests with Questsubtopics.
* *
* @throws \nre\exceptions\IdNotFoundException * @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 * @param string $questtopicUrl URL-Title of Questtopic
*/ */
public function manage($seminaryUrl, $questtopicUrl) public function manage($seminaryUrl, $questtopicUrl)
@ -233,7 +233,7 @@
* Create a new Questtopic for a Seminary. * Create a new Questtopic for a Seminary.
* *
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary * @param string $seminaryUrl URL-Title of Seminary
*/ */
public function create($seminaryUrl) public function create($seminaryUrl)
{ {
@ -296,7 +296,7 @@
* Edit a Questtopic of a Seminary and its Questsubtopics. * Edit a Questtopic of a Seminary and its Questsubtopics.
* *
* @throws \nre\exceptions\IdNotFoundException * @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 * @param string $questtopicUrl URL-Title of Questtopic
*/ */
public function edit($seminaryUrl, $questtopicUrl) public function edit($seminaryUrl, $questtopicUrl)
@ -472,7 +472,7 @@
* Delete a Questtopic of a Seminary. * Delete a Questtopic of a Seminary.
* *
* @throws \nre\exceptions\IdNotFoundException * @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 * @param string $questtopicUrl URL-Title of Questtopic
*/ */
public function delete($seminaryUrl, $questtopicUrl) 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. * Generate a mail message to notify of a new user registration.
* *
* @param array $receiver User that the message will be send to * @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) public function userregistration($receiver, $newUser)
{ {

2
controllers/MailreceiverController.inc
View file

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

22
controllers/MediaController.inc
View file

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

3
controllers/MoodpicController.inc
View file

@ -47,6 +47,7 @@
* Show moodpic of a Seminary. * Show moodpic of a Seminary.
* *
* @param string $seminaryUrl URL of Seminary to show moodpic of * @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) public function seminary($seminaryUrl, $agentName=null)
{ {
@ -86,7 +87,7 @@
* Show moodpic of a Questgroup. * Show moodpic of a Questgroup.
* *
* @param string $seminaryUrl URL of Seminary * @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) public function questgroup($seminaryUrl, $questgroupUrl)
{ {

21
controllers/QrcodesController.inc
View file

@ -53,8 +53,8 @@
* *
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of a Seminary * @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 string $achievementUrl URL of Achievement
* @param int $size QR-code size
*/ */
public function achievement($seminaryUrl, $achievementUrl, $size=1) public function achievement($seminaryUrl, $achievementUrl, $size=1)
{ {
@ -129,6 +129,7 @@
* @param string $groupsgroupUrl URL-Title of a Character groups-group * @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
* @param string $stationUrl URL of Character groups Quest station * @param string $stationUrl URL of Character groups Quest station
* @param int $size QR-code size
*/ */
public function charactergroupsqueststation($seminaryUrl, $groupsgroupUrl, $questUrl, $stationUrl, $size=1) public function charactergroupsqueststation($seminaryUrl, $groupsgroupUrl, $questUrl, $stationUrl, $size=1)
{ {
@ -166,6 +167,7 @@
* @param string $seminaryUrl URL-Title of a Seminary * @param string $seminaryUrl URL-Title of a Seminary
* @param string $groupsgroupUrl URL-Title of a Character groups-group * @param string $groupsgroupUrl URL-Title of a Character groups-group
* @param string $achievementUrl URL of Achievement * @param string $achievementUrl URL of Achievement
* @param int $size QR-code size
*/ */
public function charactergroupsachievements($seminaryUrl, $groupsgroupUrl, $achievementUrl, $size=1) public function charactergroupsachievements($seminaryUrl, $groupsgroupUrl, $achievementUrl, $size=1)
{ {
@ -201,7 +203,7 @@
* caching accordingly. * caching accordingly.
* *
* @param string $fileName Filename * @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) 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) private function generateQRcode($text, $size)
{ {
\hhu\z\lib\Phpqrcode::load(); \hhu\z\lib\Phpqrcode::load();
@ -250,7 +259,7 @@
* @throws \nre\exceptions\ParamsNotValidException * @throws \nre\exceptions\ParamsNotValidException
* @param array $media Medium to get file for * @param array $media Medium to get file for
* @param string $action Action for processing the media * @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) private function getMediaFile($media, $action=null)
{ {
@ -327,9 +336,9 @@
* *
* @param string $fileName Absolute pathname of image to resize * @param string $fileName Absolute pathname of image to resize
* @param string $mimeType Mimetype of target image * @param string $mimeType Mimetype of target image
* @param int $width Max. width to resize to * @param int $width Max. width to resize to
* @param int $height Max. height to resize to * @param int $height Max. height to resize to
* @return mixed Resized image * @return mixed Resized image
*/ */
private static function resizeImage($fileName, $mimeType, $width, $height) private static function resizeImage($fileName, $mimeType, $width, $height)
{ {

74
controllers/QuestsController.inc
View file

@ -88,7 +88,7 @@
* List all Quests for a Seminary. * List all Quests for a Seminary.
* *
* @param string $seminaryUrl URL-Title of 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) public function index($seminaryUrl, $all=null)
{ {
@ -155,9 +155,9 @@
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary * @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup * @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 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) public function quest($seminaryUrl, $questgroupUrl, $questUrl, $questtexttypeUrl=null, $questtextPos=1)
{ {
@ -366,7 +366,7 @@
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary * @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup * @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) public function submissions($seminaryUrl, $questgroupUrl, $questUrl)
{ {
@ -414,7 +414,7 @@
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary * @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup * @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 * @param string $characterUrl URL-Title of Character
*/ */
public function submission($seminaryUrl, $questgroupUrl, $questUrl, $characterUrl) public function submission($seminaryUrl, $questgroupUrl, $questUrl, $characterUrl)
@ -616,8 +616,8 @@
* Edit a Quest of a Seminary. * Edit a Quest of a Seminary.
* *
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary * @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup * @param string $questgroupUrl URL-Title of Questgroup
* @param string $questUrl URL-Title of Quest * @param string $questUrl URL-Title of Quest
*/ */
public function edit($seminaryUrl, $questgroupUrl, $questUrl) public function edit($seminaryUrl, $questgroupUrl, $questUrl)
@ -790,8 +790,8 @@
* Edit the task of a Quest of a Seminary. * Edit the task of a Quest of a Seminary.
* *
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary * @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup * @param string $questgroupUrl URL-Title of Questgroup
* @param string $questUrl URL-Title of Quest * @param string $questUrl URL-Title of Quest
*/ */
public function edittask($seminaryUrl, $questgroupUrl, $questUrl) public function edittask($seminaryUrl, $questgroupUrl, $questUrl)
@ -833,8 +833,8 @@
* Edit the texts of a Quest of a Seminary. * Edit the texts of a Quest of a Seminary.
* *
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary * @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup * @param string $questgroupUrl URL-Title of Questgroup
* @param string $questUrl URL-Title of Quest * @param string $questUrl URL-Title of Quest
*/ */
public function edittexts($seminaryUrl, $questgroupUrl, $questUrl) public function edittexts($seminaryUrl, $questgroupUrl, $questUrl)
@ -1058,8 +1058,8 @@
* Delete a Quest of a Seminary. * Delete a Quest of a Seminary.
* *
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of Seminary * @param string $seminaryUrl URL-Title of Seminary
* @param string $questgroupUrl URL-Title of Questgroup * @param string $questgroupUrl URL-Title of Questgroup
* @param string $questUrl URL-Title of Quest * @param string $questUrl URL-Title of Quest
*/ */
public function delete($seminaryUrl, $questgroupUrl, $questUrl) public function delete($seminaryUrl, $questgroupUrl, $questUrl)
@ -1112,11 +1112,11 @@
* Render and handle the task of a Quest. * Render and handle the task of a Quest.
* *
* @param string $questtypeClassname Name of the class for the Questtype of a Quest * @param string $questtypeClassname Name of the class for the Questtype of a Quest
* @param array $seminary Seminary data * @param array $seminary Seminary data
* @param array $questgroup Questgroup data * @param array $questgroup Questgroup data
* @param array $quest Quest data * @param array $quest Quest data
* @param array $character Character data * @param array $character Character data
* @return string Rendered output * @return string Rendered output
*/ */
private function renderTask($questtypeClassname, $seminary, $questgroup, $quest, $character) private function renderTask($questtypeClassname, $seminary, $questgroup, $quest, $character)
{ {
@ -1223,11 +1223,11 @@
* Render and handle a Character submission for a Quest. * Render and handle a Character submission for a Quest.
* *
* @param string $questtypeClassname Name of the class for the Questtype of a Quest * @param string $questtypeClassname Name of the class for the Questtype of a Quest
* @param array $seminary Seminary data * @param array $seminary Seminary data
* @param array $questgroup Questgroup data * @param array $questgroup Questgroup data
* @param array $quest Quest data * @param array $quest Quest data
* @param array $character Character data * @param array $character Character data
* @return string Rendered output * @return string Rendered output
*/ */
private function renderTaskSubmission($questtypeClassname, $seminary, $questgroup, $quest, $character) private function renderTaskSubmission($questtypeClassname, $seminary, $questgroup, $quest, $character)
{ {
@ -1303,10 +1303,10 @@
* Render editing of a Quest. * Render editing of a Quest.
* *
* @param string $questtypeClassname Name of the class for the Questtype of a Quest * @param string $questtypeClassname Name of the class for the Questtype of a Quest
* @param array $seminary Seminary data * @param array $seminary Seminary data
* @param array $questgroup Questgroup data * @param array $questgroup Questgroup data
* @param array $quest Quest data * @param array $quest Quest data
* @return string Rendered output * @return string Rendered output
*/ */
private function renderTaskEditing($questtypeClassname, $seminary, $questgroup, $quest) private function renderTaskEditing($questtypeClassname, $seminary, $questgroup, $quest)
{ {
@ -1356,9 +1356,9 @@
/** /**
* Create a response for the Questtype rendering. * Create a response for the Questtype rendering.
* *
* @param string $action Action to run * @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 * @return \nre\core\Response Generated response
*/ */
private function createQuesttypeResponse($action, $param1) private function createQuesttypeResponse($action, $param1)
{ {
@ -1387,10 +1387,10 @@
/** /**
* Load and construct the QuesttypeAgent for a Questtype. * Load and construct the QuesttypeAgent for a Questtype.
* *
* @param string $questtypeClassname Name of the class for the Questtype of a Quest * @param string $questtypeClassname Name of the class for the Questtype of a Quest
* @param \nre\core\Request $request Request * @param \nre\core\Request $request Request
* @param \nre\core\Response $response Response * @param \nre\core\Response $response Response
* @return \hhu\z\agents\QuesttypeAgent Questtype Agent * @return \hhu\z\agents\QuesttypeAgent Questtype Agent
*/ */
private function loadQuesttypeAgent($questtypeClassname, $request, $response) private function loadQuesttypeAgent($questtypeClassname, $request, $response)
{ {
@ -1407,9 +1407,9 @@
* Run and render the Agent for a QuesttypeAgent and return ist output. * 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\Agent $questtypeAgent QuesttypeAgent to run and render
* @param \nre\core\Request $request Request * @param \nre\core\Request $request Request
* @param \nre\core\Response $response Response * @param \nre\core\Response $response Response
* @return string Rendered output * @return string Rendered output
*/ */
private function runQuesttypeAgent($questtypeAgent, $request, $response) 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 mixed $input User input to validate
* @param array $settings Validation setting * @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) public function validate($input, $settings)
{ {
@ -80,7 +80,7 @@
* *
* @param array $params User input parameters * @param array $params User input parameters
* @param array $index Names of parameter to validate and to validate against * @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) public function validateParam($params, $index)
{ {
@ -104,7 +104,7 @@
* *
* @param array $params User input parameters * @param array $params User input parameters
* @param array $indices Names of parameters to validate and to validate against * @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) public function validateParams($params, $indices)
{ {
@ -128,7 +128,7 @@
* @param string $index Name of parameter of the custom validation result * @param string $index Name of parameter of the custom validation result
* @param string $setting Name of setting of the custom validation result * @param string $setting Name of setting of the custom validation result
* @param mixed $result 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) public function addValidationResult($validation, $index, $setting, $result)
{ {
@ -155,8 +155,8 @@
* *
* @param mixed $validation Validation array to add result to * @param mixed $validation Validation array to add result to
* @param string $index Name of parameter of the custom validation result * @param string $index Name of parameter of the custom validation result
* @param mixed $result Validation result * @param mixed $results Validation result
* @return mixed The altered validation array * @return mixed The altered validation array
*/ */
public function addValidationResults($validation, $index, $results) public function addValidationResults($validation, $index, $results)
{ {

274
models/AchievementsModel.inc
View file

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

68
models/CharactergroupsModel.inc
View file

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

10
models/CharactergroupsachievementsModel.inc
View file

@ -269,7 +269,7 @@
* position). * position).
* *
* @param array $achievement Achievement to move * @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) public function moveAchievement($achievement, $up)
{ {
@ -358,11 +358,9 @@
/** /**
* Copy all Achievements of a Seminary. * Copy all Achievements of a Seminary.
* *
* @param int $userId ID of creating user * @param int $userId ID of creating user
* @param int $sourceSeminaryId Seminary to copy from * @param array $characterGroupsgroupIds Mapping of Character groups-group IDs from source Seminary to target Seminary
* @param int $targetSeminaryId Seminary to copy to * @param array $seminaryMediaIds Mapping of Seminarymedia-IDs from source Seminary to target Seminary
* @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)
*/ */
public function copyAchievementsOfSeminary($userId, $characterGroupsgroupIds, $seminaryMediaIds=null) 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. * Get Character groups Quests of a Character groups-groups.
* *
* @param int $groupsgroupId ID of the Character groups-group * @param int $groupsgroupId ID of the Character groups-group
* @return array Character groups Quest data * @return array Character groups Quest data
*/ */
public function getQuestsForCharactergroupsgroup($groupsgroupId) public function getQuestsForCharactergroupsgroup($groupsgroupId)
{ {
@ -64,9 +64,9 @@
* Get a Character groups Quest by its URL. * Get a Character groups Quest by its URL.
* *
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param int $groupsgroupId ID of the Character groups-group * @param int $groupsgroupId ID of the Character groups-group
* @param string $questUrl URL-title of the Character groups Quest * @param string $questUrl URL-title of the Character groups Quest
* @return array Character groups Quest data * @return array Character groups Quest data
*/ */
public function getQuestByUrl($groupsgroupId, $questUrl) public function getQuestByUrl($groupsgroupId, $questUrl)
{ {
@ -91,8 +91,8 @@
* Get a Character groups Quest by its ID. * Get a Character groups Quest by its ID.
* *
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param int $questId ID of the Character groups Quest * @param int $questId ID of the Character groups Quest
* @return array Character groups Quest data * @return array Character groups Quest data
*/ */
public function getQuestById($questId) public function getQuestById($questId)
{ {
@ -115,8 +115,8 @@
/** /**
* Get Character groups Quests for a Character group. * Get Character groups Quests for a Character group.
* *
* @param int $groupId ID of the Character group * @param int $groupId ID of the Character group
* @return array Character groups Quests * @return array Character groups Quests
*/ */
public function getQuestsForGroup($groupId) public function getQuestsForGroup($groupId)
{ {
@ -141,9 +141,9 @@
/** /**
* Get XPs of a Character group for a Character groups Quest. * Get XPs of a Character group for a Character groups Quest.
* *
* @param int $questId ID of Character groups Quest * @param int $questId ID of Character groups Quest
* @param int $groupId ID of Character group to get XPs of * @param int $groupId ID of Character group to get XPs of
* @return array XP-record * @return array XP-record
*/ */
public function getXPsOfGroupForQuest($questId, $groupId) public function getXPsOfGroupForQuest($questId, $groupId)
{ {
@ -171,8 +171,8 @@
/** /**
* Set XPs of a Character group for a Character groups Quest. * Set XPs of a Character group for a Character groups Quest.
* *
* @param int $questId ID of Character groups Quest * @param int $questId ID of Character groups Quest
* @param int $groupId ID of Character group to set XPs of * @param int $groupId ID of Character group to set XPs of
* @param float $xpsFactor XPs-factor * @param float $xpsFactor XPs-factor
*/ */
public function setXPsOfGroupForQuest($questId, $groupId, $xpsFactor) public function setXPsOfGroupForQuest($questId, $groupId, $xpsFactor)
@ -214,7 +214,7 @@
* Check if a Character groups Quest title already exists. * Check if a Character groups Quest title already exists.
* *
* @param int $groupsgroupId ID of Character groups-group * @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) * @param int $questId Do not check this ID (for editing)
* @return boolean Whether Character groups Quest title exists or not * @return boolean Whether Character groups Quest title exists or not
*/ */
@ -256,12 +256,12 @@
/** /**
* Upload a media for a Character groups Quest. * Upload a media for a Character groups Quest.
* *
* @param int $userId ID of user that does the upload * @param int $userId ID of user that does the upload
* @param int $seminaryId ID of Seminary * @param int $seminaryId ID of Seminary
* @param int $questId ID of Quest to upload media for * @param int $questId ID of Quest to upload media for
* @param array $file File-array of file to upload * @param array $file File-array of file to upload
* @param string $filename Filename for media * @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) public function uploadMediaForQuest($userId, $seminaryId, $questId, $file, $filename)
{ {
@ -289,8 +289,8 @@
/** /**
* Get uploaded Medai for a Character groups Quest. * Get uploaded Medai for a Character groups Quest.
* *
* @param int $questId ID of Quest to get media for * @param int $questId ID of Quest to get media for
* @return array Seminary uploads * @return array Seminary uploads
*/ */
public function getMediaForQuest($questId) public function getMediaForQuest($questId)
{ {
@ -307,16 +307,16 @@
/** /**
* Create a new Character groups Quest. * Create a new Character groups Quest.
* *
* @param int $userId ID of user * @param int $userId ID of user
* @param int $groupsgroupId ID of Character groups-group * @param int $groupsgroupId ID of Character groups-group
* @param int $questgroupId ID of Quest group * @param int $questgroupId ID of Quest group
* @param string $title Title of new Quest * @param string $title Title of new Quest
* @param string $description Description of new Quset * @param string $description Description of new Quset
* @param int $xps Amount of XPs for new Quest * @param int $xps Amount of XPs for new Quest
* @param string $rules Rules of new Quest * @param string $rules Rules of new Quest
* @param string $wonText Won-text of new Quset * @param string $wonText Won-text of new Quset
* @param string $lostText Lost-text of new Quest * @param string $lostText Lost-text of new Quest
* @return int ID of newly created Quest * @return int ID of newly created Quest
*/ */
public function createQuest($userId, $groupsgroupId, $questgroupId, $title, $description, $xps, $rules, $wonText, $lostText) 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. * Get a Station by its Hash.
* *
* @throws \nre\exceptions\IdNotFoundException * @throws \nre\exceptions\IdNotFoundException
* @param string $stationUrl Hash of Station to get * @param string $stationHash Hash of Station to get
* @return array Station data * @return array Station data
*/ */
public function getStationByHash($stationHash) public function getStationByHash($stationHash)
{ {
@ -332,7 +332,7 @@
/** /**
* Check if a Character group has solved a Station. * 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 * @param int $groupId ID of Character to check
* @result boolean Whether Character has solved the Quest or not * @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. * Get all characterroles for a Character referenced by its ID.
* *
* @param int $userId ID of an user * @param int $characterId ID of Character
* @return array Characterroles for a Character * @return array Characterroles for a Character
*/ */
public function getCharacterrolesForCharacterById($characterId) public function getCharacterrolesForCharacterById($characterId)
{ {
@ -56,7 +56,7 @@
/** /**
* Add a role to a Character. * 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 * @param string $characterrole Role to add
*/ */
public function addCharacterroleToCharacter($characterId, $characterrole) public function addCharacterroleToCharacter($characterId, $characterrole)
@ -77,7 +77,7 @@
/** /**
* Remove a role from a Character. * 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 * @param string $characterrole Role to remove
*/ */
public function removeCharacterroleFromCharacter($characterId, $characterrole) public function removeCharacterroleFromCharacter($characterId, $characterrole)

88
models/CharactersModel.inc
View file

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

30
models/CharactertypesModel.inc
View file

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

16
models/MediaModel.inc
View file

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

6
models/PagesModel.inc
View file

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

Some files were not shown because too many files have changed in this diff Show more