chamilo / chamilo-lms

main/inc/lib/system_announcements.lib.php

Doc Comments +1 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,

main/inc/lib/api.lib.php

Doc Comments +5 added lines, -2 removed lines

@@ -1359,6 +1359,7 @@ 
  * Gets the list of courses a specific user is subscribed to
  * @param int       User ID
  * @param boolean   $fetch_session Whether to get session courses or not - NOT YET IMPLEMENTED
+ * @param integer $userid
  * @return array    Array of courses in the form [0]=>('code'=>xxx,'db'=>xxx,'dir'=>xxx,'status'=>d)
  */
 function api_get_user_courses($userid, $fetch_session = true)
@@ -6733,7 +6734,7 @@ 
 /**
  * Returns an array of global configuration settings which should be ignored
  * when printing the configuration settings screens
- * @return array Array of strings, each identifying one of the excluded settings
+ * @return string[] Array of strings, each identifying one of the excluded settings
  */
 function api_get_locked_settings() {
     return array(
@@ -6776,6 +6777,7 @@ 
  * false if he isn't. If the user ID is given and is an integer, then the same
  * ID is simply returned
  * @param  integer User ID
+ * @param integer $user_id
  * @return boolean Integer User ID is logged in, or false otherwise
  */
 function api_user_is_login($user_id = null) {
@@ -7220,6 +7222,7 @@ 
 /**
  * Gets memory limit in bytes
  * @param string The memory size (128M, 1G, 1000K, etc)
+ * @param string $mem
  * @return int
  * @assert (null) === false
  * @assert ('1t')  === 1099511627776
@@ -8131,7 +8134,7 @@ 
 /**
  * Like strip_tags(), but leaves an additional space and removes only the given tags
  * @param string $string
- * @param array $tags Tags to be removed
+ * @param string[] $tags Tags to be removed
  * @return  string The original string without the given tags
  */
 function stripGivenTags($string, $tags) {

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

Doc Comments +4 added lines, -1 removed 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;
@@ -39,7 +42,7 @@ 
      * Returns true if session has variable set up, false otherwise.
      *
      * @param string $variable
-     * @return mixed value
+     * @return boolean value
      */
     static function has($variable)
     {

main/exercice/export/exercise_import.inc.php

Doc Comments -1 removed lines

@@ -949,7 +949,6 @@
 /**
  * Processes an IMS/QTI manifest file: store links to new files to be able to transform them into questions text
  * @param string $filePath The absolute filepath
- * @param array $links List of filepaths changes
  * @return bool
  */
 function qtiProcessManifest($filePath)

main/inc/lib/document.lib.php

Doc Comments +21 added lines, -18 removed lines

@@ -277,7 +277,7 @@ 
     /**
      *  @param string
      *  @param string
-     * 	@return true if the user is allowed to see the document, false otherwise
+     * 	@return boolean if the user is allowed to see the document, false otherwise
      * 	@author Sergio A Kessler, first version
      * 	@author Roan Embrechts, bugfix
      *  @todo not only check if a file is visible, but also check if the user is allowed to see the file??
@@ -736,7 +736,7 @@ 
      * Gets the paths of all folders in a course
      * can show all folders (except for the deleted ones) or only visible ones
      *
-     * @param array $_course
+     * @param Chamilo\CoreBundle\Entity\Course $_course
      * @param int $to_group_id
      * @param boolean $can_see_invisible
      *
@@ -1544,7 +1544,7 @@ 
      * Return true if the documentpath have visibility=1 as
      * item_property (you should use the is_visible_by_id)
      *
-     * @param string $document_path the relative complete path of the document
+     * @param string $doc_path the relative complete path of the document
      * @param array  $course the _course array info of the document's course
      * @param int
      * @param string
@@ -1629,6 +1629,8 @@ 
      * @param   int
      * @param   int
      * @param bool
+     * @param integer $session_id
+     * @param integer $user_id
      * @return  bool
      */
     public static function is_visible_by_id(
@@ -2116,6 +2118,7 @@ 
      * @param	bool  	is file or string html
      * @param	string	type (one of the app tools) - optional (otherwise takes the current item's type)
      * @param	int		level of recursivity we're in
+     * @param string $source_html
      * @return	array	List of file paths. An additional field containing 'local' or 'remote' helps determine
      * if the file should be copied into the zip or just linked
      */
@@ -2942,6 +2945,7 @@ 
 
     /**
      * Obtains the text inside the file with the right parser
+     * @param string $doc_path
      */
     public static function get_text_content($doc_path, $doc_mime)
     {
@@ -3192,6 +3196,7 @@ 
      * Shows a play icon next to the document title in the document list
      * @param int
      * @param string
+     * @param integer|null $i
      * @return string	html content
      */
     static function generate_media_preview($i, $type = 'simple')
@@ -4082,7 +4087,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_web_odf_extension_list()
     {
@@ -4091,10 +4096,10 @@ 
 
     /**
      * Set of extension allowed to use Jodconverter
-     * @param $mode 'from'
+     * @param string $mode 'from'
      *              'to'
      *              'all'
-     * @param $format   'text'
+     * @param string $format   'text'
      *                  'spreadsheet'
      *                  'presentation'
      *                  'drawing'
@@ -4298,7 +4303,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_system_folders()
     {
@@ -4316,7 +4321,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getProtectedFolderFromStudent()
     {
@@ -4472,7 +4477,7 @@ 
      * Requires the ffmpeg lib. In ubuntu: sudo apt-get install ffmpeg
      * @param string $wavFile
      * @param bool $removeWavFileIfSuccess
-     * @return bool
+     * @return string|false
      */
     public static function convertWavToMp3($wavFile, $removeWavFileIfSuccess = false)
     {
@@ -5561,9 +5566,6 @@ 
     /**
      * Creates the row of edit icons for a file/folder
      *
-     * @param string $curdirpath current path (cfr open folder)
-     * @param string $type (file/folder)
-     * @param string $path dbase path of file/folder
      * @param int $visibility (1/0)
      * @param int $id dbase id of the document
      * @return string html img tags with hyperlinks
@@ -5893,7 +5895,7 @@ 
     /**
      * Gets the path translated with title of docs and folders
      * @param string $path the real path
-     * @return the path which should be displayed
+     * @return string path which should be displayed
      */
     public static function get_titles_of_path($path)
     {
@@ -5948,7 +5950,8 @@ 
 
     /**
      * Checks whether the user is in shared folder
-     * @return return bool Return true when user is into shared folder
+     * @param integer $current_session_id
+     * @return boolean bool Return true when user is into shared folder
      */
     public static function is_shared_folder($curdirpath, $current_session_id)
     {
@@ -5964,7 +5967,7 @@ 
 
     /**
      * Checks whether the user is into any user shared folder
-     * @return return bool Return true when user is in any user shared folder
+     * @return boolean bool Return true when user is in any user shared folder
      */
     public static function is_any_user_shared_folder($path, $current_session_id)
     {
@@ -6178,7 +6181,7 @@ 
      * @param int $id
      * @param array $courseInfo
      * @param int $sessionId
-     * @return bool
+     * @return boolean|null
      */
     public static function downloadDeletedDocument($id, $courseInfo, $sessionId)
     {
@@ -6197,7 +6200,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public static function downloadAllDeletedDocument($courseInfo, $sessionId)
     {
@@ -6236,7 +6239,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public function deleteDocumentsFromSession($courseInfo, $sessionId)
     {