chamilo / chamilo-lms

main/inc/lib/display.lib.php

Doc Comments +26 added lines, -17 removed lines

@@ -32,7 +32,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function toolList()
     {
@@ -290,7 +290,6 @@ 
      * 					'page_nr' = The page to display
      * 					'hide_navigation' =  true to hide the navigation
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $form actions Additional variables to add in the query-string
      * @param mixed An array with bool values to know which columns show.
      * i.e: $visibility_options= array(true, false) we will only show the first column
      * 				Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
@@ -331,7 +330,6 @@ 
      * 					'page_nr' = The page to display
      * 					'hide_navigation' =  true to hide the navigation
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $form actions Additional variables to add in the query-string
      * @param mixed An array with bool values to know which columns show. i.e:
      *  $visibility_options= array(true, false) we will only show the first column
      * 	Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
@@ -388,10 +386,11 @@ 
      * 					'per_page' = number of items to show per page
      * 					'page_nr' = The page to display
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $column_show Array of binaries 1= show columns 0. hide a column
+     * @param integer[] $column_show Array of binaries 1= show columns 0. hide a column
      * @param array $column_order An array of integers that let us decide how the columns are going to be sort.
      * 						      i.e:  $column_order=array('1''4','3','4'); The 2nd column will be order like the 4th column
      * @param array $form_actions Set optional forms actions
+     * @param string $table_name
      *
      * @author Julio Montoya
      */
@@ -444,7 +443,7 @@ 
      * @param bool	$filter (true) or not (false)
      * @param bool $returnValue
      *
-     * @return void
+     * @return string|null
      */
     public static function display_normal_message($message, $filter = true, $returnValue = false)
     {
@@ -474,7 +473,7 @@ 
     /**
      * Displays an confirmation message. Use this if something has been done successfully
      * @param bool	Filter (true) or not (false)
-     * @return void
+     * @return string|null
      */
     public static function display_confirmation_message ($message, $filter = true, $returnValue = false)
     {
@@ -491,7 +490,7 @@ 
      * @param string $message - include any additional html
      *                          tags if you need them
      * @param bool	Filter (true) or not (false)
-     * @return void
+     * @return string|null
      */
     public static function display_error_message ($message, $filter = true, $returnValue = false)
     {
@@ -681,6 +680,7 @@ 
      * @param string   The alt text (probably a language variable)
      * @param array    additional attributes (for instance height, width, onclick, ...)
      * @param integer  The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
+     * @param string $image
      * @return void
     */
     public static function display_icon(
@@ -886,6 +886,7 @@ 
     /**
      * Displays an HTML input tag
      *
+     * @param string $type
      */
     public static function input($type, $name, $value, $attributes = array())
     {
@@ -902,8 +903,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $value
+     * @param string $name
+     * @param string $value
      * @param array $attributes
      * @return string
      */
@@ -918,6 +919,7 @@ 
     /**
      * Displays an HTML select tag
      *
+     * @param string $blank_item_text
      */
     public static function select(
         $name,
@@ -984,8 +986,8 @@ 
                         $( "#tabs" ).tabs();
                     });
                 </script>
-     * @param   array   $headers list of the tab titles
-     * @param   array   $items
+     * @param   string[]   $headers list of the tab titles
+     * @param   string[]   $items
      * @param   string  $id id of the container of the tab in the example "tabs"
      * @param   array   $attributes for the ul
      * @param array $ul_attributes
@@ -1039,7 +1041,7 @@ 
 
     /**
      * @param $headers
-     * @param null $selected
+     * @param integer $selected
      *
      * @return string
      */
@@ -1077,6 +1079,7 @@ 
      * As you can see both function use the same "my_grid_name" this is very important otherwise nothing will work
      *
      * @param   string  the div id, this value must be the same with the first parameter of Display::grid_js()
+     * @param string $div_id
      * @return  string  html
      *
      */
@@ -1632,6 +1635,8 @@ 
      * @param  string  url that will be added (for jquery see hot_courses.tpl)
 	 * @param	string	point info array see function CourseManager::get_course_ranking()
 	 * @param	bool	add a div wrapper
+	 * @param string $id
+	 * @param string $url
 	 * @todo	use     templates
      **/
     public static function return_rating_system($id, $url, $point_info = array(), $add_div_wrapper = true)
@@ -1727,6 +1732,9 @@ 
         return '<'.$size.'>'.Security::remove_XSS($title).'</'.$size.'>';
     }
 
+    /**
+     * @param string $title
+     */
     public static function page_subheader2($title, $second_title = null)
     {
         return self::page_header($title, $second_title, 'h4');
@@ -1957,6 +1965,7 @@ 
 
     /**
      * @todo use twig
+     * @param string $title
      */
     public static function group_button($title, $elements)
     {
@@ -2174,9 +2183,9 @@ 
 
     /**
      * @param int $id
-     * @param array $content
+     * @param string[] $content
      * @param int $col
-     * @param bool|true $right
+     * @param boolean $right
      * @return string
      */
     public static function toolbarAction($id, $content = array(), $col = 2, $right = true)
@@ -2258,10 +2267,10 @@ 
     /**
      * @param string $title
      * @param string $content
-     * @param null $id
+     * @param string $id
      * @param array $params
-     * @param null $idAccordion
-     * @param null $idCollapse
+     * @param string $idAccordion
+     * @param string $idCollapse
      * @param bool|true $open
      * @param bool|false $fullClickable
      * @return null|string

main/inc/lib/career.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 
     /**
      * Available driver list.
-     * @return array
+     * @return string[]
      */
     private function getDefaultDriverList()
     {

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)
     {