chamilo / chamilo-lms

main/exercise/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/MoodleImport.php

Doc Comments +7 added lines, -7 removed lines

@@ -317,7 +317,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)
     {
@@ -537,9 +537,9 @@ 
      *
      * @param array $questionList
      * @param string $questionType
-     * @param object $questionInstance Question/Answer instance
+     * @param Question $questionInstance Question/Answer instance
      * @param array $currentQuestion
-     * @return integer db response
+     * @return boolean|null db response
      */
     public function processAnswers($questionList, $questionType, $questionInstance, $currentQuestion)
     {
@@ -665,7 +665,7 @@ 
     /**
      * Process Chamilo Unique Answer
      *
-     * @param object $objAnswer
+     * @param Answer $objAnswer
      * @param array $answerValues
      * @param integer $position
      * @param integer $questionWeighting
@@ -698,7 +698,7 @@ 
     /**
      * Process Chamilo True False
      *
-     * @param object $objAnswer
+     * @param Answer $objAnswer
      * @param array $answerValues
      * @param integer $position
      * @param integer $questionWeighting
@@ -731,7 +731,7 @@ 
     /**
      * Process Chamilo FillBlanks
      *
-     * @param object $objAnswer
+     * @param Answer $objAnswer
      * @param array $questionType
      * @param array $answerValues
      * @param string $placeholder
@@ -826,7 +826,7 @@ 
      * Litle utility to delete the unuseful tags
      *
      * @param $array
-     * @param $keys
+     * @param string[] $keys
      */
     public function traverseArray(&$array, $keys)
     {

main/inc/lib/TicketManager.php

Doc Comments +9 added lines, -9 removed lines

@@ -642,10 +642,10 @@ 
     /**
      * Insert message between Users and Admins
      * @param $ticket_id
-     * @param $subject
-     * @param $content
+     * @param string $subject
+     * @param string $content
      * @param $file_attachments
-     * @param $user_id
+     * @param integer $user_id
      * @param string $status
      * @param bool $sendConfirmation
      * @return bool
@@ -744,9 +744,9 @@ 
     /**
      * Attachment files when a message is sent
      * @param $file_attach
-     * @param $ticket_id
-     * @param $message_id
-     * @param $message_attch_id
+     * @param integer $ticket_id
+     * @param integer $message_id
+     * @param integer $message_attch_id
      * @return array
      */
     public static function save_message_attachment_file(
@@ -2006,7 +2006,7 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @return Project
      */
     public static function getProject($id)
@@ -2125,7 +2125,7 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @return Project
      */
     public static function getStatus($id)
@@ -2249,7 +2249,7 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @return Priority
      */
     public static function getPriority($id)

main/inc/lib/internationalization.lib.php

Doc Comments +19 added lines, -12 removed lines

@@ -419,6 +419,7 @@ 
  * If null, the timezone will be determined based on user preference,
  * or timezone chosen by the admin for the platform.
  * @param string The timezone to be converted from. If null, UTC will be assumed.
+ * @param string $to_timezone
  * @return string The converted time formatted as Y-m-d H:i:s
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -683,6 +684,8 @@ 
  * @param mixed The time to be converted
  * @param mixed Format to be used (TIME_NO_SEC_FORMAT, DATE_FORMAT_SHORT, DATE_FORMAT_LONG, DATE_TIME_FORMAT_LONG)
  * @param string Timezone to be converted from. If null, UTC will be assumed.
+ * @param integer $format
+ * @param string $from_timezone
  * @return string Converted and localized date
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -752,7 +755,7 @@ 
  * @param int|string $format (optional)	The person name format. It may be a pattern-string (for example '%t %l, %f' or '%T %F %L', ...) or some of the constants PERSON_NAME_COMMON_CONVENTION (default), PERSON_NAME_WESTERN_ORDER, PERSON_NAME_EASTERN_ORDER, PERSON_NAME_LIBRARY_ORDER.
  * @param string $language (optional)	The language id. If it is omitted, the current interface language is assumed. This parameter has meaning with the format PERSON_NAME_COMMON_CONVENTION only.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return bool							The result is sort of full name of the person.
+ * @return string							The result is sort of full name of the person.
  * Sample results:
  * Peter Ustinoff or Dr. Peter Ustinoff     - the Western order
  * Ustinoff Peter or Dr. Ustinoff Peter     - the Eastern order
@@ -1071,8 +1074,8 @@ 
 
 /**
  * This function returns a string or an array with all occurrences of search in subject (ignoring case) replaced with the given replace value.
- * @param mixed $search					String or array of strings to be found.
- * @param mixed $replace				String or array of strings used for replacement.
+ * @param string $search					String or array of strings to be found.
+ * @param string $replace				String or array of strings used for replacement.
  * @param mixed $subject				String or array of strings being searched.
  * @param int $count (optional)			The number of matched and replaced needles will be returned in count, which is passed by reference.
  * @param string $encoding (optional)	The used internally by this function character encoding.
@@ -1135,10 +1138,10 @@ 
 /**
  * Finds first occurrence of a string within another, case insensitive.
  * @param string $haystack					The string from which to get the first occurrence.
- * @param mixed $needle						The string to be found.
+ * @param string $needle						The string to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence of $needle.
@@ -1194,7 +1197,7 @@ 
  * @param mixed $needle						The string which first character is to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if the first character from $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if the first character from $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence.
@@ -1261,7 +1264,7 @@ 
  * @param mixed $needle						The string to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence of $needle.
@@ -1442,8 +1445,8 @@ 
 
 /**
  * Performs a regular expression search and replace, UTF-8 aware when it is applicable.
- * @param string|array $pattern			The pattern to search for. It can be either a string or an array with strings.
- * @param string|array $replacement		The string or an array with strings to replace.
+ * @param string $pattern			The pattern to search for. It can be either a string or an array with strings.
+ * @param string $replacement		The string or an array with strings to replace.
  * @param string|array $subject			The string or an array with strings to search and replace.
  * @param int $limit					The maximum possible replacements for each pattern in each subject string. Defaults to -1 (no limit).
  * @param int &$count					If specified, this variable will be filled with the number of replacements done.
@@ -1591,7 +1594,7 @@ 
 
 /**
  * This function checks whether two $encoding are equal (same, equvalent).
- * @param string|array $encoding1		The first encoding
+ * @param string $encoding1		The first encoding
  * @param string|array $encoding2		The second encoding
  * @param bool $strict					When this parameter is TRUE the comparison ignores aliases of encodings.
  * When the parameter is FALSE, aliases are taken into account.
@@ -1695,6 +1698,7 @@ 
 /**
  * Checks a string for UTF-8 validity.
  *
+ * @param string $string
  */
 function api_is_valid_utf8(&$string)
 {
@@ -1837,7 +1841,7 @@ 
 /**
  * Replaces non-valid formats for person names with the default (English) format.
  * @param string $format	The input format to be verified.
- * @return bool				Returns the same format if is is valid, otherwise returns a valid English format.
+ * @return string				Returns the same format if is is valid, otherwise returns a valid English format.
  */
 function _api_validate_person_name_format($format) {
     if (empty($format) || stripos($format, '%f') === false || stripos($format, '%l') === false) {
@@ -1964,6 +1968,9 @@ 
 
 // This function checks whether the function _api_convert_encoding() (the php-
 // implementation) is able to convert from/to a given encoding.
+/**
+ * @param string $encoding
+ */
 function _api_convert_encoding_supports($encoding) {
     static $supports = array();
     if (!isset($supports[$encoding])) {
@@ -1974,7 +1981,7 @@ 
 
 /**
  * Given a date object, return a human or ISO format, with or without h:m:s
- * @param object $date The Date object
+ * @param DateTime $date The Date object
  * @param bool $showTime Whether to show the time and date (true) or only the date (false)
  * @param bool $humanForm Whether to show day-month-year (true) or year-month-day (false)
  * @return string Formatted date

main/inc/lib/usermanager.lib.php

Doc Comments +23 added lines, -16 removed lines

@@ -126,9 +126,9 @@ 
     /**
      * Validates the password
      *
-     * @param $encoded
-     * @param $raw
-     * @param $salt
+     * @param string $encoded
+     * @param string $raw
+     * @param string $salt
      * @return bool
      */
     public static function isPasswordValid($encoded, $raw, $salt)
@@ -143,7 +143,7 @@ 
      * @param string $raw
      * @param User   $user
      *
-     * @return bool
+     * @return string
      */
     public static function encryptPassword($raw, User $user)
     {
@@ -1055,6 +1055,7 @@ 
     /**
      * Disables a user
      * @param int User id
+     * @param integer $user_id
      * @return bool
      * @uses UserManager::change_active_state() to actually disable the user
      * @assert (0) === false
@@ -1071,6 +1072,7 @@ 
     /**
      * Enable a user
      * @param int User id
+     * @param integer $user_id
      * @return bool
      * @uses UserManager::change_active_state() to actually disable the user
      * @assert (0) === false
@@ -1237,6 +1239,7 @@ 
      * Checks whether the user id exists in the database
      *
      * @param int User id
+     * @param integer $userId
      * @return bool True if user id was found, false otherwise
      */
     public static function is_user_id_valid($userId)
@@ -1378,7 +1381,7 @@ 
     /**
      * Get a list of users of which the given conditions match with a LIKE '%cond%'
      * @param array $conditions a list of condition (exemple : status=>STUDENT)
-     * @param array $order_by a list of fields on which sort
+     * @param string[] $order_by a list of fields on which sort
      * @return array An array with all users of the platform.
      * @todo optional course code parameter, optional sorting parameters...
      * @todo security filter order_by
@@ -1435,7 +1438,7 @@ 
      * @param   array $userInfo user information to avoid query the DB
      * returns the /main/img/unknown.jpg image set it at true
      *
-     * @return    array     Array of 2 elements: 'dir' and 'file' which contain
+     * @return    integer     Array of 2 elements: 'dir' and 'file' which contain
      * the dir and file as the name implies if image does not exist it will
      * return the unknow image if anonymous parameter is true if not it returns an empty array
      */
@@ -1845,7 +1848,7 @@ 
     /**
      * Returns an array with the user's productions.
      *
-     * @param    $user_id    User id
+     * @param    integer $user_id    User id
      * @return   array  An array containing the user's productions
      */
     public static function get_user_productions($user_id)
@@ -2000,7 +2003,7 @@ 
 
     /**
      * Build a list of extra file already uploaded in $user_folder/{$extra_field}/
-     * @param $user_id
+     * @param integer $user_id
      * @param $extra_field
      * @param bool $force
      * @param bool $showDelete
@@ -2105,7 +2108,7 @@ 
      * @param    int       $fieldType  Field's type
      * @param    string    $displayText Field's language var name
      * @param    string    $default Field's default value
-     * @return int
+     * @return boolean
      */
     public static function create_extra_field($variable, $fieldType, $displayText, $default)
     {
@@ -2139,6 +2142,7 @@ 
      * @param    boolean    Whether to prefix the fields indexes with "extra_" (might be used by formvalidator)
      * @param    boolean    Whether to return invisible fields as well
      * @param    boolean    Whether to split multiple-selection fields or not
+     * @param boolean $field_filter
      * @return    array    Array of fields => value for the given user
      */
     public static function get_extra_user_data(
@@ -2413,6 +2417,7 @@ 
     /**
      * Get extra user data by field variable
      * @param string    field variable
+     * @param string $field_variable
      * @return array    data
      */
     public static function get_extra_user_data_by_field_variable($field_variable)
@@ -2977,7 +2982,7 @@ 
      * @param    string  $user_id   User ID
      * @param   string  $course course directory
      * @param   string  $resourcetype resourcetype: images, all
-     * @return    int        User ID (or false if not found)
+     * @return    string        User ID (or false if not found)
      */
     public static function get_user_upload_files_by_course($user_id, $course, $resourcetype = 'all')
     {
@@ -3058,7 +3063,7 @@ 
     /**
      * Adds a new API key to the users' account
      * @param   int     Optional user ID (defaults to the results of api_get_user_id())
-     * @return  boolean True on success, false on failure
+     * @return  false|string True on success, false on failure
      */
     public static function add_api_key($user_id = null, $api_service = 'dokeos')
     {
@@ -3113,6 +3118,7 @@ 
      * Regenerate an API key from the user's account
      * @param   int     user ID (defaults to the results of api_get_user_id())
      * @param   string  API key's internal ID
+     * @param string $api_service
      * @return  int        num
      */
     public static function update_api_key($user_id, $api_service)
@@ -3142,6 +3148,7 @@ 
     /**
      * @param   int     user ID (defaults to the results of api_get_user_id())
      * @param   string    API key's internal ID
+     * @param string $api_service
      * @return  int    row ID, or return false if not found
      */
     public static function get_api_key_id($user_id, $api_service)
@@ -3357,7 +3364,7 @@ 
      * @param int $field_id
      * @param bool $show_links show links or not
      *
-     * @return array
+     * @return string
      */
     public static function get_user_tags_to_string($user_id, $field_id, $show_links = true)
     {
@@ -3454,7 +3461,7 @@ 
      * @param mixed $tag
      * @param int $user_id
      * @param int $field_id field id of the tag
-     * @return bool
+     * @return boolean|null
      */
     public static function add_tag($tag, $user_id, $field_id)
     {
@@ -4896,7 +4903,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_user_field_types()
     {
@@ -5188,7 +5195,7 @@ 
 
     /**
      * Get the boss user ID from a followed user id
-     * @param $userId
+     * @param integer $userId
      * @return bool
      */
     public static function getStudentBossList($userId)
@@ -5240,7 +5247,7 @@ 
      * Get either a Gravatar URL or complete image tag for a specified email address.
      *
      * @param string $email The email address
-     * @param string $s Size in pixels, defaults to 80px [ 1 - 2048 ]
+     * @param integer $s Size in pixels, defaults to 80px [ 1 - 2048 ]
      * @param string $d Default imageset to use [ 404 | mm | identicon | monsterid | wavatar ]
      * @param string $r Maximum rating (inclusive) [ g | pg | r | x ]
      * @param boole $img True to return a complete IMG tag False for just the URL

main/inc/lib/thematic.lib.php

Doc Comments +11 added lines, -4 removed lines

@@ -242,6 +242,9 @@ 
     /**
      * get thematic list
      * @param	int		Thematic id (optional), get list by id
+     * @param integer $thematic_id
+     * @param string $course_code
+     * @param integer $session_id
      * @return	array	Thematic data
      */
     public static function get_thematic_list(
@@ -799,6 +802,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)
@@ -1116,6 +1120,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)
@@ -1343,6 +1348,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)
@@ -1407,6 +1413,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(
@@ -1437,7 +1444,7 @@ 
 
     /**
      * get thematic id
-     * @return void
+     * @return integer
      */
     public function get_thematic_id()
     {
@@ -1446,7 +1453,7 @@ 
 
     /**
      * Get thematic plan titles by default
-     * @return array
+     * @return string[]
      */
     public function get_default_thematic_plan_title()
     {
@@ -1463,7 +1470,7 @@ 
 
     /**
      * Get thematic plan icons by default
-     * @return array
+     * @return string[]
      */
     public function get_default_thematic_plan_icon()
     {
@@ -1480,7 +1487,7 @@ 
 
     /**
      * Get questions by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_question()
     {

main/gradebook/lib/user_data_generator.class.php

Doc Comments +5 added lines, -4 removed lines

@@ -72,6 +72,7 @@ 
 
     /**
      * Get actual array data
+     * @param integer $count
      * @return array 2-dimensional array - each array contains the elements:
      * 0: eval/link object
      * 1: item name
@@ -285,7 +286,7 @@ 
 
     /**
      * @param $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return string
      */
     private function build_average_column($item, $ignore_score_color)
@@ -306,7 +307,7 @@ 
 
     /**
      * @param $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return string
      */
     private function build_result_column($item, $ignore_score_color)
@@ -323,7 +324,7 @@ 
 
     /**
      * @param $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return string
      */
     private function build_mask_column($item, $ignore_score_color)
@@ -339,7 +340,7 @@ 
 
     /**
      * @param $coursecode
-     * @return mixed
+     * @return string
      */
     private function get_course_name_from_code_cached($coursecode)
     {

main/inc/lib/course.lib.php

Doc Comments +6 added lines, -3 removed lines

@@ -758,7 +758,7 @@ 
      * @param  string $courseCode the course code
      * @param  int $visible (optional) The course visibility in the catalogue to the user (1=visible, 0=invisible)
      *
-     * @return boolean true if added succesfully, false otherwise.
+     * @return boolean|string true if added succesfully, false otherwise.
      */
     public static function addUserVisibilityToCourseInCatalogue($userId, $courseCode, $visible = 1)
     {
@@ -1725,6 +1725,7 @@ 
      * Get a list of coaches of a course and a session
      * @param   string  Course code
      * @param   int     Session ID
+     * @param integer $session_id
      * @return  array   List of users
      */
     public static function get_coach_list_from_course_code($course_code, $session_id)
@@ -2346,7 +2347,7 @@ 
 
     /**
      * Creates a file called mysql_dump.sql in the course folder
-     * @param $course_code The code of the course
+     * @param string $course_code The code of the course
      * @todo Implementation for single database
      */
     public static function create_database_dump($course_code)
@@ -3146,6 +3147,7 @@ 
      * @param int $limit
      * @param string $column
      * @param string $direction
+     * @param integer $status
      * @return array    courses
      */
     public static function get_courses_followed_by_drh(
@@ -3740,6 +3742,7 @@ 
      *  class userportal-course-item.
      * @param int      User category id
      * @param bool      Whether to show the document quick-loader or not
+     * @param integer $user_category_id
      * @return string
      */
     public static function returnCoursesWithoutCategories($user_category_id, $load_dirs = false)
@@ -4936,7 +4939,7 @@ 
     /**
      * Returns the SQL conditions to filter course only visible by the user in the catalogue
      *
-     * @param $courseTableAlias Alias of the course table
+     * @param string $courseTableAlias Alias of the course table
      * @return string SQL conditions
      */
     public static function getCourseVisibilitySQLCondition($courseTableAlias) {

main/inc/lib/webservices/WebService.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -20,8 +20,8 @@
 
     /**
      * Class constructor
-     * @param $username
-     * @param $apiKey
+     * @param string $username
+     * @param string $apiKey
      */
     protected function __construct($username, $apiKey)
     {