chamilo / chamilo-lms

src/Chamilo/UserBundle/Entity/Manager/UserManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
      *
      * @param string $token
      *
-     * @return UserInterface
+     * @return \FOS\UserBundle\Model\UserInterface|null
      */
     public function findUserByConfirmationToken($token)
     {

main/inc/lib/MoodleImport.php

Doc Comments +8 added lines, -8 removed lines

@@ -403,7 +403,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)
     {
@@ -621,7 +621,7 @@ 
      * Fix moodle files that contains spaces
      * @param array $importedFiles
      * @param string $text
-     * @return mixed
+     * @return string
      */
     public function fixPathInText($importedFiles, &$text)
     {
@@ -642,10 +642,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, $questionType, $questionInstance, $currentQuestion, $importedFiles)
     {
@@ -800,7 +800,7 @@ 
     /**
      * Process Chamilo Unique Answer
      *
-     * @param object $objAnswer
+     * @param Answer $objAnswer
      * @param array $answerValues
      * @param integer $position
      * @param integer $questionWeighting
@@ -836,7 +836,7 @@ 
     /**
      * Process Chamilo True False
      *
-     * @param object $objAnswer
+     * @param Answer $objAnswer
      * @param array $answerValues
      * @param integer $position
      * @param integer $questionWeighting
@@ -873,7 +873,7 @@ 
     /**
      * Process Chamilo FillBlanks
      *
-     * @param object $objAnswer
+     * @param Answer $objAnswer
      * @param array $questionType
      * @param array $answerValues
      * @param string $placeholder
@@ -1026,7 +1026,7 @@ 
      * Litle utility to delete the unuseful tags
      *
      * @param $array
-     * @param $keys
+     * @param string[] $keys
      */
     public function traverseArray(&$array, $keys)
     {

main/inc/lib/usermanager.lib.php

Doc Comments +22 added lines, -16 removed lines

@@ -130,9 +130,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)
@@ -147,7 +147,7 @@ 
      * @param string $raw
      * @param User   $user
      *
-     * @return bool
+     * @return string
      */
     public static function encryptPassword($raw, User $user)
     {
@@ -1094,6 +1094,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
@@ -1110,6 +1111,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
@@ -1276,6 +1278,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)
@@ -1417,7 +1420,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
@@ -1488,7 +1491,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
      */
@@ -1980,7 +1983,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)
@@ -2135,7 +2138,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
@@ -2240,7 +2243,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)
     {
@@ -2274,6 +2277,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(
@@ -3121,7 +3125,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')
     {
@@ -3205,7 +3209,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')
     {
@@ -3260,6 +3264,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)
@@ -3289,6 +3294,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)
@@ -3504,7 +3510,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)
     {
@@ -3601,7 +3607,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)
     {
@@ -5047,7 +5053,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_user_field_types()
     {
@@ -5339,7 +5345,7 @@ 
 
     /**
      * Get the boss user ID from a followed user id
-     * @param $userId
+     * @param integer $userId
      * @return bool
      */
     public static function getStudentBossList($userId)
@@ -5391,7 +5397,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

plugin/vchamilo/lib/Virtual.php

Doc Comments +9 added lines, -7 removed lines

@@ -184,7 +184,7 @@ 
     * provides a side connection to a vchamilo database
     * @param array $_configuration
      *
-    * @return \Doctrine\DBAL\Driver\Connection
+    * @return string
     */
     public static function bootConnection(&$_configuration)
     {
@@ -372,7 +372,7 @@ 
 
     /**
     * get a proper SQLdump command
-    * @param object $vchamilodata the complete new host information
+    * @param stdClass $vchamilodata the complete new host information
     * @return string the shell command
     */
     public static function getDatabaseDumpCmd($vchamilodata)
@@ -456,8 +456,8 @@ 
 
     /**
      * Backups a database for having a snapshot.
-     * @param        $vchamilo    object        The Vchamilo object.
-     * @param        $outputfilerad    string        The output SQL file radical.
+     * @param        stdClass $vchamilo    object        The Vchamilo object.
+     * @param        string $outputfilerad    string        The output SQL file radical.
      * @return        bool    If TRUE, dumping database was a success, otherwise FALSE.
      */
     public static function backupDatabase($vchamilo, $outputfilerad)
@@ -619,6 +619,8 @@ 
     * this function set will map standard moodle API calls to chamilo
     * internal primitives. This avoids too many changes to do in imported
     * code
+    * @param string $module
+    * @param string $key
     */
     public static function getConfig($module, $key, $isplugin = true)
     {
@@ -698,7 +700,7 @@ 
     /**
      * @param string $path
      *
-     * @return mixed
+     * @return string
      */
     public static function chopLastSlash($path)
     {
@@ -852,7 +854,7 @@ 
 
     /**
      * @param object $instance
-     * @return bool|\Doctrine\DBAL\Connection
+     * @return Doctrine\ORM\EntityManagerInterface
      */
     public static function getConnectionFromInstance($instance, $getManager = false)
     {
@@ -1297,7 +1299,7 @@ 
     /**
      * @param stdClass $instance
      *
-     * @return bool|string returns the original version of the app
+     * @return string|false returns the original version of the app
      */
     public static function canBeUpgraded($instance)
     {

plugin/google_maps/src/GoogleMapsPlugin.php

Doc Comments +2 added lines, -2 removed lines

@@ -43,7 +43,7 @@ 
 
     /**
      * Install the plugin
-     * @return void
+     * @return boolean
      */
     public function install()
     {
@@ -52,7 +52,7 @@ 
 
     /**
      * Uninstall the plugin
-     * @return void
+     * @return boolean
      */
     public function uninstall()
     {

main/inc/lib/sessionmanager.lib.php

Doc Comments +19 added lines, -17 removed lines

@@ -1532,7 +1532,7 @@ 
      * @param	array	$id_checked an array to delete sessions
      * @param   boolean  $from_ws optional, true if the function is called
      * by a webservice, false otherwise.
-     * @return	void	Nothing, or false on error
+     * @return	boolean	Nothing, or false on error
      * */
     public static function delete($id_checked, $from_ws = false)
     {
@@ -1669,7 +1669,7 @@ 
      * @param array $user_list
      * @param int $session_visibility
      * @param bool $empty_users
-     * @return bool
+     * @return false|null
      */
     public static function subscribe_users_to_session(
         $id_session,
@@ -1942,7 +1942,7 @@ 
      * @param array $courseInfo
      * @param int $status
      * @param bool $updateTotal
-     * @return bool
+     * @return false|null
      */
     public static function removeUsersFromCourseSession(
         $userList,
@@ -2008,7 +2008,7 @@ 
      * @param string $course_code
      * @param int $session_visibility
      * @param bool $removeUsersNotInList
-     * @return bool
+     * @return false|null
      */
     public static function subscribe_users_to_session_course(
         $user_list,
@@ -2192,7 +2192,7 @@ 
      * @param	bool	$removeExistingCoursesWithUsers Whether to unsubscribe
      * existing courses and users (true, default) or not (false)
      * @param $copyEvaluation from base course to session course
-     * @return	void	Nothing, or false on error
+     * @return	false|null	Nothing, or false on error
      * */
     public static function add_courses_to_session(
         $sessionId,
@@ -2441,7 +2441,7 @@ 
      * @param	string	$variable Field's internal variable name
      * @param	int		$fieldType Field's type
      * @param	string	$displayText Field's language var name
-     * @return int     new extra field id
+     * @return boolean     new extra field id
      */
     public static function create_session_extra_field($variable, $fieldType, $displayText)
     {
@@ -2670,7 +2670,7 @@ 
      * @param	array	id_checked
      * @param	bool	include delete session
      * @param	bool	optional, true if the function is called by a webservice, false otherwise.
-     * @return	void	Nothing, or false on error
+     * @return	boolean	Nothing, or false on error
      * The parameters is a array to delete sessions
      * */
     public static function delete_session_category($id_checked, $delete_session = false, $from_ws = false)
@@ -3436,8 +3436,8 @@ 
     /**
      * Gets the list of courses by session filtered by access_url
      *
-     * @param $userId
-     * @param $sessionId
+     * @param integer $userId
+     * @param null|integer $sessionId
      * @param null $from
      * @param null $limit
      * @param null $column
@@ -3562,6 +3562,7 @@ 
     /**
      * Gets the count of courses by session filtered by access_url
      * @param int session id
+     * @param integer $session_id
      * @return array list of courses
      */
     public static function getCourseCountBySessionId($session_id, $keyword = null)
@@ -3820,6 +3821,7 @@ 
      * Updates a session status
      * @param	int 	session id
      * @param	int 	status
+     * @param integer $status
      */
     public static function set_session_status($session_id, $status)
     {
@@ -4028,7 +4030,7 @@ 
      * Protect a session to be edited.
      * @param int $id
      * @param bool $checkSession
-     * @return mixed | bool true if pass the check, api_not_allowed otherwise
+     * @return boolean|null | bool true if pass the check, api_not_allowed otherwise
      */
     public static function protectSession($id, $checkSession = true)
     {
@@ -4136,7 +4138,7 @@ 
 
     /**
      * @param $id
-     * @return bool
+     * @return null|boolean
      */
     public static function protect_teacher_session_edit($id)
     {
@@ -4201,7 +4203,7 @@ 
      *  true: if the session exists it will be updated.
      *  false: if session exists a new session will be created adding a counter session1, session2, etc
      * @param int $defaultUserId
-     * @param mixed $logger
+     * @param Logger $logger
      * @param array $extraFields convert a file row to an extra field. Example in CSV file there's a SessionID then it will
      * converted to extra_external_session_id if you set this: array('SessionId' => 'extra_external_session_id')
      * @param string $extraFieldId
@@ -5504,7 +5506,6 @@ 
      * @param string $lastConnectionDate
      * @param array $sessionIdList
      * @param array $studentIdList
-     * @param int $userStatus STUDENT|COURSEMANAGER constants
      *
      * @return array|int
      */
@@ -5656,7 +5657,7 @@ 
     /**
      * Get the list of course tools that have to be dealt with in case of
      * registering any course to a session
-     * @return array The list of tools to be dealt with (literal names)
+     * @return string[] The list of tools to be dealt with (literal names)
      */
     public static function getCourseToolToBeManaged()
     {
@@ -5670,7 +5671,7 @@ 
      * Calls the methods bound to each tool when a course is registered into a session
      * @param int $sessionId
      * @param int $courseId
-     * @return void
+     * @return boolean|null
      */
     public static function installCourse($sessionId, $courseId)
     {
@@ -6320,6 +6321,7 @@ 
      * @param int $categoryId The internal ID of the session category
      * @param string $target Value to search for in the session field values
      * @param array $extraFields A list of fields to be scanned and returned
+     * @param DateTime $publicationDate
      * @return mixed
      */
     public static function getShortSessionListAndExtraByCategory(
@@ -7656,7 +7658,7 @@ 
     /**
      * Get link to the admin page for this session
      * @param   int $id Session ID
-     * @return mixed    URL to the admin page to manage the session, or false on error
+     * @return false|string    URL to the admin page to manage the session, or false on error
      */
     public static function getAdminPath($id)
     {
@@ -7673,7 +7675,7 @@ 
      * If a course is provided, build the link to the course
      * @param   int $id Session ID
      * @param   int $courseId Course ID (optional) in case the link has to send straight to the course
-     * @return mixed    URL to the page to use the session, or false on error
+     * @return false|string    URL to the page to use the session, or false on error
      */
     public static function getPath($id, $courseId = 0)
     {

src/Chamilo/CoreBundle/Entity/Repository/SequenceRepository.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
      *
      * @param int $resourceId
      * @param int $type
-     * @return boolean
+     * @return boolean|null
      */
     public function deleteResource($resourceId, $type)
     {

src/Chamilo/CoreBundle/Component/Editor/CkEditor/Toolbar/Basic.php

Doc Comments +3 added lines, -1 removed lines

@@ -71,6 +71,8 @@ 
 
     /**
      * @inheritdoc
+     * @param string $toolbar
+     * @param string $prefix
      */
     public function __construct(
         $toolbar = null,
@@ -253,7 +255,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getNewPageBlock()
     {

main/inc/lib/attendance.lib.php

Doc Comments +24 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,11 @@ 
      * @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_date
+     * @param string $lastedit_type
+     * @param integer $lastedit_user_id
+     * @return  false|string     Affected rows
      */
     public function save_attendance_sheet_log(
         $attendance_id,
@@ -963,6 +970,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 +1206,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 +1235,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 +1264,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 +1312,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 +1435,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 +1661,6 @@ 
     /**
      * @param int $calendarId
      * @param int $courseId
-     * @param int $groupId
      * @return array
      */
     public function getGroupListByAttendanceCalendar($calendarId, $courseId)
@@ -1688,7 +1700,6 @@ 
     /**
      * @param int $calendarId
      * @param int $courseId
-     * @param int $groupId
      *
      * @return array
      */
@@ -1789,6 +1800,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 +1841,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)
@@ -1890,6 +1905,9 @@ 
         $this->course_id = $course_id;
     }
 
+    /**
+     * @param string $datetime
+     */
     public function set_date_time($datetime)
     {
         $this->date_time = $datetime;