chamilo / chamilo-lms

main/inc/lib/statsUtils.lib.inc.php

Doc Comments +1 added lines

@@ -85,6 +85,7 @@
     /**
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @param sql : a sql query (as a string)
+     * @param integer $X
      * @desc Return many results of a query in a X column tab
      * in $resu[$i][0], $resu[$i][1],$resu[$i][2],...
      * this function is more 'standard' but use a little

main/inc/lib/sub_language.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -18,6 +18,7 @@ 
      * Get all files of lang folder (forum.inc.php,gradebook.inc.php,notebook.inc.php)
      * @param String The lang path folder  (/var/www/my_lms/main/lang/spanish)
      * @param bool true if we only want the "subname" trad4all instead of  trad4all.inc.php
+     * @param string $path
      *
      * @return Array All file of lang folder
      */
@@ -68,6 +69,7 @@ 
     /**
      * Get all information of language
      * @param Integer The parent id(Language father id)
+     * @param integer $parent_id
      * @return Array All information about language
      */
     public static function get_all_information_of_language($parent_id)
@@ -86,6 +88,7 @@ 
     /**
      * Get all information of chamilo file
      * @param String The chamilo path file (/var/www/chamilo/main/lang/spanish/gradebook.inc.php)
+     * @param string $system_path_file
      * @patam Bool Whether we want to remove the '$' prefix in the results or not
      * @return Array Contains all information of chamilo file
      */
