chamilo / chamilo-lms

main/inc/lib/attendance.lib.php

Doc Comments +20 added lines, -6 removed lines

@@ -277,7 +277,7 @@ 
      * Add attendances sheet inside table. This is the *list of* dates, not
      * a specific date in itself.
      * @param  bool   true for adding link in gradebook or false otherwise (optional)
-     * @return int    last attendance id
+     * @return false|string    last attendance id
      */
     public function attendance_add($link_to_gradebook = false)
     {
@@ -354,6 +354,7 @@ 
      * edit attendances inside table
      * @param 	int	   attendance id
      * @param  	bool   true for adding link in gradebook or false otherwise (optional)
+     * @param integer $attendance_id
      * @return 	int    last id
      */
     public function attendance_edit($attendance_id, $link_to_gradebook = false)
@@ -429,6 +430,7 @@ 
     /**
      * Restore attendance
      * @param 	int|array	   one or many attendances id
+     * @param integer $attendance_id
      * @return 	int    		   affected rows
      */
     public function attendance_restore($attendance_id)
@@ -478,7 +480,7 @@ 
 
     /**
      * Delete attendances
-     * @param 	int|array	$attendance_id   one or many attendances id
+     * @param 	integer	$attendance_id   one or many attendances id
      * @return 	int    		   affected rows
      */
     public function attendance_delete($attendance_id)
@@ -530,7 +532,7 @@ 
 
     /**
      * Changes visibility
-     * @param int|array	$attendanceId   one or many attendances id
+     * @param integer	$attendanceId   one or many attendances id
      * @param int status
      *
      * @return 	int affected rows
@@ -585,6 +587,7 @@ 
      * Lock or unlock an attendance
      * @param   int     attendance id
      * @param   bool    True to lock or false otherwise
+     * @param integer $attendance_id
      */
     public function lock_attendance($attendance_id, $lock = true)
     {
@@ -918,7 +921,10 @@ 
      * @param   string  Event type ('locked_attendance', 'done_attendance_sheet' ...)
      * @param   int     Last edit user id
      * @param   string  Calendar datetime value (optional, when event type is 'done_attendance_sheet')
-     * @return  int     Affected rows
+     * @param integer $attendance_id
+     * @param string $lastedit_type
+     * @param integer $lastedit_user_id
+     * @return  false|string     Affected rows
      */
     public function save_attendance_sheet_log(
         $attendance_id,
@@ -963,6 +969,7 @@ 
     /**
      * Get number of done attendances inside current sheet
      * @param	int	   attendance id
+     * @param integer $attendance_id
      * @return 	int	   number of done attendances
      */
     public static function get_done_attendance_calendar($attendance_id)
@@ -1198,6 +1205,7 @@ 
     /**
      * Get next attendance calendar without presences (done attendances)
      * @param	int	attendance id
+     * @param integer $attendance_id
      * @return 	int attendance calendar id
      */
     public function get_next_attendance_calendar_id($attendance_id)
@@ -1226,6 +1234,7 @@ 
     /**
      * Get next attendance calendar datetime without presences (done attendances)
      * @param	int	attendance id
+     * @param integer $attendance_id
      * @return 	int UNIX time format datetime
      */
     public function get_next_attendance_calendar_datetime($attendance_id)
@@ -1254,6 +1263,7 @@ 
      * Get user' score from current attendance
      * @param	int	$user_id
      * @param	int $attendance_id
+     * @param integer $groupId
      * @return	int score
      */
     public function get_user_score($user_id, $attendance_id, $groupId = null)
@@ -1301,6 +1311,7 @@ 
     /**
      * Get attendance calendar data by id
      * @param	int	attendance calendar id
+     * @param integer $calendar_id
      * @return	array attendance calendar data
      */
     public function get_attendance_calendar_by_id($calendar_id)
@@ -1423,6 +1434,7 @@ 
      * Get number of attendance calendar inside current attendance
      * @param	int	$attendance_id
      * @param	int	$groupId
+     * @param boolean $done_attendance
      * @return	int number of dates in attendance calendar
      */
     public static function get_number_of_attendance_calendar($attendance_id, $groupId = 0, $done_attendance = NULL, $userId = 0)
@@ -1648,7 +1660,6 @@ 
     /**
      * @param int $calendarId
      * @param int $courseId
-     * @param int $groupId
      * @return array
      */
     public function getGroupListByAttendanceCalendar($calendarId, $courseId)
@@ -1688,7 +1699,6 @@ 
     /**
      * @param int $calendarId
      * @param int $courseId
-     * @param int $groupId
      *
      * @return array
      */
@@ -1789,6 +1799,8 @@ 
      * edit a datetime inside attendance calendar table
      * @param	int	attendance calendar id
      * @param	int	attendance id
+     * @param integer $calendar_id
+     * @param integer $attendance_id
      * @return	int affected rows
      */
     public function attendance_calendar_edit($calendar_id, $attendance_id)
@@ -1828,6 +1840,8 @@ 
      * @param	int		attendance calendar id
      * @param	int		attendance id
      * @param	bool	true for removing all calendar inside current attendance, false for removing by calendar id
+     * @param integer $calendar_id
+     * @param integer $attendance_id
      * @return	int affected rows
      */
     public function attendance_calendar_delete($calendar_id, $attendance_id , $all_delete = false)

plugin/buycourses/src/buy_course_plugin.class.php

Doc Comments +13 added lines, -13 removed lines

@@ -45,7 +45,7 @@ 
 

     /**

      *

-     * @return StaticPlugin

+     * @return BuyCoursesPlugin

      */

     static function create()

     {

@@ -268,7 +268,7 @@ 
     /**

      * Save a transfer account information

      * @param array $params The transfer account

-     * @return int Rows affected. Otherwise return false

+     * @return false|string Rows affected. Otherwise return false

      */

     public function saveTransferAccount($params)

     {

@@ -680,7 +680,7 @@ 
     /**

      * Get session info

      * @param array $sessionId The session ID

-     * @return array

+     * @return Session

      */

     public function getSessionInfo($sessionId)

     {

@@ -773,7 +773,7 @@ 
      * Register a sale

      * @param int $itemId The product ID

      * @param int $paymentType The payment type

-     * @return boolean

+     * @return false|string

      */

     public function registerSale($itemId, $paymentType)

     {

@@ -955,7 +955,7 @@ 
 

     /**

      * Get payment types

-     * @return array

+     * @return string[]

      */

     public function getPaymentTypes()

     {

@@ -994,7 +994,7 @@ 
 

     /**

      * Get the statuses for sales

-     * @return array

+     * @return string[]

      */

     public function getSaleStatuses()

     {

@@ -1007,7 +1007,7 @@ 
 

     /**

      * Get the statuses for Payouts

-     * @return array

+     * @return string[]

      */

     public function getPayoutStatuses()

     {

@@ -1020,7 +1020,7 @@ 
 

     /**

      * Get the list of product types

-     * @return array

+     * @return string[]

      */

     public function getProductTypes()

     {

@@ -1401,7 +1401,7 @@ 
     /**

      * Register a item

      * @param array $itemData The item data

-     * @return int The item ID. Otherwise return false

+     * @return false|string The item ID. Otherwise return false

      */

     public function registerItem(array $itemData)

     {

@@ -1559,7 +1559,7 @@ 
     /**

      * Verify if the beneficiary have a paypal account

      * @param int $userId

-     * @return true if the user have a paypal account, false if not

+     * @return boolean if the user have a paypal account, false if not

      */

     public function verifyPaypalAccountByBeneficiary($userId)

     {

@@ -1681,7 +1681,7 @@ 
     /**

      * Register addicional service

      * @param array params $service

-     * @return mixed response

+     * @return string|false response

      */

     public function storeService($service)

     {

@@ -1838,7 +1838,7 @@ 
 

     /**

      * Get the statuses for sales

-     * @return array

+     * @return string[]

      */

     public function getServiceSaleStatuses()

     {

@@ -2094,7 +2094,7 @@ 
      * @param int $paymentType The payment type

      * @param int $infoSelect The ID for Service Type

      * @param int $trial trial mode

-     * @return boolean

+     * @return false|string

      */

     public function registerServiceSale($serviceId, $paymentType, $infoSelect, $trial = null)

     {

src/Chamilo/SettingsBundle/Templating/Helper/SettingsHelper.php

Doc Comments +2 added lines, -2 removed lines

@@ -37,7 +37,7 @@ 
 
     /**
      * @param string $schemaAlias Example: admin, agenda, etc
-     * @return object|\Sylius\Bundle\SettingsBundle\Model\SettingsInterface
+     * @return \Sylius\Bundle\SettingsBundle\Model\SettingsInterface
      */
     public function getSettings($schemaAlias)
     {
@@ -46,7 +46,7 @@ 
 
     /**
      * @param string $parameter Example: admin.administrator_name
-     * @return mixed
+     * @return string
      */
     public function getSettingsParameter($parameter)
     {

src/Chamilo/SettingsBundle/Twig/SettingsExtension.php

Doc Comments +2 added lines, -2 removed lines

@@ -56,7 +56,7 @@ 
      *
      * @param string $namespace
      *
-     * @return array
+     * @return \Sylius\Bundle\SettingsBundle\Model\SettingsInterface
      */
     public function getSettings($namespace)
     {
@@ -65,7 +65,7 @@ 
 
     /**
      * @param $name
-     * @return mixed
+     * @return string
      */
     public function getSettingsParameter($name)
     {

main/inc/lib/course_home.lib.php

Doc Comments +3 added lines, -2 removed lines

@@ -218,7 +218,7 @@ 
     /**
      * Displays the tools of a certain category.
      *
-     * @return void
+     * @return string
      * @param string $course_tool_category	contains the category of tools to display:
      * "Public", "PublicButHide", "courseAdmin", "claroAdmin"
      */
@@ -1014,6 +1014,7 @@ 
      * Shows the general data for a particular meeting
      *
      * @param id	session id
+     * @param integer $id_session
      * @return string	session data
      */
     public static function show_session_data($id_session)
@@ -1517,7 +1518,7 @@ 
 
     /**
      * Available tools
-     * @return array
+     * @return string[]
      */
     public static function availableTools()
     {

main/inc/lib/display.lib.php

Doc Comments +27 added lines, -19 removed lines

@@ -34,7 +34,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function toolList()
     {
@@ -176,8 +176,7 @@ 
 
     /**
      * @param string $tool
-     * @param array $editor_config
-     * @return null
+     * @return string|null
      */
     public static function return_introduction_section($tool, $toolList = null)
     {
@@ -465,7 +464,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
@@ -506,7 +504,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
@@ -563,10 +560,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
      */
@@ -621,7 +619,7 @@ 
      *
      * @deprecated use Display::addFlash with Display::return_message($message, 'normal');
      *
-     * @return void
+     * @return string|null
      */
     public static function display_normal_message($message, $filter = true, $returnValue = false)
     {
@@ -653,7 +651,7 @@ 
      * Displays an confirmation message. Use this if something has been done successfully
      * @param bool	Filter (true) or not (false)
      * @deprecated use Display::addFlash with Display::return_message
-     * @return void
+     * @return string|null
      */
     public static function display_confirmation_message ($message, $filter = true, $returnValue = false)
     {
@@ -672,7 +670,7 @@ 
      * @param bool	Filter (true) or not (false)
      * @deprecated use Display::addFlash with Display::return_message
      *
-     * @return void
+     * @return string|null
      */
     public static function display_error_message ($message, $filter = true, $returnValue = false)
     {
@@ -853,6 +851,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(
@@ -1024,6 +1023,7 @@ 
     /**
      * Displays an HTML input tag
      *
+     * @param string $type
      */
     public static function input($type, $name, $value, $attributes = array())
     {
@@ -1040,8 +1040,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $value
+     * @param string $name
+     * @param string $value
      * @param array $attributes
      * @return string
      */
@@ -1056,6 +1056,7 @@ 
     /**
      * Displays an HTML select tag
      *
+     * @param string $blank_item_text
      */
     public static function select(
         $name,
@@ -1122,8 +1123,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
@@ -1177,7 +1178,7 @@ 
 
     /**
      * @param $headers
-     * @param null $selected
+     * @param integer $selected
      *
      * @return string
      */
@@ -1215,6 +1216,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
      *
      */
@@ -1775,6 +1777,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)
@@ -1865,6 +1869,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');
@@ -2097,6 +2104,7 @@ 
 
     /**
      * @todo use twig
+     * @param string $title
      */
     public static function group_button($title, $elements)
     {
@@ -2467,9 +2475,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)
@@ -2553,10 +2561,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/thematic.lib.php

Doc Comments +13 added lines, -4 removed lines

@@ -34,6 +34,9 @@ 
         $this->course_int_id = api_get_course_int_id();
     }
 
+    /**
+     * @param integer $course_id
+     */
     public function setCourseIntId($course_id)
     {
         $this->course_int_id = intval($course_id);
@@ -248,6 +251,8 @@ 
     /**
      * get thematic list
      * @param	int		Thematic id (optional), get list by id
+     * @param string $course_code
+     * @param integer $session_id
      * @return	array	Thematic data
      */
     public static function get_thematic_list(
@@ -805,6 +810,7 @@ 
     /**
      * delete  thematic advance
      * @param	int		Thematic advance id
+     * @param integer $thematic_advance_id
      * @return	int		Affected rows
      */
     public function thematic_advance_destroy($thematic_advance_id)
@@ -1122,6 +1128,7 @@ 
     /**
      * update done thematic advances from thematic details interface
      * @param 	int		Thematic id
+     * @param integer $thematic_advance_id
      * @return	int		Affected rows
      */
     public function update_done_thematic_advances($thematic_advance_id)
@@ -1349,6 +1356,7 @@ 
      * Get average of advances by thematic
      * @param	int		Thematic id
      * @param	string	Course code (optional)
+     * @param string $course_code
      * @return 	float	Average of thematic advances
      */
     public function get_average_of_advances_by_thematic($thematic_id, $course_code = null)
@@ -1413,6 +1421,7 @@ 
      * @param	string	Content
      * @param	string	Date and time
      * @param	int		Duration in hours
+     * @param integer $id
      * @return void
      */
     public function set_thematic_advance_attributes(
@@ -1443,7 +1452,7 @@ 
 
     /**
      * get thematic id
-     * @return void
+     * @return integer
      */
     public function get_thematic_id()
     {
@@ -1452,7 +1461,7 @@ 
 
     /**
      * Get thematic plan titles by default
-     * @return array
+     * @return string[]
      */
     public function get_default_thematic_plan_title()
     {
@@ -1469,7 +1478,7 @@ 
 
     /**
      * Get thematic plan icons by default
-     * @return array
+     * @return string[]
      */
     public function get_default_thematic_plan_icon()
     {
@@ -1486,7 +1495,7 @@ 
 
     /**
      * Get questions by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_question()
     {

src/Chamilo/UserBundle/Entity/User.php

Doc Comments +5 added lines, -5 removed lines

@@ -673,7 +673,7 @@ 
     }
 
     /**
-     * @param $portal
+     * @param AccessUrlRelUser $portal
      */
     public function setPortal($portal)
     {
@@ -1033,7 +1033,7 @@ 
     /**
      * Get pictureUri
      *
-     * @return Media
+     * @return string
      */
     public function getPictureUri()
     {
@@ -2118,7 +2118,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string|null
      */
     public function getPlainPassword()
     {
@@ -2130,7 +2130,7 @@ 
       /**
      * Returns the user roles
      *
-     * @return array The roles
+     * @return string[] The roles
      */
     public function getRoles()
     {
@@ -2455,7 +2455,7 @@ 
     /**
      * Check if the user has the skill
      * @param Skill $skill The skill
-     * @return boolean
+     * @return boolean|null
      */
     public function hasSkill(Skill $skill)
     {

main/inc/lib/api.lib.php

Doc Comments +8 added lines, -3 removed lines

@@ -1263,6 +1263,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)
@@ -3024,7 +3025,7 @@ 
 * on the session visibility
 * @param bool $tutor  Whether to check if the user has the tutor role
 * @param bool  $coach Whether to check if the user has the coach role
-* @return boolean true: the user has the rights to edit, false: he does not
+* @return boolean|null true: the user has the rights to edit, false: he does not
 */
 function api_is_allowed_to_session_edit($tutor = false, $coach = false)
 {
@@ -4199,6 +4200,7 @@ 
 /**
  * Returns the id (the database id) of a language
  * @param   string  language name (the corresponding name of the language-folder in the filesystem)
+ * @param string $language
  * @return  int     id of the language
  */
 function api_get_language_id($language)
@@ -5207,6 +5209,7 @@ 
  * @param string    Whether we want a simple list (display a category) or
  * a grouped list (group by variable as in settings.php default). Values: 'list' or 'group'
  * @param int       Access URL's ID. Optional. Uses 1 by default, which is the unique URL
+ * @param string $cat
  * @return array    Array of database results for the current settings of the current access URL
  */
 function &api_get_settings($cat = null, $ordering = 'list', $access_url = 1, $url_changeable = 0)
@@ -6285,7 +6288,7 @@ 
  *
  * Returns the <link> HTML tag
  *
- * @param $file
+ * @param string $file
  * @param string $media
  * @return string
  */
@@ -6608,7 +6611,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(
@@ -6649,6 +6652,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) {
@@ -7069,6 +7073,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