@@ -80,7 +80,7 @@ |
||
80 | 80 | |
81 | 81 | /** |
82 | 82 | * Validates the received active connection data with the database |
83 | - * @return bool Return the loginFailed variable value to local.inc.php |
|
83 | + * @return null|false Return the loginFailed variable value to local.inc.php |
|
84 | 84 | */ |
85 | 85 | public function check_user() |
86 | 86 | { |
@@ -47,6 +47,9 @@ |
||
47 | 47 | |
48 | 48 | /* FUNCTIONS */ |
49 | 49 | |
50 | +/** |
|
51 | + * @param string $name |
|
52 | + */ |
|
50 | 53 | function make_select_session_list($name, $sessions, $attr = array()) |
51 | 54 | { |
52 | 55 | $attributes = ''; |
@@ -327,7 +327,7 @@ |
||
327 | 327 | * @param array $arr1 first array |
328 | 328 | * @param array $arr2 second array |
329 | 329 | * |
330 | - * @return array difference between the two arrays |
|
330 | + * @return string difference between the two arrays |
|
331 | 331 | */ |
332 | 332 | function diff($arr1, $arr2) |
333 | 333 | { |
@@ -16,7 +16,7 @@ |
||
16 | 16 | * |
17 | 17 | * @param string Mobile phone number to be validated |
18 | 18 | * @param string Not using it. Just to respect the declaration |
19 | - * @return boolean Returns true if valid, false otherwise. |
|
19 | + * @return integer Returns true if valid, false otherwise. |
|
20 | 20 | */ |
21 | 21 | function validate($mobilePhoneNumber, $options = null) |
22 | 22 | { |
@@ -626,7 +626,7 @@ |
||
626 | 626 | |
627 | 627 | /** |
628 | 628 | * Get first SMS plugin name |
629 | - * @return string|boolean |
|
629 | + * @return string|false |
|
630 | 630 | */ |
631 | 631 | public function getSMSPluginName() |
632 | 632 | { |
@@ -129,7 +129,7 @@ discard block |
||
129 | 129 | } |
130 | 130 | |
131 | 131 | /** |
132 | - * @return array |
|
132 | + * @return string[] |
|
133 | 133 | */ |
134 | 134 | public function get_status_list() |
135 | 135 | { |
@@ -272,7 +272,7 @@ discard block |
||
272 | 272 | /** |
273 | 273 | * @param int $id |
274 | 274 | * |
275 | - * @return bool |
|
275 | + * @return null|false |
|
276 | 276 | */ |
277 | 277 | public function delete($id) |
278 | 278 | { |
@@ -98,7 +98,7 @@ discard block |
||
98 | 98 | |
99 | 99 | /** |
100 | 100 | * Simple getter for the db attribute |
101 | - * @return object The db attribute |
|
101 | + * @return null|XapianWritableDatabase The db attribute |
|
102 | 102 | */ |
103 | 103 | function getDb() |
104 | 104 | { |
@@ -108,6 +108,7 @@ discard block |
||
108 | 108 | /** |
109 | 109 | * Add this chunk to the chunk array attribute |
110 | 110 | * @param string Chunk of text |
111 | + * @param IndexableChunk $chunk |
|
111 | 112 | * @return void |
112 | 113 | */ |
113 | 114 | function addChunk($chunk) |
@@ -179,7 +180,7 @@ discard block |
||
179 | 180 | * Get document data on a xapian document |
180 | 181 | * |
181 | 182 | * @param XapianDocument $doc xapian document to push into the db |
182 | - * @return mixed xapian document data or FALSE if error |
|
183 | + * @return string xapian document data or FALSE if error |
|
183 | 184 | */ |
184 | 185 | function get_document_data($doc) |
185 | 186 | { |
@@ -286,7 +287,7 @@ discard block |
||
286 | 287 | * Replace a document in the actual db |
287 | 288 | * |
288 | 289 | * @param XapianDocument $doc xapian document to push into the db |
289 | - * @param Xapian::docid $did xapian document id of the document to replace |
|
290 | + * @param integer $did xapian document id of the document to replace |
|
290 | 291 | */ |
291 | 292 | function replace_document($doc, $did) |
292 | 293 | { |
@@ -70,13 +70,16 @@ |
||
70 | 70 | */ |
71 | 71 | function connectDb($path = null, $dbMode = null, $lang = 'english') |
72 | 72 | { |
73 | - if ($this->db != null) |
|
74 | - return $this->db; |
|
75 | - if ($dbMode == null) |
|
76 | - $dbMode = Xapian::DB_CREATE_OR_OPEN; |
|
73 | + if ($this->db != null) { |
|
74 | + return $this->db; |
|
75 | + } |
|
76 | + if ($dbMode == null) { |
|
77 | + $dbMode = Xapian::DB_CREATE_OR_OPEN; |
|
78 | + } |
|
77 | 79 | |
78 | - if ($path == null) |
|
79 | - $path = api_get_path(SYS_UPLOAD_PATH).'plugins/xapian/searchdb/'; |
|
80 | + if ($path == null) { |
|
81 | + $path = api_get_path(SYS_UPLOAD_PATH).'plugins/xapian/searchdb/'; |
|
82 | + } |
|
80 | 83 | |
81 | 84 | try { |
82 | 85 | $this->db = new XapianWritableDatabase($path, $dbMode); |
@@ -326,6 +326,7 @@ discard block |
||
326 | 326 | |
327 | 327 | /** |
328 | 328 | * Gets an element |
329 | + * @param integer $gradebook_id |
|
329 | 330 | */ |
330 | 331 | public function get_skill_info($skill_id, $gradebook_id) |
331 | 332 | { |
@@ -544,7 +545,7 @@ discard block |
||
544 | 545 | * Gets an element |
545 | 546 | * @param int $id |
546 | 547 | * |
547 | - * @return array|mixed |
|
548 | + * @return integer |
|
548 | 549 | */ |
549 | 550 | public function get($id) |
550 | 551 | { |
@@ -885,7 +886,7 @@ discard block |
||
885 | 886 | /** |
886 | 887 | * Get user's skills |
887 | 888 | * |
888 | - * @param int $userId User's id |
|
889 | + * @param integer $user_id User's id |
|
889 | 890 | * @param bool $get_skill_data |
890 | 891 | */ |
891 | 892 | public function get_user_skills($user_id, $get_skill_data = false) |
@@ -443,6 +443,7 @@ |
||
443 | 443 | * @param bool hide navigation optionally |
444 | 444 | * @param int content per page when show navigation (optional) |
445 | 445 | * @param bool sort data optionally |
446 | + * @param boolean $visibility_options |
|
446 | 447 | * @return string grid html |
447 | 448 | */ |
448 | 449 | public function display_simple_grid($visibility_options, $hide_navigation = true, $per_page = 20, $sort_data = true, $grid_class = array()) |