chamilo / chamilo-lms

main/webservices/webservice_course.php

Doc Comments +1 added lines

@@ -342,6 +342,7 @@
 	 * @param string User id value
 	 * @param int Set to 1 to subscribe, 0 to unsubscribe
 	 * @param int Status (STUDENT or TEACHER) Used for subscription only
+	 * @param integer $state
 	 * @return mixed True if subscription or unsubscription was successful, false otherwise
 	 */
 	protected function changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $state, $status = STUDENT) {

main/work/downloadfolder.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -327,7 +327,7 @@
  * @param array $arr1 first array
  * @param array $arr2 second array
  *
- * @return array difference between the two arrays
+ * @return string difference between the two arrays
  */
 function diff($arr1, $arr2)
 {

main/work/work.lib.php

Doc Comments +14 added lines, -12 removed lines

@@ -714,7 +714,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
  */
@@ -736,7 +736,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)
 {
@@ -893,7 +893,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)
 {
@@ -952,6 +952,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
  * @version April 2008
@@ -1026,7 +1027,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
@@ -2781,7 +2782,7 @@ 
  * @param int $userId
  * @param int $workId
  * @param int $courseId
- * @return bool
+ * @return boolean|null
  */
 function allowOnlySubscribedUser($userId, $workId, $courseId)
 {
@@ -3058,6 +3059,7 @@ 
  * @param int $parentId
  * @param array $courseInfo
  * @param int $sessionId
+ * @param integer $userId
  * @return int
  */
 function getLastWorkStudentFromParentByUser(
@@ -3753,7 +3755,7 @@ 
  * @param array $formValues
  * @param int $user_id
  * @param array $courseInfo
- * @param int $group_id
+ * @param integer $groupId
  * @param int $session_id
  * @return bool|int
  * @note $params can have the following elements, but should at least have the 2 first ones: (
@@ -4280,7 +4282,7 @@ 
 }
 
 /**
- * @return array
+ * @return string[]
  */
 function getUploadDocumentType()
 {
@@ -4668,7 +4670,7 @@ 
  * @param int Session ID
  * @param $correction
  *
- * @return array|bool
+ * @return boolean
  */
 function getFileContents($id, $course_info, $sessionId = 0, $correction = false)
 {
@@ -4786,7 +4788,7 @@ 
  * @param int $userId
  * @param array $courseInfo
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllWork($userId, $courseInfo, $format = 'pdf')
 {
@@ -4832,7 +4834,7 @@ 
  * @param array $courseInfo
  * @param int $sessionId
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllStudentWorkFromPublication(
     $workId,
@@ -4970,7 +4972,7 @@ 
  * Downloads all user files per user
  * @param int $userId
  * @param array $courseInfo
- * @return bool
+ * @return false|null
  */
 function downloadAllFilesPerUser($userId, $courseInfo)
 {
@@ -5084,7 +5086,7 @@ 
 /**
  * @param array $courseInfo
  * @param int $workId
- * @return bool
+ * @return boolean|null
  */
 function protectWork($courseInfo, $workId)
 {

src/Chamilo/ContactBundle/Controller/ContactController.php

Doc Comments +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
      * @Route("/", name="contact")
      *
      * @param Request $request
-     * @return mixed
+     * @return Response
      */
     public function indexAction(Request $request)
     {

src/Chamilo/CourseBundle/Component/CourseCopy/CourseArchiver.php

Doc Comments +1 added lines, -1 removed lines

@@ -212,7 +212,7 @@
 
     /**
      * @param array $file
-     * @return bool|string
+     * @return string|false
      */
     public static function importUploadedFile($file)
     {

src/Chamilo/CourseBundle/Component/CourseCopy/CourseRecycler.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
      * course
      * @param string $backupType 'full_backup' or 'select_items'
      *
-     * @return bool
+     * @return false|null
      *
      * @assert (null) === false
      */

src/Chamilo/CourseBundle/Component/CourseCopy/Resources/Asset.php

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
      * Asset constructor.
      * @param int $id
      * @param int $path
-     * @param $title
+     * @param string $title
      */
     public function __construct($id, $path, $title)
     {

src/Chamilo/CourseBundle/Component/CourseCopy/Resources/DummyCourseCreator.php

Doc Comments +1 added lines

@@ -272,6 +272,7 @@
     }
     /**
      * Get dummy titles, descriptions and texts
+     * @param string $type
      */
     function get_dummy_content($type)
     {

main/inc/lib/link.lib.php

Doc Comments +12 added lines, -3 removed lines

@@ -470,6 +470,7 @@ 
      *
      * Get link info
      * @param int link id
+     * @param integer $id
      * @return array link info
      *
      **/
@@ -855,7 +856,7 @@ 
     }
 
     /**
-     * @param $categoryId
+     * @param integer $categoryId
      * @param $courseId
      * @param $sessionId
      * @param bool $withBaseContent
@@ -902,8 +903,8 @@ 
      * @author Julio Montoya
      *
      * @param $catid
-     * @param $courseId
-     * @param $session_id
+     * @param integer $courseId
+     * @param integer $session_id
      * @return string
      */
     public static function showLinksPerCategory($catid, $courseId, $session_id)
@@ -1107,6 +1108,8 @@ 
     /**
      * Displays the edit, delete and move icons
      * @param int   Category ID
+     * @param integer $currentCategory
+     * @param integer $countCategories
      * @return string
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1247,6 +1250,7 @@ 
     /**
      * CSV file import functions
      * @author René Haentjens , Ghent University
+     * @param string $catname
      */
     public static function get_cat($catname)
     {
@@ -1281,6 +1285,11 @@ 
     /**
      * CSV file import functions
      * @author René Haentjens , Ghent University
+     * @param string $url
+     * @param string $title
+     * @param string $description
+     * @param string $on_homepage
+     * @param string $hidden
      */
     public static function put_link($url, $cat, $title, $description, $on_homepage, $hidden)
     {