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

add namespaces to docstring types

Browse source
This commit is contained in:
coderkun 2015-03-06 12:19:07 +01:00
commit 969887da58
98 changed files with 632 additions and 555 deletions
Download patch file Download diff file Expand all files Collapse all files

8
models/CharactergroupsModel.inc
View file

@ -56,7 +56,7 @@
/**
* Get a Character groups-group by its URL.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of the corresponding Seminary
* @param string $groupsgroupUrl URL-name of the Character groups-group
* @return array Character groups-group data
@ -82,7 +82,7 @@
/**
* Get a Character groups-group by its ID.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param string $groupsgroupId ID of the Character groups-group
* @return array Character groups-group data
*/
@ -252,7 +252,7 @@
/**
* Get a Character group by its URL.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $groupsgroupId ID of the Character groups-group
* @param string $groupUrl URL-name of the Character group
* @return array Character group data
@ -281,7 +281,7 @@
/**
* Get a Character group by its ID.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $groupsgroupId ID of the Character group
* @return array Character group data
*/

4
models/CharactergroupsquestsModel.inc
View file

@ -63,7 +63,7 @@
/**
* Get a Character groups Quest by its URL.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $groupsgroupId ID of the Character groups-group
* @param string $questUrl URL-title of the Character groups Quest
* @return array Character groups Quest data
@ -90,7 +90,7 @@
/**
* Get a Character groups Quest by its ID.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $questId ID of the Character groups Quest
* @return array Character groups Quest data
*/

6
models/CharactersModel.inc
View file

@ -241,7 +241,7 @@
/**
* Get the character of a user for a Seminary.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $userId ID of the user
* @param int $seminaryId ID of the Seminary
* @return array Character data
@ -273,7 +273,7 @@
/**
* Get a Character by its Url.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of the Seminary
* @param string $characterUrl URL-name of the Character
* @return array Character data
@ -305,7 +305,7 @@
/**
* Get a Character by its Id.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param string $characterId ID of the Character
* @return array Character data
*/

12
models/DatabaseModel.inc
View file

@ -33,9 +33,9 @@
/**
* Construct a new datamase model.
*
* @throws DatamodelException
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws \nre\exceptions\DatamodelException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @param string $type Database type
* @param array $config Connection settings
*/
@ -56,8 +56,8 @@
/**
* Load the database driver.
*
* @throws DriverNotFoundException
* @throws DriverNotValidException
* @throws \nre\exceptions\DriverNotFoundException
* @throws \nre\exceptions\DriverNotValidException
* @param string $driverName Name of the database driver
*/
private function loadDriver($driverName)
@ -69,7 +69,7 @@
/**
* Establish a connection to the database.
*
* @throws DatamodelException
* @throws \nre\exceptions\DatamodelException
* @param string $driverName Name of the database driver
* @param array $config Connection settings
*/

8
models/MediaModel.inc
View file

@ -37,7 +37,7 @@
/**
* Get a medium by its URL.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param string $mediaURL URL-name of the Medium
* @return array Medium data
*/
@ -62,7 +62,7 @@
/**
* Get a medium by its ID.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $mediaId ID of the Medium
* @return array Medium data
*/
@ -87,7 +87,7 @@
/**
* Get a Seminary medium by its URL.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of the seminary
* @param string $seminaryMediaUrl URL-name of the Seminary medium
* @return array Seminary medium data
@ -113,7 +113,7 @@
/**
* Get a Seminary medium by its ID.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryMediaId ID of the Seminary medium
* @return array Seminary medium data
*/

6
models/QuestgroupsModel.inc
View file

@ -111,7 +111,7 @@
/**
* Get a Questgroup by its ID.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $questgroupId ID of a Questgroup
* @return array Questgroup data
*/
@ -136,7 +136,7 @@
/**
* Get a Questgroup by its URL.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of the corresponding seminary
* @param string $questgroupURL URL-title of a Questgroup
* @return array Questgroup data
@ -586,7 +586,7 @@
/**
* Edit a Questgroup.
*
* @throws DatamodelException
* @throws \nre\exceptions\DatamodelException
* @param int $questgroupId ID of Questgroup to edit
* @param string $title New title of Questgroup
*/

4
models/QuestgroupshierarchyModel.inc
View file

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

4
models/QuestsModel.inc
View file

@ -61,7 +61,7 @@
/**
* Get a Quest and its data by its URL.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of the corresponding Seminary
* @param int $questgroupId ID of the corresponding Questgroup
* @param string $questURL URL-title of a Quest
@ -89,7 +89,7 @@
/**
* Get a Quest and its data by its ID.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param string $questId ID of a Quest
* @return array Quest data
*/

2
models/QuesttextsModel.inc
View file

@ -131,7 +131,7 @@
/**
* Get corresponding Questtexts for a Questgroup.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $questgroupId ID of Questgroup to get the Questtexst for
* @param array List of Questtexts
*/

6
models/SeminariesModel.inc
View file

@ -59,7 +59,7 @@
/**
* Get a seminary and its data by its ID.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryId ID of a seminary
* @return array Seminary
*/
@ -84,7 +84,7 @@
/**
* Get a seminary and its data by its URL-title.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param string $seminaryUrl URL-Title of a seminary
* @return array Seminary
*/
@ -205,7 +205,7 @@
/**
* Edit a seminary.
*
* @throws DatamodelException
* @throws \nre\exceptions\DatamodelException
* @param int $seminaryId ID of Seminary to edit
* @param string $title New title of Seminary
* @param string $course New course of Seminary

4
models/UploadsModel.inc
View file

@ -88,7 +88,7 @@
/**
* Get an upload by its ID.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $uploadId ID of the uploaded file
* @return array Upload data
*/
@ -113,7 +113,7 @@
/**
* Get an upload by its URL.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of Seminary
* @param int $uploadId ID of the uploaded file
* @return array Upload data

10
models/UsersModel.inc
View file

@ -59,7 +59,7 @@
/**
* Get registered users.
*
* @throws ParamsNotValidException
* @throws \nre\exceptions\ParamsNotValidException
* @param string $sort Field to sort by
* @param string $username Only get users with the given username (optional)
* @param int $limit Limit amount of Characters (optional)
@ -127,7 +127,7 @@
/**
* Get a user and its data by its ID.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $userId ID of an user
* @return array Userdata
*/
@ -153,7 +153,7 @@
/**
* Get a user and its data by its URL-username.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param string $userUrl URL-Username of an user
* @return array Userdata
*/
@ -179,7 +179,7 @@
/**
* Log a user in if its credentials are valid.
*
* @throws DatamodelException
* @throws \nre\exceptions\DatamodelException
* @param string $username The name of the user to log in
* @param string $password Plaintext password of the user to log in
*/
@ -302,7 +302,7 @@
/**
* Edit a user.
*
* @throws DatamodelException
* @throws \nre\exceptions\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

4
models/XplevelsModel.inc
View file

@ -37,7 +37,7 @@
/**
* Get XP-level by its ID.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $xplevelId ID of XP-level
* @return array XP-level data
*/
@ -62,7 +62,7 @@
/**
* Get all XP-levels for a Seminary.
*
* @throws IdNotFoundException
* @throws \nre\exceptions\IdNotFoundException
* @param int $seminaryId ID of Seminary
* @return array List of XP-level
*/