chamilo / chamilo-lms

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,
@@ -667,6 +667,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(

main/inc/lib/urlmanager.lib.php

Doc Comments +16 added lines, -13 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)
     {
@@ -386,7 +386,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)
     {
@@ -404,7 +404,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)
     {
@@ -425,7 +425,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)
     {
@@ -445,7 +445,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)
     {
@@ -568,6 +568,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)
@@ -598,7 +600,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)
     {
@@ -615,7 +617,7 @@ 
     /**
      * @param int $userGroupId
      * @param int $urlId
-     * @return int
+     * @return string
      */
     public static function addUserGroupToUrl($userGroupId, $urlId)
     {
@@ -716,7 +718,7 @@ 
      * @param int $courseId
      * @param int $url_id
      *
-     * @return resource
+     * @return boolean
      */
     public static function add_course_to_url($courseId, $url_id = 1)
     {
@@ -807,7 +809,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)
     {
@@ -825,7 +827,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)
     {
@@ -844,7 +846,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)
     {
@@ -862,8 +864,9 @@ 
     * @author Julio Montoya
     * @param  char  course code
     * @param  int url id
+    * @param integer $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)
     {

main/inc/lib/userportal.lib.php

Doc Comments +9 added lines, -8 removed lines

@@ -682,6 +682,7 @@ 
     * retrieves all the courses that the user has already subscribed to
     * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
     * @param int $user_id: the id of the user
+    * @param integer $user_id
     * @return array an array containing all the information of the courses of the given user
     */
     public function get_courses_of_user($user_id)
@@ -732,13 +733,13 @@ 
 
     /**
      * @todo use the template system
-     * @param $title
-     * @param $content
+     * @param string|null $title
+     * @param string $content
      * @param string $id
      * @param array $params
      * @param string $idAccordion
      * @param string $idCollapse
-     * @return null|string
+     * @return string
      */
     public function show_right_block(
         $title,
@@ -960,7 +961,7 @@ 
     }
 
     /**
-     * @return null|string
+     * @return string
      */
     public function return_navigation_links()
     {
@@ -990,7 +991,7 @@ 
     }
 
     /**
-     * @return null|string
+     * @return string
      */
     public function return_course_block()
     {
@@ -1680,8 +1681,8 @@ 
 
     /**
      * Return HTML code for personal user course category
-     * @param $id
-     * @param $title
+     * @param integer $id
+     * @param string $title
      * @return string
      */
     private static function getHtmlForUserCategory($id, $title)
@@ -1702,7 +1703,7 @@ 
     /**
      * return HTML code for course display in session view
      * @param array $courseInfo
-     * @param $userCategoryId
+     * @param integer $userCategoryId
      * @param bool $displayButton
      * @param $loadDirs
      * @return string

src/Chamilo/CourseBundle/Entity/CForumThread.php

Doc Comments +1 added lines, -1 removed lines

@@ -181,7 +181,7 @@
 
     /**
      * set threadPeerQualify
-     * @param $threadPeerQualify
+     * @param integer $threadPeerQualify
      * @return $this
      */
     public function setThreadPeerQualify($threadPeerQualify)

main/work/work.lib.php

Doc Comments +15 added lines, -13 removed lines

@@ -696,7 +696,7 @@ 
  * @author Bert Vanderkimpen
  * @author Yannick Warnier <ywarnier@beeznest.org> Adaptation for work tool
  * @param   string $base_work_dir Base work dir (.../work)
- * @param   string $desiredDirName complete path of the desired name
+ * @param   string $desired_dir_name complete path of the desired name
  *
  * @return  string actual directory name if it succeeds, boolean false otherwise
  */
@@ -718,7 +718,7 @@ 
 /**
  * Delete a work-tool directory
  * @param   int  $id work directory id to delete
- * @return  integer -1 on error
+ * @return  boolean|null -1 on error
  */
 function deleteDirWork($id)
 {
@@ -861,7 +861,7 @@ 
  * Update the url of a dir in the student_publication table
  * @param  array $work_data work original data
  * @param  string $newPath Example: "folder1"
- * @return bool
+ * @return boolean|null
  */
 function updateDirName($work_data, $newPath)
 {
@@ -922,6 +922,7 @@ 
 /**
  * Transform an all directory structure (only directories) in an array
  * @param   string path of the directory
+ * @param string $directory
  * @return  array the directory structure into an array
  * @author  Julio Montoya Dokeos
  * @version April 2008
@@ -991,7 +992,7 @@ 
  * @param   string the path of the directory
  * @param   boolean true if we want the total quantity of files
  * include in others child directories, false only  files in the directory
- * @return  array the first element is an integer with the number of files
+ * @return  integer[] the first element is an integer with the number of files
  * in the folder, the second element is the number of directories
  * @author  Julio Montoya
  * @version April 2008
@@ -2724,7 +2725,7 @@ 
  * @param int $userId
  * @param int $workId
  * @param int $courseId
- * @return bool
+ * @return boolean|null
  */
 function allowOnlySubscribedUser($userId, $workId, $courseId)
 {
@@ -2842,7 +2843,7 @@ 
 /**
  * Get total score from a work list
  * @param $workList
- * @return int|null
+ * @return integer
  */
 function getTotalWorkScore($workList)
 {
@@ -2858,7 +2859,7 @@ 
  * Get comment count from a work list (docs sent by students)
  * @param array $workList
  * @param array $courseInfo
- * @return int|null
+ * @return integer
  */
 function getTotalWorkComment($workList, $courseInfo = array())
 {
@@ -2998,6 +2999,7 @@ 
  * @param int $parentId
  * @param array $courseInfo
  * @param int $sessionId
+ * @param integer $userId
  * @return int
  */
 function getLastWorkStudentFromParentByUser(
@@ -4140,7 +4142,7 @@ 
 }
 
 /**
- * @return array
+ * @return string[]
  */
 function getUploadDocumentType()
 {
@@ -4513,7 +4515,7 @@ 
  * @param int Session ID
  * @param $correction
  *
- * @return array|bool
+ * @return boolean
  */
 function getFileContents($id, $course_info, $sessionId = 0, $correction = false)
 {
@@ -4631,7 +4633,7 @@ 
  * @param int $userId
  * @param array $courseInfo
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllWork($userId, $courseInfo, $format = 'pdf')
 {
@@ -4677,7 +4679,7 @@ 
  * @param array $courseInfo
  * @param int $sessionId
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllStudentWorkFromPublication(
     $workId,
@@ -4815,7 +4817,7 @@ 
  * Downloads all user files per user
  * @param int $userId
  * @param array $courseInfo
- * @return bool
+ * @return false|null
  */
 function downloadAllFilesPerUser($userId, $courseInfo)
 {
@@ -4929,7 +4931,7 @@ 
 /**
  * @param array $courseInfo
  * @param int $workId
- * @return bool
+ * @return boolean|null
  */
 function protectWork($courseInfo, $workId)
 {

plugin/vchamilo/lib/Virtual.php

Doc Comments +9 added lines, -7 removed lines

@@ -140,7 +140,7 @@ 
     * provides a side connection to a vchamilo database
     * @param array $_configuration
      *
-    * @return \Doctrine\DBAL\Driver\Connection
+    * @return string
     */
     public static function bootConnection(&$_configuration)
     {
@@ -303,7 +303,7 @@ 
 
     /**
     * get a proper SQLdump command
-    * @param object $vmoodledata the complete new host information
+    * @param stdClass $vchamilodata
     * @return string the shell command
     */
     public static function getDatabaseDumpCmd($vchamilodata)
@@ -383,8 +383,8 @@ 
 
     /**
      * Dumps a SQL database for having a snapshot.
-     * @param        $vchamilo    object        The Vchamilo object.
-     * @param        $outputfilerad    string        The output SQL file radical.
+     * @param        stdClass $vchamilo    object        The Vchamilo object.
+     * @param        string $outputfilerad    string        The output SQL file radical.
      * @return        bool    If TRUE, dumping database was a success, otherwise FALSE.
      */
     public static function dumpDatabase($vchamilo, $outputfilerad)
@@ -560,6 +560,8 @@ 
     * internal primitives. This avoids too many changes to do in imported
     * code
     *
+    * @param string $module
+    * @param string $key
     */
     public static function getConfig($module, $key, $isplugin = true)
     {
@@ -628,7 +630,7 @@ 
     /**
      * @param string $path
      *
-     * @return mixed
+     * @return string
      */
     public static function chopLastSlash($path)
     {
@@ -760,7 +762,7 @@ 
     }
 
     /**
-     * @param object $instance
+     * @param stdClass $instance
      * @return \Doctrine\DBAL\Connection
      */
     public static function getConnectionFromInstance($instance, $getManager = false)
@@ -1169,7 +1171,7 @@ 
     /**
      * @param stdClass $instance
      *
-     * @return bool|string returns the original version of the app
+     * @return string|false returns the original version of the app
      */
     public static function canBeUpgraded($instance)
     {