@@ -128,7 +128,7 @@ |
||
128 | 128 | |
129 | 129 | /** |
130 | 130 | * Resturns the type of this resource |
131 | - * @return constant The type. |
|
131 | + * @return integer The type. |
|
132 | 132 | */ |
133 | 133 | public function get_type() |
134 | 134 | { |
@@ -65,6 +65,9 @@ |
||
65 | 65 | |
66 | 66 | /* FUNCTIONS */ |
67 | 67 | |
68 | +/** |
|
69 | + * @param string $name |
|
70 | + */ |
|
68 | 71 | function make_select_session_list($name, $sessions, $attr = array()) |
69 | 72 | { |
70 | 73 |
@@ -50,6 +50,7 @@ discard block |
||
50 | 50 | /** |
51 | 51 | * Returns a quarter from a month |
52 | 52 | * @param string The month (digit), with or without leading 0 |
53 | + * @param string $month |
|
53 | 54 | * @return int The yearly quarter (1, 2, 3 or 4) in which this month lies |
54 | 55 | */ |
55 | 56 | function getQuarter($month) |
@@ -96,6 +97,7 @@ discard block |
||
96 | 97 | /** |
97 | 98 | * Returns the first month of the quarter |
98 | 99 | * @param int Quarter |
100 | + * @param integer $quarter |
|
99 | 101 | * @return string Number of the month, with leading 0 |
100 | 102 | */ |
101 | 103 | function getQuarterFirstMonth($quarter) |
@@ -116,6 +118,7 @@ discard block |
||
116 | 118 | /** |
117 | 119 | * Get the quarter in Roman letters |
118 | 120 | * @param int Quarter |
121 | + * @param integer $quarter |
|
119 | 122 | * @return string Roman letters |
120 | 123 | */ |
121 | 124 | function getQuarterRoman($quarter) |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | public $conditions; |
49 | 49 | |
50 | 50 | /** |
51 | - * @param Logger $logger |
|
51 | + * @param Monolog\Logger $logger |
|
52 | 52 | * @param array |
53 | 53 | */ |
54 | 54 | public function __construct($logger, $conditions) |
@@ -66,7 +66,7 @@ discard block |
||
66 | 66 | } |
67 | 67 | |
68 | 68 | /** |
69 | - * @return mixed |
|
69 | + * @return boolean |
|
70 | 70 | */ |
71 | 71 | public function getDumpValues() |
72 | 72 | { |
@@ -266,7 +266,7 @@ discard block |
||
266 | 266 | * @param string $author |
267 | 267 | * @param string $filename |
268 | 268 | * @param int $filesize |
269 | - * @param array $recipient_ids |
|
269 | + * @param unknown_type|null $recipient_ids |
|
270 | 270 | */ |
271 | 271 | public function _createNewSentWork($uploader_id, $title, $description, $author, $filename, $filesize, $recipient_ids) |
272 | 272 | { |
@@ -584,6 +584,7 @@ discard block |
||
584 | 584 | |
585 | 585 | /** |
586 | 586 | * Deletes all the received categories and work of this person |
587 | + * @param integer $id |
|
587 | 588 | */ |
588 | 589 | function deleteReceivedWorkFolder($id) |
589 | 590 | { |
@@ -10,6 +10,10 @@ |
||
10 | 10 | if ( count( get_included_files() ) == 1 ) die( '---' ); |
11 | 11 | |
12 | 12 | if (!function_exists('mime_content_type')) { |
13 | + |
|
14 | + /** |
|
15 | + * @param string $filename |
|
16 | + */ |
|
13 | 17 | function mime_content_type($filename) { |
14 | 18 | return DocumentManager::file_get_mime_type((string)$filename); |
15 | 19 | } |
@@ -55,6 +55,8 @@ discard block |
||
55 | 55 | * Gets the uploaded file (from $_FILES) and unzip it to the given directory |
56 | 56 | * @param string The directory where to do the work |
57 | 57 | * @param string The path of the temporary directory where the exercise was uploaded and unzipped |
58 | + * @param string $baseWorkDir |
|
59 | + * @param string $uploadPath |
|
58 | 60 | * @return bool True on success, false on failure |
59 | 61 | */ |
60 | 62 | function get_and_unzip_uploaded_exercise($baseWorkDir, $uploadPath) { |
@@ -229,7 +231,10 @@ discard block |
||
229 | 231 | * @param string Path to the directory with the file to be parsed (without final /) |
230 | 232 | * @param string Name of the last directory part for the file (without /) |
231 | 233 | * @param string Name of the file to be parsed (including extension) |
232 | - * @return mixed True on success, error message on error |
|
234 | + * @param string $exercisePath |
|
235 | + * @param string $file |
|
236 | + * @param string $questionFile |
|
237 | + * @return string|boolean True on success, error message on error |
|
233 | 238 | * @assert ('','','') === false |
234 | 239 | */ |
235 | 240 | function aiken_parse_file(&$exercise_info, $exercisePath, $file, $questionFile) { |
@@ -30,6 +30,8 @@ discard block |
||
30 | 30 | * Unzip the exercise in the temp folder |
31 | 31 | * @param string The path of the temporary directory where the exercise was uploaded and unzipped |
32 | 32 | * @param string |
33 | + * @param string $baseWorkDir |
|
34 | + * @param string $uploadPath |
|
33 | 35 | * @return bool |
34 | 36 | */ |
35 | 37 | function get_and_unzip_uploaded_exercise($baseWorkDir, $uploadPath) |
@@ -217,9 +219,9 @@ discard block |
||
217 | 219 | |
218 | 220 | /** |
219 | 221 | * Parses a given XML file and fills global arrays with the elements |
220 | - * @param $exercisePath |
|
221 | - * @param $file |
|
222 | - * @param $questionFile |
|
222 | + * @param string $exercisePath |
|
223 | + * @param string $file |
|
224 | + * @param string $questionFile |
|
223 | 225 | * @return bool |
224 | 226 | */ |
225 | 227 | function parse_file($exercisePath, $file, $questionFile) |
@@ -32,7 +32,7 @@ discard block |
||
32 | 32 | /** |
33 | 33 | * Constructor. |
34 | 34 | * |
35 | - * @param $question Ims2Question object we want to export. |
|
35 | + * @param Ims2Question $question Ims2Question object we want to export. |
|
36 | 36 | */ |
37 | 37 | function ImsAssessmentItem($question) |
38 | 38 | { |
@@ -101,7 +101,7 @@ discard block |
||
101 | 101 | * This is a default behaviour, some classes may want to override this. |
102 | 102 | * |
103 | 103 | * @param $standalone: Boolean stating if it should be exported as a stand-alone question |
104 | - * @return A string, the XML flow for an Item. |
|
104 | + * @return string string, the XML flow for an Item. |
|
105 | 105 | */ |
106 | 106 | function export($standalone = false) |
107 | 107 | { |
@@ -154,7 +154,7 @@ discard block |
||
154 | 154 | |
155 | 155 | /** |
156 | 156 | * Constructor. |
157 | - * @param $exe The Exercise instance to export |
|
157 | + * @param Exercise $exe The Exercise instance to export |
|
158 | 158 | * @author Amand Tihon <[email protected]> |
159 | 159 | */ |
160 | 160 | function ImsSection($exe) |
@@ -239,7 +239,7 @@ discard block |
||
239 | 239 | * Export the exercise in IMS/QTI. |
240 | 240 | * |
241 | 241 | * @param bool $standalone Wether it should include XML tag and DTD line. |
242 | - * @return a string containing the XML flow |
|
242 | + * @return string string containing the XML flow |
|
243 | 243 | * @author Amand Tihon <[email protected]> |
244 | 244 | */ |
245 | 245 | function export($standalone) |
@@ -383,7 +383,7 @@ discard block |
||
383 | 383 | * This is a default behaviour, some classes may want to override this. |
384 | 384 | * |
385 | 385 | * @param $standalone: Boolean stating if it should be exported as a stand-alone question |
386 | - * @return A string, the XML flow for an Item. |
|
386 | + * @return string string, the XML flow for an Item. |
|
387 | 387 | * @author Amand Tihon <[email protected]> |
388 | 388 | */ |
389 | 389 | function export($standalone = False) |
@@ -417,7 +417,7 @@ discard block |
||
417 | 417 | * |
418 | 418 | * @param int $exerciseId The exercise to export |
419 | 419 | * @param boolean $standalone Wether it should include XML tag and DTD line. |
420 | - * @return The XML as a string, or an empty string if there's no exercise with given ID. |
|
420 | + * @return string XML as a string, or an empty string if there's no exercise with given ID. |
|
421 | 421 | */ |
422 | 422 | function export_exercise_to_qti($exerciseId, $standalone = true) |
423 | 423 | { |
@@ -474,6 +474,9 @@ discard block |
||
474 | 474 | return htmlspecialchars($text); |
475 | 475 | } |
476 | 476 | |
477 | +/** |
|
478 | + * @param string $text |
|
479 | + */ |
|
477 | 480 | function cleanAttribute($text) |
478 | 481 | { |
479 | 482 | return $text; |