@@ -791,7 +791,7 @@ |
||
| 791 | 791 | * returns a sample serialization of a given type, or false if no type by the given name |
| 792 | 792 | * |
| 793 | 793 | * @param string $type name of type |
| 794 | - * @return mixed |
|
| 794 | + * @return string|false |
|
| 795 | 795 | * @access public |
| 796 | 796 | * @deprecated |
| 797 | 797 | */ |
@@ -447,7 +447,7 @@ |
||
| 447 | 447 | * |
| 448 | 448 | * @param array $headers The HTTP headers |
| 449 | 449 | * @param string $data unprocessed request data from client |
| 450 | - * @return mixed value of the message, decoded into a PHP type |
|
| 450 | + * @return false|null value of the message, decoded into a PHP type |
|
| 451 | 451 | * @access private |
| 452 | 452 | */ |
| 453 | 453 | function parseRequest($headers, $data) {
|
@@ -208,6 +208,8 @@ discard block |
||
| 208 | 208 | } |
| 209 | 209 | /** |
| 210 | 210 | * Gives a list of people online now (and in the last $valid minutes) |
| 211 | + * @param integer $from |
|
| 212 | + * @param integer $time_limit |
|
| 211 | 213 | * @return array For each line, a list of user IDs and login dates, or FALSE on error or empty results |
| 212 | 214 | */ |
| 213 | 215 | function who_is_online($from, $number_of_items, $column = null, $direction = null, $time_limit = null, $friends = false) |
@@ -424,6 +426,9 @@ discard block |
||
| 424 | 426 | } |
| 425 | 427 | } |
| 426 | 428 | |
| 429 | +/** |
|
| 430 | + * @param integer $uid |
|
| 431 | + */ |
|
| 427 | 432 | function who_is_online_in_this_course_count($uid, $time_limit, $coursecode=null) |
| 428 | 433 | { |
| 429 | 434 | if (empty($coursecode)) { |
@@ -143,7 +143,7 @@ discard block |
||
| 143 | 143 | |
| 144 | 144 | /** |
| 145 | 145 | * Returns the contents of the CSS defined by the plugin |
| 146 | - * @return array |
|
| 146 | + * @return string |
|
| 147 | 147 | */ |
| 148 | 148 | public function get_css() |
| 149 | 149 | { |
@@ -161,7 +161,7 @@ discard block |
||
| 161 | 161 | |
| 162 | 162 | /** |
| 163 | 163 | * Returns an HTML form (generated by FormValidator) of the plugin settings |
| 164 | - * @return string FormValidator-generated form |
|
| 164 | + * @return FormValidator FormValidator-generated form |
|
| 165 | 165 | */ |
| 166 | 166 | public function get_settings_form() |
| 167 | 167 | { |
@@ -383,7 +383,7 @@ discard block |
||
| 383 | 383 | * @param boolean $add_tool_link Whether to add a tool link or not |
| 384 | 384 | * (some tools might just offer a configuration section and act on the backend) |
| 385 | 385 | * |
| 386 | - * @return boolean False on error, null otherwise |
|
| 386 | + * @return boolean|null False on error, null otherwise |
|
| 387 | 387 | */ |
| 388 | 388 | public function install_course_fields($courseId, $add_tool_link = true) |
| 389 | 389 | { |
@@ -491,7 +491,7 @@ discard block |
||
| 491 | 491 | * tool on the course's homepage |
| 492 | 492 | * @param int $courseId |
| 493 | 493 | * |
| 494 | - * @return void |
|
| 494 | + * @return false|null |
|
| 495 | 495 | */ |
| 496 | 496 | public function uninstall_course_fields($courseId) |
| 497 | 497 | { |
@@ -596,7 +596,7 @@ discard block |
||
| 596 | 596 | * @param string $tabName |
| 597 | 597 | * @param string $url |
| 598 | 598 | * |
| 599 | - * @return boolean |
|
| 599 | + * @return false|string |
|
| 600 | 600 | */ |
| 601 | 601 | public function addTab($tabName, $url) |
| 602 | 602 | { |
@@ -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 | { |
@@ -126,6 +126,7 @@ discard block |
||
| 126 | 126 | * Returns a temporary url to download files and/or folders. |
| 127 | 127 | * |
| 128 | 128 | * @param string|array $ids |
| 129 | + * @param string $tool |
|
| 129 | 130 | * @return string |
| 130 | 131 | */ |
| 131 | 132 | public static function download_url($ids, $tool) |
@@ -293,7 +294,7 @@ discard block |
||
| 293 | 294 | /** |
| 294 | 295 | * The name of the porfolio where to send. |
| 295 | 296 | * |
| 296 | - * @return type |
|
| 297 | + * @return string |
|
| 297 | 298 | */ |
| 298 | 299 | function get_portfolio() |
| 299 | 300 | { |
@@ -391,7 +392,6 @@ discard block |
||
| 391 | 392 | * Create a "send to portfolio" button |
| 392 | 393 | * |
| 393 | 394 | * @param string $tool The name of the tool: document, work. |
| 394 | - * @param int $c_id The id of the course |
|
| 395 | 395 | * @param int $id The id of the object |
| 396 | 396 | * @param array $attributes Html attributes |
| 397 | 397 | * @return \PortfolioShare |
@@ -405,7 +405,7 @@ discard block |
||
| 405 | 405 | /** |
| 406 | 406 | * Returns the current secuirty token. Used to avoid see surfing attacks. |
| 407 | 407 | * |
| 408 | - * @return type |
|
| 408 | + * @return string |
|
| 409 | 409 | */ |
| 410 | 410 | static function security_token() |
| 411 | 411 | { |
@@ -420,6 +420,10 @@ discard block |
||
| 420 | 420 | protected $attributes = array(); |
| 421 | 421 | protected $tool = ''; |
| 422 | 422 | |
| 423 | + /** |
|
| 424 | + * @param string $tool |
|
| 425 | + * @param integer $id |
|
| 426 | + */ |
|
| 423 | 427 | function __construct($tool, $id, $attributes = array()) |
| 424 | 428 | { |
| 425 | 429 | $this->tool = $tool; |
@@ -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 | { |
@@ -15,6 +15,10 @@ |
||
| 15 | 15 | |
| 16 | 16 | // warning the goal of this function is to enforce rights managment in Chamilo |
| 17 | 17 | // thus default return value is always true |
| 18 | + |
|
| 19 | + /** |
|
| 20 | + * @param string $handler |
|
| 21 | + */ |
|
| 18 | 22 | public static function hasRight($handler) { |
| 19 | 23 | if (array_key_exists($handler, self::$rights_cache)) |
| 20 | 24 | return self::$rights_cache[$handler]; |
@@ -71,6 +71,10 @@ |
||
| 71 | 71 | |
| 72 | 72 | /** |
| 73 | 73 | * Get the terms stored at database |
| 74 | + * @param string $prefix |
|
| 75 | + * @param string $course_code |
|
| 76 | + * @param string $tool_id |
|
| 77 | + * @param integer $ref_id |
|
| 74 | 78 | * @return array Array of terms |
| 75 | 79 | */ |
| 76 | 80 | function get_terms_on_db($prefix, $course_code, $tool_id, $ref_id) { |