@@ -345,7 +348,7 @@ 
     /**
      * Make available the language
      * @param Integer The language id
-     * @return void
+     * @return boolean
      */
     public static function make_available_language($language_id)
     {

main/inc/lib/system/session.class.php

Doc Comments +3 added lines

@@ -14,6 +14,9 @@
 class Session implements \ArrayAccess
 {
 
+    /**
+     * @param string $variable
+     */
     static function read($variable, $default = null)
     {
         return isset($_SESSION[$variable]) ? $_SESSION[$variable] : $default;

main/inc/lib/system/web/request.class.php

Doc Comments +4 added lines

@@ -31,6 +31,10 @@
         return $method == 'GET';
     }
 
+    /**
+     * @param string $key
+     * @param string $default
+     */
     public static function post($key, $default = null)
     {
         return isset($_POST[$key]) ? $_POST[$key] : $default;

main/inc/lib/system_announcements.lib.php

Doc Comments +3 added lines, -1 removed lines

@@ -306,7 +306,7 @@ 
 	 * @param int    Whether the announcement should be visible to anonymous users (1) or not (0)
 	 * @param string The language for which the announvement should be shown. Leave null for all langages
 	 * @param int    Whether to send an e-mail to all users (1) or not (0)
-	 * @return mixed  insert_id on success, false on failure
+	 * @return false|string  insert_id on success, false on failure
 	 */
     public static function add_announcement(
         $title,
@@ -648,6 +648,8 @@ 
 	 * @param	int		Whether to send to all teachers (1) or not (0)
 	 * @param	int		Whether to send to all students (1) or not (0)
 	 * @param	string	Language (optional, considered for all languages if left empty)
+	 * @param integer|null $teacher
+	 * @param integer|null $student
      * @return  bool    True if the message was sent or there was no destination matching. False on database or e-mail sending error.
 	 */
 	public static function send_system_announcement_by_email($title, $content, $teacher, $student, $language = null, $sendEmailTest = false)

main/inc/lib/table_sort.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
 	 * @param string $direction The direction to sort (SORT_ASC (default) orSORT_DESC)
 	 * @param array $column_show The columns that we will show in the table i.e: $column_show = array('1','0','1') we will show the 1st and the 3th column.
 	 * @param array $column_order Changes how the columns will be sorted ie. $column_order = array('0','3','2','3') The column [1] will be sorted like the column [3]
-	 * @param constant $type How should data be sorted (SORT_REGULAR, SORT_NUMERIC, SORT_STRING, SORT_DATE, SORT_IMAGE)
+	 * @param integer $type How should data be sorted (SORT_REGULAR, SORT_NUMERIC, SORT_STRING, SORT_DATE, SORT_IMAGE)
 	 * @return array The sorted dataset
 	 * @author bart.mollet@hogent.be
 	 */

main/inc/lib/template.lib.php

Doc Comments +2 added lines

@@ -330,6 +330,7 @@ 
     /**
      * Sets the footer visibility
      * @param bool true if we show the footer
+     * @param boolean $status
      */
     public function set_footer($status)
     {
@@ -370,6 +371,7 @@ 
     /**
      * Sets the header visibility
      * @param bool true if we show the header
+     * @param boolean $status
      */
     public function set_header($status)
     {

main/inc/lib/text.lib.php

Doc Comments +10 added lines, -5 removed lines

@@ -52,6 +52,7 @@ 
  * Converts the text of a html-document to a given encoding, the meta-tag is changed accordingly.
  * @param string $string                The input full-html document.
  * @param string                        The new encoding value to be set.
+ * @param string $encoding
  */
 function api_set_encoding_html(&$string, $encoding) {
     $old_encoding = api_detect_encoding_html($string);
@@ -74,7 +75,7 @@ 
  * Returns the title of a html document.
  * @param string $string                The contents of the input document.
  * @param string $input_encoding        The encoding of the input document. If the value is not set, it is detected.
- * @param string $$output_encoding      The encoding of the retrieved title. If the value is not set, the system encoding is assumend.
+ * @param string $output_encoding      The encoding of the retrieved title. If the value is not set, the system encoding is assumend.
  * @return string                       The retrieved title, html-entities and extra-whitespace between the words are cleaned.
  */
 function api_get_title_html(&$string, $output_encoding = null, $input_encoding = null) {
@@ -433,7 +434,7 @@ 
  * @since wordpress  2.8.1
  * @access private
  *
- * @param string|array $search The value being searched for, otherwise known as the needle. An array may be used to designate multiple needles.
+ * @param string[] $search The value being searched for, otherwise known as the needle. An array may be used to designate multiple needles.
  * @param string $subject The string being searched and replaced on, otherwise known as the haystack.
  * @return string The string with the replaced svalues.
  */
@@ -628,6 +629,7 @@ 
  * @param string    The text to "cut"
  * @param int       Count of chars
  * @param bool      Whether to embed in a <span title="...">...</span>
+ * @param integer $maxchar
  * @return string
  * */
 function cut($text, $maxchar, $embed = false) {
@@ -645,7 +647,7 @@ 
  *
  * @param mixed     Number to convert
  * @param int       Decimal points 0=never, 1=if needed, 2=always
- * @return mixed    An integer or a float depends on the parameter
+ * @return string|null    An integer or a float depends on the parameter
  */
 function float_format($number, $flag = 1) {
     if (is_numeric($number)) {
@@ -689,7 +691,7 @@ 
 /**
  * Gets the week from a day
  * @param   string   Date in UTC (2010-01-01 12:12:12)
- * @return  int      Returns an integer with the week number of the year
+ * @return  string      Returns an integer with the week number of the year
  */
 function get_week_from_day($date) {
     if (!empty($date)) {
@@ -739,6 +741,9 @@ 
 	return $output.$end;
 }
 
+/**
+ * @param string $glue
+ */
 function implode_with_key($glue, $array) {
     if (!empty($array)) {
         $string = '';
@@ -817,7 +822,7 @@ 
 /**
  * @param string $string
  * @param bool $capitalizeFirstCharacter
- * @return mixed
+ * @return string
  */
 function underScoreToCamelCase($string, $capitalizeFirstCharacter = true)
 {

main/inc/lib/urlmanager.lib.php

Doc Comments +16 added lines, -14 removed lines

@@ -18,7 +18,7 @@ 
     * @param	string	$url The URL of the site
     * @param	string  $description The description of the site
     * @param	int		$active is active or not
-    * @return boolean if success
+    * @return Doctrine\DBAL\Driver\Statement|null if success
     */
     public static function add($url, $description, $active)
     {
@@ -43,7 +43,7 @@ 
     * @param	string 	$url
     * @param	string  $description The description of the site
     * @param	int		$active is active or not
-    * @return 	boolean if success
+    * @return 	Doctrine\DBAL\Driver\Statement|null if success
     */
     public static function update($url_id, $url, $description, $active)
     {
@@ -67,7 +67,7 @@ 
     * @author Julio Montoya
     * @param int $id url id
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete($id)
     {
@@ -366,7 +366,7 @@ 
     * @author Julio Montoya
     * @param int user id
     * @param int url id
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_user_exist($user_id, $url_id)
     {
@@ -384,7 +384,7 @@ 
     * @author Julio Montoya
     * @param int $courseId
     * @param int $urlId
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_course_exist($courseId, $urlId)
     {
@@ -405,7 +405,7 @@ 
      * @author Julio Montoya
      * @param int $userGroupId
      * @param int $urlId
-     * @return boolean true if success
+     * @return integer true if success
      * */
     public static function relationUrlUsergroupExist($userGroupId, $urlId)
     {
@@ -424,7 +424,7 @@ 
     * @author Julio Montoya
     * @param int user id
     * @param int url id
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_session_exist($session_id, $url_id)
     {
@@ -545,6 +545,8 @@ 
      * @author Julio Montoya
      * @param  array of course ids
      * @param  array of url_ids
+     * @param integer[] $courseCategoryList
+     * @param integer[] $urlList
      * @return array
      **/
     public static function addCourseCategoryListToUrl($courseCategoryList, $urlList)
@@ -575,7 +577,7 @@ 
      * @author Julio Montoya
      * @param int $categoryCourseId
      * @param int $urlId
-     * @return boolean true if success
+     * @return integer true if success
      * */
     public static function relationUrlCourseCategoryExist($categoryCourseId, $urlId)
     {
@@ -592,7 +594,7 @@ 
     /**
      * @param int $userGroupId
      * @param int $urlId
-     * @return int
+     * @return string
      */
     public static function addUserGroupToUrl($userGroupId, $urlId)
     {
@@ -692,7 +694,7 @@ 
      * @param int $courseId
      * @param int $url_id
      *
-     * @return resource
+     * @return boolean
      */
     public static function add_course_to_url($courseId, $url_id = 1)
     {
@@ -763,7 +765,7 @@ 
     * @param  int  $courseId
     * @param  int  $urlId
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete_url_rel_course($courseId, $urlId)
     {
@@ -781,7 +783,7 @@ 
      * @param  int $userGroupId
      * @param  int $urlId
      *
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public static function delete_url_rel_usergroup($userGroupId, $urlId)
     {
@@ -800,7 +802,7 @@ 
      * @param  int $userGroupId
      * @param  int $urlId
      *
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public static function deleteUrlRelCourseCategory($userGroupId, $urlId)
     {
@@ -819,7 +821,7 @@ 
     * @param  char  course code
     * @param  int url id
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete_url_rel_session($session_id, $url_id)
     {