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

fix many docstrings and their formatting

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

4
controllers/CharactergroupsqueststationsController.inc
View file

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

12
controllers/LibraryController.inc
View file

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

2
controllers/MailController.inc
View file

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

2
controllers/MailreceiverController.inc
View file

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

22
controllers/MediaController.inc
View file

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

3
controllers/MoodpicController.inc
View file

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

21
controllers/QrcodesController.inc
View file

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

74
controllers/QuestsController.inc
View file

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

12
controllers/components/ValidationComponent.inc
View file

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