fix many docstrings and their formatting
This commit is contained in:
parent
e50c2bb5e6
commit
7085de8fe2
36 changed files with 679 additions and 659 deletions
|
@ -199,12 +199,12 @@
|
|||
/**
|
||||
* Save the answer of a Character group for a Station.
|
||||
*
|
||||
* @param array $seminary Current Seminary data
|
||||
* @param array $questgroup Current Questgroup data
|
||||
* @param array $quest Current Quest data
|
||||
* @param array $station Current Station data
|
||||
* @param array $group Current Character data
|
||||
* @param array $answers Character answers for the Quest
|
||||
* @param array $seminary Current Seminary data
|
||||
* @param array $groupsgroup Current Groups group data
|
||||
* @param array $quest Current Quest data
|
||||
* @param array $station Current Station data
|
||||
* @param array $charactergroup Current Character group data
|
||||
* @param array $answer Character group answer for the Station
|
||||
*/
|
||||
public function saveAnswer($seminary, $groupsgroup, $quest, $station, $group, $answer)
|
||||
{
|
||||
|
@ -223,12 +223,12 @@
|
|||
* Check if the answer of a Character group for a Station matches the
|
||||
* correct one.
|
||||
*
|
||||
* @param array $seminary Current Seminary data
|
||||
* @param array $questgroup Current Questgroup data
|
||||
* @param array $quest Current Quest data
|
||||
* @param array $station Current Station data
|
||||
* @param array $group Current Character group data
|
||||
* @param array $answers Character answers for the Quest
|
||||
* @param array $seminary Current Seminary data
|
||||
* @param array $groupsgroup Current Groups group data
|
||||
* @param array $quest Current Quest data
|
||||
* @param array $station Current Station data
|
||||
* @param array $charactergroup Current Character group data
|
||||
* @param array $answer Character group answer for the Station
|
||||
*/
|
||||
public function matchAnswer($seminary, $groupsgroup, $quest, $station, $group, $answer)
|
||||
{
|
||||
|
|
|
@ -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)
|
||||
|
|
|
@ -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)
|
||||
|
|
|
@ -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)
|
||||
{
|
||||
|
|
|
@ -27,7 +27,7 @@
|
|||
/**
|
||||
* Action: index.
|
||||
*
|
||||
* @param $array $user User receiving mail
|
||||
* @param array $user User receiving mail
|
||||
*/
|
||||
public function index($user)
|
||||
{
|
||||
|
|
|
@ -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)
|
||||
{
|
||||
|
|
|
@ -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)
|
||||
{
|
||||
|
|
|
@ -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)
|
||||
{
|
||||
|
|
|
@ -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)
|
||||
{
|
||||
|
|
|
@ -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)
|
||||
{
|
||||
|
|
|
@ -43,9 +43,9 @@
|
|||
/**
|
||||
* Get an Achievement by its URL.
|
||||
*
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param string $achievementUrl URL-title of Achievement
|
||||
* @return array Achievement data
|
||||
* @return array Achievement data
|
||||
*/
|
||||
public function getAchievementByUrl($seminaryId, $achievementUrl)
|
||||
{
|
||||
|
@ -69,8 +69,8 @@
|
|||
/**
|
||||
* Get an Achievement by its ID.
|
||||
*
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @return array Achievement data
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @return array Achievement data
|
||||
*/
|
||||
public function getAchievementById($achievementId)
|
||||
{
|
||||
|
@ -95,8 +95,8 @@
|
|||
* Get all not yet achieved Achievements for a Seminary that can
|
||||
* only be achieved once (only by one Character).
|
||||
*
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @return array Achievements data
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @return array Achievements data
|
||||
*/
|
||||
public function getUnachievedOnlyOnceAchievementsForSeminary($seminaryId)
|
||||
{
|
||||
|
@ -118,8 +118,8 @@
|
|||
/**
|
||||
* Get all Achievements that have a deadline.
|
||||
*
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @return array Achievements data
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @return array Achievements data
|
||||
*/
|
||||
public function getDeadlineAchievements($seminaryId)
|
||||
{
|
||||
|
@ -138,10 +138,10 @@
|
|||
/**
|
||||
* Get seldom Achievements.
|
||||
*
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param int $count Number of Achievements to retrieve
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param int $count Number of Achievements to retrieve
|
||||
* @param bool $alsoWithDeadline Include Achievements with deadline (optional)
|
||||
* @return array List of seldom Achievements
|
||||
* @return array List of seldom Achievements
|
||||
*/
|
||||
public function getSeldomAchievements($seminaryId, $count, $alsoWithDeadline=true)
|
||||
{
|
||||
|
@ -167,9 +167,9 @@
|
|||
/**
|
||||
* Get all achieved Achievements for a Character.
|
||||
*
|
||||
* @param int $characterId ID of Character
|
||||
* @param int $characterId ID of Character
|
||||
* @param bool $alsoWithDeadline Include Achievements with deadline (optional)
|
||||
* @return array Achievements data
|
||||
* @return array Achievements data
|
||||
*/
|
||||
public function getAchievedAchievementsForCharacter($characterId, $alsoWithDeadline=true)
|
||||
{
|
||||
|
@ -189,11 +189,11 @@
|
|||
/**
|
||||
* Get all not yet achieved Achievements for a Character.
|
||||
*
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param int $characterId ID of Character
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param int $characterId ID of Character
|
||||
* @param boolean $includeOnlyOnce Include Achievements that can only be achieved by one Character
|
||||
* @param boolean $alsoWithDeadline Include milestone Achievements
|
||||
* @return array Achievements data
|
||||
* @return array Achievements data
|
||||
*/
|
||||
public function getUnachhievedAchievementsForCharacter($seminaryId, $characterId, $includeOnlyOnce=false, $alsoWithDeadline=true)
|
||||
{
|
||||
|
@ -221,10 +221,10 @@
|
|||
/**
|
||||
* Get the amount of Achievement for a Seminary.
|
||||
*
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param boolean $includeOnlyOnce Include Achievements that can only be achieved by one Character
|
||||
* @param boolean $alsoWithDeadline Include milestone Achievements
|
||||
* @return int Count of Achievements
|
||||
* @return int Count of Achievements
|
||||
*/
|
||||
public function getAchievementsCountForSeminary($seminaryId, $includeOnlyOnce=false, $alsoWithDeadline=true)
|
||||
{
|
||||
|
@ -249,8 +249,8 @@
|
|||
/**
|
||||
* Get all Achievements for a Seminary.
|
||||
*
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @return array List of Achievements
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @return array List of Achievements
|
||||
*/
|
||||
public function getAchievementsForSeminary($seminaryId)
|
||||
{
|
||||
|
@ -270,8 +270,8 @@
|
|||
* Get the rank for the number of achieved Achievements.
|
||||
*
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param int $xps Amount of achieved Achievements
|
||||
* @return int Rank of Achievements count
|
||||
* @param int $count Amount of achieved Achievements
|
||||
* @return int Rank of Achievements count
|
||||
*/
|
||||
public function getCountRank($seminaryId, $count)
|
||||
{
|
||||
|
@ -301,8 +301,8 @@
|
|||
/**
|
||||
* Get all date conditions for an Achievement.
|
||||
*
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @return array Date conditions
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @return array Date conditions
|
||||
*/
|
||||
public function getAchievementConditionsDate($achievementId)
|
||||
{
|
||||
|
@ -319,7 +319,7 @@
|
|||
/**
|
||||
* Check a date condition.
|
||||
*
|
||||
* @param string $select SELECT-string with date-functions
|
||||
* @param string $select SELECT-string with date-functions
|
||||
* @return boolean Result
|
||||
*/
|
||||
public function checkAchievementConditionDate($select)
|
||||
|
@ -339,9 +339,9 @@
|
|||
/**
|
||||
* Add a new date condition.
|
||||
*
|
||||
* @param int $userId ID of creating user
|
||||
* @param int $achievementId ID of Achievement to add condition to
|
||||
* @param string $select SELECT-string for condition
|
||||
* @param int $userId ID of creating user
|
||||
* @param int $achievementId ID of Achievement to add condition to
|
||||
* @param string $select SELECT-string for condition
|
||||
*/
|
||||
public function addAchievementConditionDate($userId, $achievementId, $select)
|
||||
{
|
||||
|
@ -362,8 +362,8 @@
|
|||
/**
|
||||
* Edit a date condition.
|
||||
*
|
||||
* @param int $conditionId ID of condition to edit
|
||||
* @param string $select New SELECT-string for condition
|
||||
* @param int $conditionId ID of condition to edit
|
||||
* @param string $select New SELECT-string for condition
|
||||
*/
|
||||
public function editAchievementConditionDate($conditionId, $select)
|
||||
{
|
||||
|
@ -414,8 +414,8 @@
|
|||
/**
|
||||
* Get all Character conditions for an Achievement.
|
||||
*
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @return array Character conditions
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @return array Character conditions
|
||||
*/
|
||||
public function getAchievementConditionsCharacter($achievementId)
|
||||
{
|
||||
|
@ -432,10 +432,10 @@
|
|||
/**
|
||||
* Check a Character condition.
|
||||
*
|
||||
* @param string $field Field to check
|
||||
* @param int $value The value the field has to match
|
||||
* @param int $characterId ID of Character
|
||||
* @return boolean Result
|
||||
* @param string $field Field to check
|
||||
* @param int $value The value the field has to match
|
||||
* @param int $characterId ID of Character
|
||||
* @return boolean Result
|
||||
*/
|
||||
public function checkAchievementConditionCharacter($field, $value, $characterId)
|
||||
{
|
||||
|
@ -470,10 +470,10 @@
|
|||
/**
|
||||
* Get the progress for a Character condition.
|
||||
*
|
||||
* @param string $field Field to check
|
||||
* @param int $value The value the field has to match
|
||||
* @param int $characterId ID of Character
|
||||
* @return float Percentage progress
|
||||
* @param string $field Field to check
|
||||
* @param int $value The value the field has to match
|
||||
* @param int $characterId ID of Character
|
||||
* @return float Percentage progress
|
||||
*/
|
||||
public function getAchievementConditionCharacterProgress($field, $value, $characterId)
|
||||
{
|
||||
|
@ -505,10 +505,10 @@
|
|||
/**
|
||||
* Add a new Character condition.
|
||||
*
|
||||
* @param int $userId ID of creating user
|
||||
* @param int $achievementId ID of Achievement to add condition to
|
||||
* @param string $field Field to match
|
||||
* @param string $value Value to match
|
||||
* @param int $userId ID of creating user
|
||||
* @param int $achievementId ID of Achievement to add condition to
|
||||
* @param string $field Field to match
|
||||
* @param string $value Value to match
|
||||
*/
|
||||
public function addAchievementConditionCharacter($userId, $achievementId, $field, $value)
|
||||
{
|
||||
|
@ -530,9 +530,9 @@
|
|||
/**
|
||||
* Edit a Character condition.
|
||||
*
|
||||
* @param int $conditionId ID of condition to edit
|
||||
* @param string $field Field to match
|
||||
* @param string $value Value to match
|
||||
* @param int $conditionId ID of condition to edit
|
||||
* @param string $field Field to match
|
||||
* @param string $value Value to match
|
||||
*/
|
||||
public function editAchievementConditionCharacter($conditionId, $field, $value)
|
||||
{
|
||||
|
@ -584,8 +584,8 @@
|
|||
/**
|
||||
* Get all Quest conditions for an Achievement.
|
||||
*
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @return array Quest conditions
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @return array Quest conditions
|
||||
*/
|
||||
public function getAchievementConditionsQuest($achievementId)
|
||||
{
|
||||
|
@ -602,14 +602,14 @@
|
|||
/**
|
||||
* Check a Quest condition.
|
||||
*
|
||||
* @param string $field Field to check
|
||||
* @param boolean $count Conut field-value
|
||||
* @param int $value The value the field has to match
|
||||
* @param int $status Status of Quest or NULL
|
||||
* @param string $groupby Field to group or NULL
|
||||
* @param int $questId ID of related Quest or NULL
|
||||
* @param int $characterId ID of Character
|
||||
* @return boolean Result
|
||||
* @param string $field Field to check
|
||||
* @param boolean $count Conut field-value
|
||||
* @param int $value The value the field has to match
|
||||
* @param int $status Status of Quest or NULL
|
||||
* @param string $groupby Field to group or NULL
|
||||
* @param int $questId ID of related Quest or NULL
|
||||
* @param int $characterId ID of Character
|
||||
* @return boolean Result
|
||||
*/
|
||||
public function checkAchievementConditionQuest($field, $count, $value, $status, $groupby, $questId, $characterId)
|
||||
{
|
||||
|
@ -644,14 +644,14 @@
|
|||
/**
|
||||
* Get the progress for a Quest condition.
|
||||
*
|
||||
* @param string $field Field to check
|
||||
* @param boolean $count Conut field-value
|
||||
* @param int $value The value the field has to match
|
||||
* @param int $status Status of Quest or NULL
|
||||
* @param string $groupby Field to group or NULL
|
||||
* @param int $questId ID of related Quest or NULL
|
||||
* @param int $characterId ID of Character
|
||||
* @return float Percentage progress
|
||||
* @param string $field Field to check
|
||||
* @param boolean $count Conut field-value
|
||||
* @param int $value The value the field has to match
|
||||
* @param int $status Status of Quest or NULL
|
||||
* @param string $groupby Field to group or NULL
|
||||
* @param int $questId ID of related Quest or NULL
|
||||
* @param int $characterId ID of Character
|
||||
* @return float Percentage progress
|
||||
*/
|
||||
public function getAchievementConditionQuestProgress($field, $count, $value, $status, $groupby, $questId, $characterId)
|
||||
{
|
||||
|
@ -688,14 +688,14 @@
|
|||
/**
|
||||
* Add a new Quest condition.
|
||||
*
|
||||
* @param int $userId ID of creating user
|
||||
* @param int $achievementId ID of Achievement to add condition to
|
||||
* @param string $field Field to match
|
||||
* @param boolean $count Count the value
|
||||
* @param string $value Value to match
|
||||
* @param int $questId ID of Quest (optional)
|
||||
* @param int $status Quest status (optional)
|
||||
* @param string $groupby Field to group by (optional)
|
||||
* @param int $userId ID of creating user
|
||||
* @param int $achievementId ID of Achievement to add condition to
|
||||
* @param string $field Field to match
|
||||
* @param boolean $count Count the value
|
||||
* @param string $value Value to match
|
||||
* @param int $questId ID of Quest (optional)
|
||||
* @param int $status Quest status (optional)
|
||||
* @param string $groupby Field to group by (optional)
|
||||
*/
|
||||
public function addAchievementConditionQuest($userId, $achievementId, $field, $count, $value, $questId=null, $status=null, $groupby=null)
|
||||
{
|
||||
|
@ -721,13 +721,13 @@
|
|||
/**
|
||||
* Edit a Quest condition.
|
||||
*
|
||||
* @param int $conditionId ID of condition to edit
|
||||
* @param string $field Field to match
|
||||
* @param boolean $count Count the value
|
||||
* @param string $value Value to match
|
||||
* @param int $questId ID of Quest (optional)
|
||||
* @param int $status Quest status (optional)
|
||||
* @param string $groupby Field to group by (optional)
|
||||
* @param int $conditionId ID of condition to edit
|
||||
* @param string $field Field to match
|
||||
* @param boolean $count Count the value
|
||||
* @param string $value Value to match
|
||||
* @param int $questId ID of Quest (optional)
|
||||
* @param int $status Quest status (optional)
|
||||
* @param string $groupby Field to group by (optional)
|
||||
*/
|
||||
public function editAchievementConditionQuest($conditionId, $field, $count, $value, $questId=null, $status=null, $groupby=null)
|
||||
{
|
||||
|
@ -807,8 +807,8 @@
|
|||
/**
|
||||
* Get all Metaachievement conditions for an Achievement.
|
||||
*
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @return array Metaachievement conditions
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @return array Metaachievement conditions
|
||||
*/
|
||||
public function getAchievementConditionsAchievement($achievementId)
|
||||
{
|
||||
|
@ -825,13 +825,13 @@
|
|||
/**
|
||||
* Check a Metaachievement condition.
|
||||
*
|
||||
* @param string $field Field to check
|
||||
* @param boolean $count Conut field-value
|
||||
* @param int $value The value the field has to match
|
||||
* @param string $groupby Field to group or NULL
|
||||
* @param int $metaAchievementId ID of related Achievement or NULL
|
||||
* @param int $characterId ID of Character
|
||||
* @return boolean Result
|
||||
* @param string $field Field to check
|
||||
* @param boolean $count Conut field-value
|
||||
* @param int $value The value the field has to match
|
||||
* @param string $groupby Field to group or NULL
|
||||
* @param int $metaAchievementId ID of related Achievement or NULL
|
||||
* @param int $characterId ID of Character
|
||||
* @return boolean Result
|
||||
*/
|
||||
public function checkAchievementConditionAchievement($field, $count, $value, $groupby, $metaAchievementId, $characterId)
|
||||
{
|
||||
|
@ -865,13 +865,13 @@
|
|||
/**
|
||||
* Get the progress for a Metaachievement condition.
|
||||
*
|
||||
* @param string $field Field to check
|
||||
* @param boolean $count Conut field-value
|
||||
* @param int $value The value the field has to match
|
||||
* @param string $groupby Field to group or NULL
|
||||
* @param int $metaAchievementId ID of related Achievement or NULL
|
||||
* @param int $characterId ID of Character
|
||||
* @return float Percentage progress
|
||||
* @param string $field Field to check
|
||||
* @param boolean $count Conut field-value
|
||||
* @param int $value The value the field has to match
|
||||
* @param string $groupby Field to group or NULL
|
||||
* @param int $metaAchievementId ID of related Achievement or NULL
|
||||
* @param int $characterId ID of Character
|
||||
* @return float Percentage progress
|
||||
*/
|
||||
public function getAchievementConditionAchievementProgress($field, $count, $value, $groupby, $metaAchievementId, $characterId)
|
||||
{
|
||||
|
@ -907,13 +907,13 @@
|
|||
/**
|
||||
* Add a new Achievement condition.
|
||||
*
|
||||
* @param int $userId ID of creating user
|
||||
* @param int $achievementId ID of Achievement to add condition to
|
||||
* @param string $field Field to match
|
||||
* @param boolean $count Count the value
|
||||
* @param string $value Value to match
|
||||
* @param int $metaAchievementId ID of Meta-Achievement (optional)
|
||||
* @param string $groupby Field to group by (optional)
|
||||
* @param int $userId ID of creating user
|
||||
* @param int $achievementId ID of Achievement to add condition to
|
||||
* @param string $field Field to match
|
||||
* @param boolean $count Count the value
|
||||
* @param string $value Value to match
|
||||
* @param int $metaAchievementId ID of Meta-Achievement (optional)
|
||||
* @param string $groupby Field to group by (optional)
|
||||
*/
|
||||
public function addAchievementConditionAchievement($userId, $achievementId, $field, $count, $value, $metaAchievementId=null, $groupby=null)
|
||||
{
|
||||
|
@ -938,12 +938,12 @@
|
|||
/**
|
||||
* Edit a Achievement condition.
|
||||
*
|
||||
* @param int $conditionId ID of condition to edit
|
||||
* @param string $field Field to match
|
||||
* @param boolean $count Count the value
|
||||
* @param string $value Value to match
|
||||
* @param int $metaAchievementId ID of Achievement (optional)
|
||||
* @param string $groupby Field to group by (optional)
|
||||
* @param int $conditionId ID of condition to edit
|
||||
* @param string $field Field to match
|
||||
* @param boolean $count Count the value
|
||||
* @param string $value Value to match
|
||||
* @param int $metaAchievementId ID of Achievement (optional)
|
||||
* @param string $groupby Field to group by (optional)
|
||||
*/
|
||||
public function editAchievementConditionAchievement($conditionId, $field, $count, $value, $metaAchievementId=null, $groupby=null)
|
||||
{
|
||||
|
@ -1022,8 +1022,8 @@
|
|||
/**
|
||||
* Get all QR-code conditions for an Achievement.
|
||||
*
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @return array List of QR-code conditions
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @return array List of QR-code conditions
|
||||
*/
|
||||
public function getAchievementConditionsQrcode($achievementId)
|
||||
{
|
||||
|
@ -1145,9 +1145,9 @@
|
|||
/**
|
||||
* Check if a Character has achieved an Achievement.
|
||||
*
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @param int $characterId ID of Character
|
||||
* @return boolean Whether Character has achieved the Achievement or not
|
||||
* @param int $achievementId ID of Achievement
|
||||
* @param int $characterId ID of Character
|
||||
* @return boolean Whether Character has achieved the Achievement or not
|
||||
*/
|
||||
public function hasCharacterAchievedAchievement($achievementId, $characterId)
|
||||
{
|
||||
|
@ -1184,10 +1184,10 @@
|
|||
/**
|
||||
* Check if an Achievement title already exists.
|
||||
*
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param string $title Achievement title to check
|
||||
* @param int $characterId Do not check this ID (for editing)
|
||||
* @return boolean Whether Achievement title exists or not
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param string $title Achievement title to check
|
||||
* @param int $achievementId Do not check this ID (for editing)
|
||||
* @return boolean Whether Achievement title exists or not
|
||||
*/
|
||||
public function achievementTitleExists($seminaryId, $title, $achievementId=null)
|
||||
{
|
||||
|
@ -1209,17 +1209,17 @@
|
|||
/**
|
||||
* Create a new Achievement for a Seminary.
|
||||
*
|
||||
* @param int $userId ID of creating user
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param int $conditionId ID of Achievement condition
|
||||
* @param string $title Title of new Achievement
|
||||
* @param int $userId ID of creating user
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param int $conditionId ID of Achievement condition
|
||||
* @param string $title Title of new Achievement
|
||||
* @param string $description Description of new Achievement
|
||||
* @param boolean $progress Show progress
|
||||
* @param boolean $hidden Secret Achievement
|
||||
* @param boolean $onlyOnce Only achieveable by one user
|
||||
* @param boolean $progress Show progress
|
||||
* @param boolean $hidden Secret Achievement
|
||||
* @param boolean $onlyOnce Only achieveable by one user
|
||||
* @param boolean $allConditions Achievement must match all conditions
|
||||
* @param string $deadline Deadline for Achievement
|
||||
* @return int ID of newly created Achievement
|
||||
* @param string $deadline Deadline for Achievement
|
||||
* @return int ID of newly created Achievement
|
||||
*/
|
||||
public function createAchievement($userId, $seminaryId, $conditionId, $title, $description, $progress, $hidden, $onlyOnce, $allConditions, $deadline)
|
||||
{
|
||||
|
@ -1265,7 +1265,7 @@
|
|||
* (increment position).
|
||||
*
|
||||
* @param array $achievement Achievement to move
|
||||
* @param boolean $up True for moving up, false for down
|
||||
* @param boolean $up True for moving up, false for down
|
||||
*/
|
||||
public function moveAchievement($achievement, $up)
|
||||
{
|
||||
|
@ -1313,15 +1313,15 @@
|
|||
/**
|
||||
* Edit an Achievement of a Seminary.
|
||||
*
|
||||
* @param int $achievementId ID of Achievement to edit
|
||||
* @param int $conditionId ID of Achievement condition
|
||||
* @param string $title New title of Achievement
|
||||
* @param int $achievementId ID of Achievement to edit
|
||||
* @param int $conditionId ID of Achievement condition
|
||||
* @param string $title New title of Achievement
|
||||
* @param string $description New description of Achievement
|
||||
* @param boolean $progress Show progress
|
||||
* @param boolean $hidden Secret Achievement
|
||||
* @param boolean $onlyOnce Only achieveable by one user
|
||||
* @param boolean $progress Show progress
|
||||
* @param boolean $hidden Secret Achievement
|
||||
* @param boolean $onlyOnce Only achieveable by one user
|
||||
* @param boolean $allConditions Achievement must match all conditions
|
||||
* @param string $deadline Deadline for Achievement
|
||||
* @param string $deadline Deadline for Achievement
|
||||
*/
|
||||
public function editAchievement($achievementId, $conditionId, $title, $description, $progress, $hidden, $onlyOnce, $allConditions, $deadline)
|
||||
{
|
||||
|
@ -1347,7 +1347,7 @@
|
|||
/**
|
||||
* Set unachieved media for an Achievement.
|
||||
*
|
||||
* @param int $achievementId ID of Achievement to set media for
|
||||
* @param int $achievementId ID of Achievement to set media for
|
||||
* @param int $achievementsmediaId ID of achievementsmedia to set
|
||||
*/
|
||||
public function setUnachievedMediaForAchievement($achievementId, $achievementsmediaId)
|
||||
|
@ -1366,7 +1366,7 @@
|
|||
/**
|
||||
* Set achieved media for an Achievement.
|
||||
*
|
||||
* @param int $achievementId ID of Achievement to set media for
|
||||
* @param int $achievementId ID of Achievement to set media for
|
||||
* @param int $achievementsmediaId ID of achievementsmedia to set
|
||||
*/
|
||||
public function setAchievedMediaForAchievement($achievementId, $achievementsmediaId)
|
||||
|
|
|
@ -44,8 +44,8 @@
|
|||
/**
|
||||
* Get Character groups-groups of a Seminary.
|
||||
*
|
||||
* @param int $seminaryId ID of the corresponding Seminary
|
||||
* @return array Character groups-groups data
|
||||
* @param int $seminaryId ID of the corresponding Seminary
|
||||
* @return array Character groups-groups data
|
||||
*/
|
||||
public function getGroupsroupsForSeminary($seminaryId)
|
||||
{
|
||||
|
@ -63,9 +63,9 @@
|
|||
* Get a Character groups-group by its URL.
|
||||
*
|
||||
* @throws \nre\exceptions\IdNotFoundException
|
||||
* @param int $seminaryId ID of the corresponding Seminary
|
||||
* @param int $seminaryId ID of the corresponding Seminary
|
||||
* @param string $groupsgroupUrl URL-name of the Character groups-group
|
||||
* @return array Character groups-group data
|
||||
* @return array Character groups-group data
|
||||
*/
|
||||
public function getGroupsgroupByUrl($seminaryId, $groupsgroupUrl)
|
||||
{
|
||||
|
@ -90,7 +90,7 @@
|
|||
*
|
||||
* @throws \nre\exceptions\IdNotFoundException
|
||||
* @param string $groupsgroupId ID of the Character groups-group
|
||||
* @return array Character groups-group data
|
||||
* @return array Character groups-group data
|
||||
*/
|
||||
public function getGroupsgroupById($groupsgroupId)
|
||||
{
|
||||
|
@ -138,11 +138,11 @@
|
|||
/**
|
||||
* Create a new Character groups-group.
|
||||
*
|
||||
* @param int $userId ID of user
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param int $userId ID of user
|
||||
* @param int $seminaryId ID of Seminary
|
||||
* @param string $name Name of new groups-group
|
||||
* @param boolean $preferred Whether groups-group is preferred or not
|
||||
* @return int ID of newly created groups-group
|
||||
* @return int ID of newly created groups-group
|
||||
*/
|
||||
public function createGroupsgroup($userId, $seminaryId, $name, $preferred)
|
||||
{
|
||||
|
@ -167,9 +167,9 @@
|
|||
/**
|
||||
* Edit a Character groups-group.
|
||||
*
|
||||
* @param int $groupsgroupId ID of groups-group to edit
|
||||
* @param string $name New name of groups-group
|
||||
* @param boolean $preferred Whether groups-group is preferred or not
|
||||
* @param int $groupsgroupId ID of groups-group to edit
|
||||
* @param string $name New name of groups-group
|
||||
* @param boolean $preferred Whether groups-group is preferred or not
|
||||
*/
|
||||