chamilo / chamilo-lms

main/inc/lib/image.lib.php

Doc Comments +10 added lines, -3 removed lines

@@ -86,7 +86,7 @@ 
     /**
      * @param string $file
      * @param int $compress
-     * @param null $convert_file_to
+     * @param string $convert_file_to
      * @return bool
      */
     public function send_image(
@@ -181,7 +181,7 @@ 
 
     /**
      * ImagickWrapper constructor.
-     * @param $path
+     * @param string $path
      */
     public function __construct($path)
     {
@@ -232,6 +232,10 @@ 
     }
 
     //@todo implement border logic case for Imagick
+
+    /**
+     * @param integer $border
+     */
     public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
         if (!$this->image_validated) return false;
@@ -329,7 +333,7 @@ 
 
     /**
      * GDWrapper constructor.
-     * @param $path
+     * @param string $path
      */
     public function __construct($path)
     {
@@ -392,6 +396,9 @@ 
         }
     }
 
+    /**
+     * @param integer $border
+     */
     public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
         if (!$this->image_validated) {

main/inc/lib/social.lib.php

Doc Comments +13 added lines, -5 removed lines

@@ -66,6 +66,7 @@ 
      * @param int user id
      * @param int user friend id
      * @param string
+     * @param integer $user_friend
      * @return int
      * @author isaac flores paz
      */
@@ -129,6 +130,8 @@ 
      * @param int group id
      * @param string name to search
      * @param bool true will load firstname, lastname, and image name
+     * @param integer $user_id
+     * @param integer $id_group
      * @return array
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code, function renamed, $load_extra_info option added
      * @author isaac flores paz
@@ -210,6 +213,9 @@ 
      * @param int user friend id
      * @param string title of the message
      * @param string content of the message
+     * @param integer $user_id
+     * @param string $message_title
+     * @param string $message_content
      * @return boolean
      * @author isaac flores paz
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code
@@ -287,6 +293,7 @@ 
      * Get number messages of the inbox
      * @author isaac flores paz
      * @param int user receiver id
+     * @param integer $user_receiver_id
      * @return int
      */
     public static function get_message_number_invitation_by_user_id($user_receiver_id)
@@ -477,6 +484,7 @@ 
      * Denies invitation
      * @param int user sender id
      * @param int user receiver id
+     * @param integer $user_receiver_id
      * @return bool
      *
      * @author isaac flores paz
@@ -579,7 +587,7 @@ 
      * @param string $subject
      * @param string $content
      *
-     * @return string message invitation
+     * @return false|null message invitation
      */
     public static function sendInvitationToUser($userId, $subject = '', $content = '')
     {
@@ -1379,7 +1387,7 @@ 
      * @param string $messageContent of the message
      * @param int $messageId id parent
      * @param string $messageStatus status type of message
-     * @return boolean
+     * @return false|string
      * @author Yannick Warnier
      */
     public static function sendWallMessage(
@@ -1480,7 +1488,7 @@ 
      * Gets all messages from someone's wall (within specific limits)
      * @param int $userId id of wall shown
      * @param string $messageStatus status wall message
-     * @param int|string $parentId id message (Post main)
+     * @param integer|null $parentId id message (Post main)
      * @param string $start Date from which we want to show the messages, in UTC time
      * @param int $limit Limit for the number of parent messages we want to show
      * @param int $offset Wall message query offset
@@ -1796,7 +1804,7 @@ 
 
     /**
      * verify if Url Exist - Using Curl
-     * @param $uri url
+     * @param string $uri url
      *
      * @return boolean
      */
@@ -1822,7 +1830,7 @@ 
     /**
     * Delete messages delete logic
     * @param int $id id message to delete.
-    * @return bool status query
+    * @return Statement status query
     */
     public static function deleteMessage($id)
     {

main/lp/aicc.class.php

Doc Comments +6 added lines, -4 removed lines

@@ -224,7 +224,7 @@ 
     /**
      * Import the aicc object (as a result from the parse_config_files function) into the database structure
      * @param    string $course_code
-     * @return    bool    Returns -1 on error
+     * @return    false|null    Returns -1 on error
      */
     public function import_aicc($course_code)
     {
@@ -641,7 +641,7 @@ 
     /**
      * Sets the Author LP in the database
      * @param    string $author
-     * @return true
+     * @return boolean
      */
     public function set_author($author = '')
     {
@@ -811,7 +811,8 @@ 
      * Static function to parse AICC ini files.
      * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
      * @param	string	File path
-     * @return	array	Structured array
+     * @param string $f
+     * @return	string	Structured array
      */
     public function parse_ini_file_quotes_safe($f)
     {
@@ -864,7 +865,7 @@ 
      * @param		string	INI File string
      * @param		array	List of names of sections that should be considered
      * as containing only hard string data (no variables), provided in lower case
-     * @return	array	Structured array
+     * @return	string	Structured array
      */
     public function parse_ini_string_quotes_safe($s, $pure_strings = array())
     {
@@ -928,6 +929,7 @@ 
      * @param	string	CSV delimiter
      * @param	string	CSV enclosure
      * @param	boolean	Might one field name happen more than once on the same line? (then split by comma in the values)
+     * @param string $f
      * @return array	Simple structured array
      */
     public function parse_csv_file($f, $delim = ',', $enclosure = '"', $multiples = false)

main/inc/lib/MoodleImport.php

Doc Comments +8 added lines, -8 removed lines

@@ -408,7 +408,7 @@ 
      * Read and validate the quiz module XML
      *
      * @param resource $moduleXml XML file
-     * @return mixed | array if is a valid xml file, false otherwise
+     * @return string | array if is a valid xml file, false otherwise
      */
     public function readQuizModule($moduleXml)
     {
@@ -626,7 +626,7 @@ 
      * Fix moodle files that contains spaces
      * @param array $importedFiles
      * @param string $text
-     * @return mixed
+     * @return string
      */
     public function fixPathInText($importedFiles, &$text)
     {
@@ -648,10 +648,10 @@ 
      *
      * @param array $questionList
      * @param string $questionType
-     * @param object $questionInstance Question/Answer instance
+     * @param Question $questionInstance Question/Answer instance
      * @param array $currentQuestion
      * @param array $importedFiles
-     * @return integer db response
+     * @return boolean|null db response
      */
     public function processAnswers(
         $questionList,
@@ -809,7 +809,7 @@ 
     /**
      * Process Chamilo Unique Answer
      *
-     * @param object $objAnswer
+     * @param Answer $objAnswer
      * @param array $answerValues
      * @param integer $position
      * @param integer $questionWeighting
@@ -850,7 +850,7 @@ 
     /**
      * Process Chamilo True False
      *
-     * @param object $objAnswer
+     * @param Answer $objAnswer
      * @param array $answerValues
      * @param integer $position
      * @param integer $questionWeighting
@@ -892,7 +892,7 @@ 
     /**
      * Process Chamilo FillBlanks
      *
-     * @param object $objAnswer
+     * @param Answer $objAnswer
      * @param array $questionType
      * @param array $answerValues
      * @param string $placeholder
@@ -1051,7 +1051,7 @@ 
      * Litle utility to delete the unuseful tags
      *
      * @param $array
-     * @param $keys
+     * @param string[] $keys
      */
     public function traverseArray(&$array, $keys)
     {

main/webservices/cm_webservice_course.php

Doc Comments +5 added lines, -4 removed lines

@@ -18,7 +18,7 @@ 
      *
      * @param string Course id field name
      * @param string Course id value
-     * @return mixed True if the course was successfully deleted, WSError otherwise
+     * @return WSError True if the course was successfully deleted, WSError otherwise
      */
     protected function deleteCourseHelper(
         $course_id_field_name,
@@ -110,7 +110,7 @@ 
      * @param string Course id field name
      * @param string Course id value
      * @param array Course extra fields
-     * @return mixed Generated id if creation was successful, WSError otherwise
+     * @return WSError Generated id if creation was successful, WSError otherwise
      */
     protected function createCourseHelper(
         $title,
@@ -278,7 +278,7 @@ 
      * @param int Unsubscribe (0 = denied, 1 = allowed)
      * @param string Visual code
      * @param array Course extra fields
-     * @return mixed True in case of success, WSError otherwise
+     * @return WSError True in case of success, WSError otherwise
      */
     protected function editCourseHelper(
         $course_id_field_name,
@@ -456,7 +456,8 @@ 
      * @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
-     * @return mixed True if subscription or unsubscription was successful, false otherwise
+     * @param integer $state
+     * @return WSError True if subscription or unsubscription was successful, false otherwise
      */
     protected function changeUserSubscription(
         $course_id_field_name,

main/webservices/cm_webservice_inbox.php

Doc Comments +3 added lines

@@ -205,6 +205,9 @@
         }
     }
 
+    /**
+     * @param integer $user_id
+     */
     protected function set_message_as_read($user_id, $message_id)
     {
         $table_message = Database::get_main_table(TABLE_MESSAGE);

main/inc/lib/AnnouncementManager.php

Doc Comments +10 added lines, -5 removed lines

@@ -20,7 +20,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getTags()
     {
@@ -266,7 +266,7 @@ 
      * @param int $courseId
      * @param int $userId
      *
-     * @return array
+     * @return integer
      */
     public static function getAnnouncementInfoById(
         $announcementId,
@@ -492,7 +492,7 @@ 
      * @param bool $sendToUsersInSession
      * @param int $authorId
      *
-     * @return int      false on failure, ID of the announcement on success
+     * @return false|string      false on failure, ID of the announcement on success
      */
     public static function add_announcement(
         $courseInfo,
@@ -628,7 +628,7 @@ 
      * @param string $file_comment
      * @param bool $sendToUsersInSession
      *
-     * @return bool|int
+     * @return false|string
      */
     public static function add_group_announcement(
         $title,
@@ -886,7 +886,7 @@ 
 
     /**
      * @param int $insert_id
-     * @return bool
+     * @return false|null
      */
     public static function update_mail_sent($insert_id)
     {
@@ -906,6 +906,7 @@ 
      * Gets all announcements from a user by course
      * @param string course db
      * @param int user id
+     * @param integer $user_id
      * @return array html with the content and count of announcements or false otherwise
      */
     public static function get_all_annoucement_by_user_course($course_code, $user_id)
@@ -1135,6 +1136,7 @@ 
      * has been sent to
      * @param    string  The tool (announcement, agenda, ...)
      * @param    int     ID of the element of the corresponding type
+     * @param string $tool
      * @return   array   Array of users and groups to whom the element has been sent
      */
     public static function sent_to($tool, $id)
@@ -1206,6 +1208,7 @@ 
      * @param int  announcement id
      * @param string file comment
      * @param array  uploaded file $_FILES
+     * @param string|null $file_comment
      * @return int  -1 if failed, 0 if unknown (should not happen), 1 if success
      */
     public static function add_announcement_attachment_file(
@@ -1268,6 +1271,8 @@ 
      * @param int attach id
      * @param array uploaded file $_FILES
      * @param string file comment
+     * @param integer $id_attach
+     * @param string $file_comment
      * @return int
      */
     public static function edit_announcement_attachment_file(

main/inc/lib/blog.lib.php

Doc Comments +6 added lines, -6 removed lines

@@ -327,7 +327,7 @@ 
      * @param string $full_text The full text of the new post
      * @param string $file_comment The text of the comment (if any)
      * @param int $blog_id The internal blog ID
-     * @return void
+     * @return string|null
      */
     public static function createPost($title, $full_text, $file_comment, $blog_id)
     {
@@ -1156,7 +1156,7 @@ 
      * @param int $blog_id
      * @param int $post_id
      * @param int $task_id
-     * @return array
+     * @return integer
      */
     public static function getThreadedComments(
         $current = 0,
@@ -1277,7 +1277,7 @@ 
      * @param int $blog_id
      * @param int $post_id
      * @param int $comment_id
-     * @return void
+     * @return string|null
      */
     public static function displayRatingCreateForm($type, $blog_id, $post_id, $comment_id = null)
     {
@@ -1346,7 +1346,7 @@ 
      * @param string $type
      * @param integer $blog_id
      * @param integer $item_id
-     * @return array
+     * @return double
      */
     public static function displayRating($type, $blog_id, $item_id)
     {
@@ -2463,7 +2463,7 @@ 
      * The listed users are users subcribed in the course.
      * @author Toon Keppens
      * @param int $blog_id
-     * @return false|null Form with sortable table with users to unsubcribe from a blog.
+     * @return false|string Form with sortable table with users to unsubcribe from a blog.
      */
     public static function displayUserUnsubscriptionForm($blog_id)
     {
@@ -2924,7 +2924,7 @@ 
      * @param int $blog_id the blog's id
      * @param int $post_id the post's id
      * @param int $comment_id the comment's id
-     * @return array with the post info according the parameters
+     * @return integer with the post info according the parameters
      * @author Julio Montoya
      * @version avril 2008, dokeos 1.8.5
      */

main/inc/lib/search/search_widget.php

Doc Comments +3 added lines

@@ -191,6 +191,7 @@ 
  * Build the prefilter form.
  *
  * This type allow filter all other multiple select terms by one term in a dinamic way
+ * @param string $prefilter_prefix
  */
 function search_widget_prefilter_form(
     $action,
@@ -285,6 +286,8 @@ 
 
 /**
  * Show search form
+ * @param string $action
+ * @param boolean $show_thesaurus
  */
 function display_search_form($action, $show_thesaurus, $sf_terms, $op)
 {