chamilo / chamilo-lms

main/inc/lib/message.lib.php

Doc Comments +7 added lines, -5 removed lines

@@ -639,6 +639,8 @@ 
      * @param  int	message id
      * @param  int	message user id (receiver user id or sender user id)
      * @param  int	group id (optional)
+     * @param integer $message_id
+     * @param integer $message_uid
      * @return void
      */
     public static function delete_message_attachment_file($message_id, $message_uid, $group_id = 0)
@@ -683,7 +685,7 @@ 
      * update messages by user id and message id
      * @param  int		$user_id
      * @param  int		$message_id
-     * @return resource
+     * @return false|null
      */
     public static function update_message($user_id, $message_id)
     {
@@ -703,7 +705,7 @@ 
      * @param int $user_id
      * @param int $message_id
      * @param string $type
-     * @return bool
+     * @return false|null
      */
     public static function update_message_status($user_id, $message_id,$type)
     {
@@ -740,6 +742,7 @@ 
     /**
      * get messages by group id
      * @param  int		group id
+     * @param integer $group_id
      * @return array
      */
     public static function get_messages_by_group($group_id)
@@ -1477,7 +1480,7 @@ 
      * Sort date by desc from a multi-dimensional array
      * @param array $array1  first array to compare
      * @param array $array2  second array to compare
-     * @return bool
+     * @return integer
      */
     public function order_desc_date($array1, $array2)
     {
@@ -1555,7 +1558,6 @@ 
     /**
      * @param $id
      * @param array $params
-     * @param string $display
      * @return string
      */
     public static function generate_invitation_form($id, $params = array())
@@ -1644,7 +1646,7 @@ 
 
     /**
      * @param string $keyword
-     * @return null|string
+     * @return string
      */
     public static function outbox_display($keyword = '')
     {

main/inc/lib/course_category.lib.php

Doc Comments +4 added lines, -5 removed lines

@@ -103,7 +103,7 @@ 
      * @param string $canHaveCourses
      * @param int $parent_id
      *
-     * @return bool
+     * @return false|string
      */
     public static function addNode($code, $name, $canHaveCourses, $parent_id)
     {
@@ -297,8 +297,7 @@ 
     /**
      * Counts the number of children categories a category has
      * @param int $categoryId The ID of the category of which we want to count the children
-     * @param int $count The number of subcategories we counted this far
-     * @return mixed The number of subcategories this category has
+     * @return integer The number of subcategories this category has
      */
     public static function courseCategoryChildrenCount($categoryId)
     {
@@ -476,7 +475,7 @@ 
     /**
      * @param int $id
      *
-     * @return bool
+     * @return boolean|null
      */
     public static function addToUrl($id)
     {
@@ -958,7 +957,7 @@ 
      * Get Pagination HTML div
      * @param $pageCurrent
      * @param $pageLength
-     * @param $pageTotal
+     * @param integer $pageTotal
      * @return string
      */
     public static function getCatalogPagination($pageCurrent, $pageLength, $pageTotal)

src/Chamilo/CoreBundle/Entity/Session.php

Doc Comments +5 added lines, -5 removed lines

@@ -364,7 +364,7 @@ 
     }
 
     /**
-     * @param $courses
+     * @param ArrayCollection $courses
      */
     public function setCourses($courses)
     {
@@ -460,7 +460,7 @@ 
      * @param Course $course
      * @param string $status
      *
-     * @return \Doctrine\Common\Collections\Collection|static
+     * @return ArrayCollection
      */
     public function getUserInCourse(User $user, Course $course, $status = null)
     {
@@ -506,7 +506,7 @@ 
      * Set description
      *
      * @param string $description
-     * @return Groups
+     * @return Session
      */
     public function setDescription($description)
     {
@@ -839,7 +839,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getStatusList()
     {
@@ -991,7 +991,7 @@ 
      * Get user from course by status
      * @param \Chamilo\CoreBundle\Entity\Course $course
      * @param string $status
-     * @return \Doctrine\Common\Collections\Collection|static
+     * @return ArrayCollection
      */
     public function getUserCourseSubscriptionsByStatus(Course $course, $status)
     {

src/Chamilo/PageBundle/Entity/User.php

Doc Comments +6 added lines, -6 removed lines

@@ -964,7 +964,7 @@ 
     /**
      * Get pictureUri
      *
-     * @return Media
+     * @return string
      */
     public function getPictureUri()
     {
@@ -1341,7 +1341,7 @@ 
     }
 
     /**
-     * @return Media
+     * @return string
      */
     public function getAvatar()
     {
@@ -1610,7 +1610,7 @@ 
     /**
      * Returns the creation date.
      *
-     * @return \DateTime|null
+     * @return \DateTime
      */
     public function getCreatedAt()
     {
@@ -1634,7 +1634,7 @@ 
     /**
      * Returns the last update date.
      *
-     * @return \DateTime|null
+     * @return \DateTime
      */
     public function getUpdatedAt()
     {
@@ -1644,7 +1644,7 @@ 
     /**
      * Returns the expiration date.
      *
-     * @return \DateTime|null
+     * @return \DateTime
      */
     public function getExpiresAt()
     {
@@ -2108,7 +2108,7 @@ 
       /**
      * Returns the user roles
      *
-     * @return array The roles
+     * @return string[] The roles
      */
     public function getRoles()
     {

plugin/vchamilo/cli/clilib.php

Doc Comments +2 added lines, -2 removed lines

@@ -191,7 +191,7 @@ 
  * @param string $prompt text prompt, should include possible options
  * @param string $default default value when enter pressed
  * @param array $options list of allowed options, empty means any text
- * @param bool $casesensitive true if options are case sensitive
+ * @param bool $casesensitiveoptions true if options are case sensitive
  * @return string entered text
  */
 function cli_input($prompt, $default='', array $options=null, $casesensitiveoptions=false) {
@@ -288,7 +288,7 @@ 
 /**
  * Print or return section separator string
  * @param bool $return false means print, true return as string
- * @return mixed void or string
+ * @return string|null void or string
  */
 function cli_separator($return=false) {
     $separator = str_repeat('-', 79)."\n";

src/Chamilo/FaqBundle/Entity/Category.php

Doc Comments +2 added lines, -2 removed lines

@@ -93,7 +93,7 @@ 
      *
      * @param string $rank
      *
-     * @return Question
+     * @return Category
      */
     public function setRank($rank)
     {
@@ -201,7 +201,7 @@ 
     /**
      * Get questions
      *
-     * @return \Doctrine\Common\Collections\Collection
+     * @return Question[]
      */
     public function getQuestions()
     {

src/Chamilo/ContactBundle/Controller/ContactController.php

Doc Comments +1 added lines, -1 removed lines

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

main/inc/lib/events.lib.php

Doc Comments +20 added lines, -10 removed lines

@@ -239,7 +239,7 @@ 
     }
 
     /**
-     * @param doc_id id of document (id in mainDb.document table)
+     * @param doc_id string of document (id in mainDb.document table)
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @desc Record information for upload event
      * used in the works tool to record informations when
@@ -313,6 +313,9 @@ 
      * @param   int     session_id
      * @param   int     learnpath_id (id of the learnpath)
      * @param   int     learnpath_item_id (id of the learnpath_item)
+     * @param integer $score
+     * @param integer $weighting
+     * @param integer $session_id
      *
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @author Julio Montoya Armas <gugli100@gmail.com> Reworked 2010
@@ -414,7 +417,9 @@ 
      * @param	integer	Session ID (from the session table). Default value of null means "get from context".
      * @param	integer	Learnpath ID (from c_lp table). Default value of null means "get from context".
      * @param	integer	Learnpath item ID (from the c_lp_item table). Default value of null means "get from context".
-     * @return	boolean	Result of the insert query
+     * @param integer $exe_id
+     * @param integer $position
+     * @return	false|string	Result of the insert query
      */
     public static function saveQuestionAttempt(
         $score,
@@ -581,6 +586,7 @@ 
      * @param	int		Whether this answer is correct (1) or not (0)
      * @param	string	Coordinates of this point (e.g. 123;324)
      * @param	bool update results?
+     * @param integer $exe_id
      * @return	boolean	Result of the insert query
      * @uses Course code and user_id from global scope $_cid and $_user
      */
@@ -720,7 +726,6 @@ 
     /**
      * Get every email stored in the database
      *
-     * @param int $etId
      * @return type
      * @assert () !== false
      */
@@ -788,11 +793,11 @@ 
     /**
      * Save the new message for one event and for one language
      *
-     * @param string $eventName
+     * @param string $event_name
      * @param array $users
      * @param string $message
      * @param string $subject
-     * @param string $eventMessageLanguage
+     * @param string $event_message_language
      * @param int $activated
      */
     public static function save_event_type_message($event_name, $users, $message, $subject, $event_message_language, $activated)
@@ -926,10 +931,10 @@ 
     }
 
     /**
-     * @param $user_id
+     * @param integer $user_id
      * @param $exerciseId
-     * @param $lp_id
-     * @param $lp_item_id
+     * @param integer $lp_id
+     * @param integer $lp_item_id
      * @return int
      */
     public static function get_attempt_count_not_finished($user_id, $exerciseId, $lp_id, $lp_item_id)
@@ -1106,6 +1111,7 @@ 
      * @param   int     exercise id
      * @param   int $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1201,6 +1207,7 @@ 
      * @param   int     exercise id
      * @param   int  $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1241,6 +1248,7 @@ 
      * @param   int     exercise id
      * @param   string  course code
      * @param   int     session id
+     * @param integer $exe_id
      * @return  array   with the results
      *
      */
@@ -1290,6 +1298,8 @@ 
      * @param   int     lp id
      * @param   int     lp item id
      * @param   string 	order asc or desc
+     * @param integer $courseId
+     * @param string $order
      * @return  array   with the results
      *
      */
@@ -1349,7 +1359,7 @@ 
      * @param   int     exercise id
      * @param   int     $courseId
      * @param   int     session id
-     * @return  array   with the results
+     * @return  string   with the results
      *
      */
     public static function count_exercise_attempts_by_user($user_id, $exercise_id, $courseId, $session_id = 0)
@@ -1525,7 +1535,7 @@ 
      * @param   int     exercise id
      * @param   int   course id
      * @param   int     session id
-     * @return  array   with the results
+     * @return  integer   with the results
      *
      */
     public static function get_count_exercises_attempted_by_course($courseId, $session_id = 0)

plugin/vchamilo/views/editinstance_form.php

Doc Comments +5 added lines, -5 removed lines

@@ -13,9 +13,9 @@ 
 
     /**
      * ChamiloForm constructor.
-     * @param $mode
-     * @param $returnurl
-     * @param $cancelurl
+     * @param string $mode
+     * @param string $returnurl
+     * @param string $cancelurl
      * @param $customdata
      */
     public function __construct($mode, $returnurl, $cancelurl, $customdata = [])
@@ -137,7 +137,7 @@ 
      * Check that form data is valid.
      * You should almost always use this, rather than {@see validate_defined_fields}
      *
-     * @return bool true if form data valid
+     * @return boolean|null true if form data valid
      */
     public function is_validated()
     {
@@ -166,7 +166,7 @@ 
      *                is NOT to validate the form when a no submit button has been pressed.
      *                pass true here to override this behaviour
      *
-     * @return bool true if form data valid
+     * @return boolean|null true if form data valid
      */
     public function validate_defined_fields($validateonnosubmit=false)
     {