correct docstrings

This commit is contained in:
coderkun 2015-03-06 11:09:35 +01:00
commit 01a9c81f81
78 changed files with 275 additions and 62 deletions

View file

@ -132,9 +132,10 @@
/**
* Get seldom Achievements.
*
* @param int $seminaryId ID of Seminary
* @param int $count Number of Achievements to retrieve
* @return array List of seldom Achievements
* @param int $seminaryId ID of Seminary
* @param int $count Number of Achievements to retrieve
* @param bool $alsoWithDeadline Include Achievements with deadline (optional)
* @return array List of seldom Achievements
*/
public function getSeldomAchievements($seminaryId, $count, $alsoWithDeadline=true)
{
@ -161,6 +162,7 @@
* Get all achieved Achievements for a Character.
*
* @param int $characterId ID of Character
* @param bool $alsoWithDeadline Include Achievements with deadline (optional)
* @return array Achievements data
*/
public function getAchievedAchievementsForCharacter($characterId, $alsoWithDeadline=true)

View file

@ -193,6 +193,7 @@
* Get Character groups for a Character groups-group.
*
* @param int $groupsgroupId ID of the Character groups-group
* @param string $sortorder Field to sort by (optional)
* @return array Character groups
*/
public function getGroupsForGroupsgroup($groupsgroupId, $sortorder='name')

View file

@ -92,6 +92,7 @@
* Get Characters for a Seminary.
*
* @param int $seminaryId ID of the Seminary
* @param bool $onlyWithRole Only Characters that have at least one role assigned (optional)
* @return array Characters
*/
public function getCharactersForSeminary($seminaryId, $onlyWithRole=false)
@ -356,9 +357,10 @@
/**
* Get Characters with the most amount of Achievements.
*
* @param int $seminaryId ID of Seminary
* @param int $conut Amount of Characters to retrieve
* @return array List of Characters
* @param int $seminaryId ID of Seminary
* @param int $conut Amount of Characters to retrieve
* @param bool $alsoWithDeadline Include Achievements with deadline (optional)
* @return array List of Characters
*/
public function getCharactersWithMostAchievements($seminaryId, $count, $alsoWithDeadline=true)
{
@ -458,6 +460,7 @@
* Get the inferior $count Characters in the ranking.
*
* @param int $seminaryId ID of Seminary
* @param int characterId ID of Character
* @param int $xps XP-value of Character
* @param int $count Count of Characters to determine
* @return array List of inferior Characters

View file

@ -811,7 +811,7 @@
}
/*
/**
* Calculate the total amount of achievable XPs for a Quest and
* its following Quests by choosing the path with the highest
* amount of XPs.

View file

@ -62,7 +62,8 @@
/**
* Get a Questgroup hierarchy by its URL.
*
* throws IdNotFoundException
* @throws IdNotFoundException
* @param int $seminaryId ID of Seminary
* @param int $questgroupshierarchyURL URL of a Questgroup hierarchy
* @return array Questgroup hierarchy
*/

View file

@ -394,6 +394,7 @@
* @param int $seminaryId ID of Seminary
* @param int $questgroupId ID of Questgroup (optional)
* @param int $questtypeId ID of Questtype (optional)
* @param string $title Part of the title to filter for (optional)
* @return int Count of Quests for this Seminary
*/
public function getCountForQuestsForSeminaryByOpenSubmissions($seminaryId, $questgroupId=null, $questtypeId=null, $title=null)
@ -425,6 +426,7 @@
* @param int $seminaryId ID of Seminary
* @param int $questgroupId ID of Questgroup (optional)
* @param int $questtypeId ID of Questtype (optional)
* @param string $title Part of title to filter for (optional)
* @param int $limit Limit amount of Quests (optional)
* @param int $offset Offset (optional)
* @return array Quests for this Seminary

View file

@ -149,6 +149,13 @@
}
/**
* Get the Questtext that was last entered by a Character.
*
* @param int $characterId ID of Character
* @param array $questtexts List of Questtexts to look into
* @return array Questtext data
*/
public function pickQuesttextLastEnteredByCharacter($characterId, $questtexts)
{
if(count($questtexts) == 0) {

View file

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

View file

@ -82,6 +82,7 @@
/**
* Get Seminary Character fields of a Character.
*
* @param int $fieldId ID of Seminary Character field
* @param int $characterId ID of the Character
* @return array Seminary Character fields
*/

View file

@ -248,6 +248,8 @@
* Create a new user.
*
* @param string $username Username of the user to create
* @param string $prename Prename of the user to create
* @param string $surname Surname of the user to create
* @param string $email EMail-Address of the user to create
* @param string $password Password of the user to create
* @return int ID of the newly created user
@ -303,8 +305,11 @@
* @throws DatamodelException
* @param int $userId ID of the user to delete
* @param string $username New name of user
* @param string $prename Prename of the user to create
* @param string $surname Surname of the user to create
* @param string $email Changed email-address of user
* @param string $password Changed plaintext password of user
* @param bool $mailing Whether to activate mailing or not
*/
public function editUser($userId, $username, $prename, $surname, $email, $password, $mailing)
{