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

12
app/agents/StationtypeAgent.inc
View file

@ -200,11 +200,11 @@
* 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 $group Current Character data
* @param array $answers Character answers for the Quest
* @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)
{
@ -224,11 +224,11 @@
* 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 $group Current Character group data
* @param array $answers Character answers for the Quest
* @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)

8
controllers/LibraryController.inc
View file

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

4
controllers/MediaController.inc
View file

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

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

11
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)
{
@ -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();

2
controllers/QuestsController.inc
View file

@ -1357,7 +1357,7 @@
* Create a response for the Questtype 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 createQuesttypeResponse($action, $param1)

2
controllers/components/ValidationComponent.inc
View file

@ -155,7 +155,7 @@
*
* @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
* @param mixed $results Validation result
* @return mixed The altered validation array
*/
public function addValidationResults($validation, $index, $results)

4
models/AchievementsModel.inc
View file

@ -270,7 +270,7 @@
* Get the rank for the number of achieved Achievements.
*
* @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
*/
public function getCountRank($seminaryId, $count)
@ -1186,7 +1186,7 @@
*
* @param int $seminaryId ID of Seminary
* @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
*/
public function achievementTitleExists($seminaryId, $title, $achievementId=null)

4
models/CharactergroupsModel.inc
View file

@ -351,7 +351,7 @@
* Get a Character group by its ID.
*
* @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
*/
public function getGroupById($groupId)
@ -544,7 +544,7 @@
/**
* 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
* @return int Rank of XP-value
*/

4
models/CharactergroupsachievementsModel.inc
View file

@ -359,10 +359,8 @@
* 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 $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
* @param array $questIds Mapping of Quest-IDs from source Seminary to target Seminary (optional)
*/
public function copyAchievementsOfSeminary($userId, $characterGroupsgroupIds, $seminaryMediaIds=null)
{

2
models/CharactergroupsquestsModel.inc
View file

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

4
models/CharactergroupsqueststationsModel.inc
View file

@ -116,7 +116,7 @@
* Get a Station by its Hash.
*
* @throws \nre\exceptions\IdNotFoundException
* @param string $stationUrl Hash of Station to get
* @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
*/

2
models/CharacterrolesModel.inc
View file

@ -37,7 +37,7 @@
/**
* 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
*/
public function getCharacterrolesForCharacterById($characterId)

2
models/CharactersModel.inc
View file

@ -358,7 +358,7 @@
* Get Characters with the most amount of Achievements.
*
* @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)
* @return array List of Characters
*/

2
models/CharactertypesModel.inc
View file

@ -57,7 +57,7 @@
* Get Character type by its URL.
*
* @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
*/
public function getCharactertypeByUrl($seminaryId, $charactertypeUrl)

8
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)
@ -115,7 +115,7 @@
* Get a Seminary medium by its ID.
*
* @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
*/
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)
{
@ -403,7 +403,7 @@
* Copy a Questgroup picture.
*
* @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)
{

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)

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