chamilo / chamilo-lms

main/inc/lib/document.lib.php

Doc Comments +22 added lines, -18 removed lines

@@ -277,7 +277,7 @@ 
     /**
      *  @param string
      *  @param string
-     * 	@return true if the user is allowed to see the document, false otherwise
+     * 	@return boolean if the user is allowed to see the document, false otherwise
      * 	@author Sergio A Kessler, first version
      * 	@author Roan Embrechts, bugfix
      *  @todo not only check if a file is visible, but also check if the user is allowed to see the file??
@@ -1558,7 +1558,7 @@ 
      * Return true if the documentpath have visibility=1 as
      * item_property (you should use the is_visible_by_id)
      *
-     * @param string $document_path the relative complete path of the document
+     * @param string $doc_path the relative complete path of the document
      * @param array  $course the _course array info of the document's course
      * @param int
      * @param string
@@ -1644,6 +1644,7 @@ 
      * @param   int
      * @param   int
      * @param bool
+     * @param integer $user_id
      * @return  bool
      */
     public static function is_visible_by_id(
@@ -1995,7 +1996,7 @@ 
      * Remove default certificate
      * @param string $course_id The course code
      * @param int $default_certificate_id The document id of the default certificate
-     * @return void
+     * @return false|null
      */
     public static function remove_attach_certificate($course_id, $default_certificate_id)
     {
@@ -2128,6 +2129,7 @@ 
      * @param	bool  	is file or string html
      * @param	string	type (one of the app tools) - optional (otherwise takes the current item's type)
      * @param	int		level of recursivity we're in
+     * @param string $source_html
      * @return	array	List of file paths. An additional field containing 'local' or 'remote' helps determine
      * if the file should be copied into the zip or just linked
      */
@@ -2970,6 +2972,7 @@ 
 
     /**
      * Obtains the text inside the file with the right parser
+     * @param string $doc_path
      */
     public static function get_text_content($doc_path, $doc_mime)
     {
@@ -3221,6 +3224,7 @@ 
      * Shows a play icon next to the document title in the document list
      * @param int
      * @param string
+     * @param integer|null $i
      * @return string	html content
      */
     public static function generate_media_preview($i, $type = 'simple')
@@ -4122,7 +4126,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_web_odf_extension_list()
     {
@@ -4131,10 +4135,10 @@ 
 
     /**
      * Set of extension allowed to use Jodconverter
-     * @param $mode 'from'
+     * @param string $mode 'from'
      *              'to'
      *              'all'
-     * @param $format   'text'
+     * @param string $format   'text'
      *                  'spreadsheet'
      *                  'presentation'
      *                  'drawing'
@@ -4338,7 +4342,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_system_folders()
     {
@@ -4356,7 +4360,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getProtectedFolderFromStudent()
     {
@@ -4512,7 +4516,7 @@ 
      * Requires the ffmpeg lib. In ubuntu: sudo apt-get install ffmpeg
      * @param string $wavFile
      * @param bool $removeWavFileIfSuccess
-     * @return bool
+     * @return string|false
      */
     public static function convertWavToMp3($wavFile, $removeWavFileIfSuccess = false)
     {
@@ -5088,6 +5092,8 @@ 
      * @param string	The current folder (path inside of the "document" directory, including the prefix "/")
      * @param string	Group directory, if empty, prevents documents to be uploaded (because group documents cannot be uploaded in root)
      * @param	boolean	Whether to change the renderer (this will add a template <span> to the QuickForm object displaying the form)
+     * @param string $document_id
+     * @param FormValidator $form
 
      * @return string html form
      */
@@ -5596,9 +5602,6 @@ 
     /**
      * Creates the row of edit icons for a file/folder
      *
-     * @param string $curdirpath current path (cfr open folder)
-     * @param string $type (file/folder)
-     * @param string $path dbase path of file/folder
      * @param int $visibility (1/0)
      * @param int $id dbase id of the document
      * @return string html img tags with hyperlinks
@@ -5947,7 +5950,7 @@ 
     /**
      * Gets the path translated with title of docs and folders
      * @param string $path the real path
-     * @return the path which should be displayed
+     * @return string path which should be displayed
      */
     public static function get_titles_of_path($path)
     {
@@ -6003,7 +6006,8 @@ 
 
     /**
      * Checks whether the user is in shared folder
-     * @return return bool Return true when user is into shared folder
+     * @param integer $current_session_id
+     * @return boolean bool Return true when user is into shared folder
      */
     public static function is_shared_folder($curdirpath, $current_session_id)
     {
@@ -6019,7 +6023,7 @@ 
 
     /**
      * Checks whether the user is into any user shared folder
-     * @return return bool Return true when user is in any user shared folder
+     * @return boolean bool Return true when user is in any user shared folder
      */
     public static function is_any_user_shared_folder($path, $current_session_id)
     {
@@ -6233,7 +6237,7 @@ 
      * @param int $id
      * @param array $courseInfo
      * @param int $sessionId
-     * @return bool
+     * @return boolean|null
      */
     public static function downloadDeletedDocument($id, $courseInfo, $sessionId)
     {
@@ -6252,7 +6256,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public static function downloadAllDeletedDocument($courseInfo, $sessionId)
     {
@@ -6291,7 +6295,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public static function deleteDocumentsFromSession($courseInfo, $sessionId)
     {

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 +24 added lines, -18 removed lines

@@ -132,9 +132,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)
@@ -149,7 +149,7 @@ 
      * @param string $raw
      * @param User   $user
      *
-     * @return bool
+     * @return string
      */
     public static function encryptPassword($raw, User $user)
     {
@@ -1096,6 +1096,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
@@ -1112,6 +1113,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
@@ -1278,6 +1280,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)
@@ -1419,7 +1422,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
@@ -1490,7 +1493,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
      */
@@ -1982,7 +1985,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)
@@ -2137,7 +2140,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
@@ -2242,7 +2245,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)
     {
@@ -2276,6 +2279,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(
@@ -3122,7 +3126,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')
     {
@@ -3206,7 +3210,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')
     {
@@ -3261,6 +3265,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)
@@ -3290,6 +3295,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)
@@ -3505,7 +3511,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)
     {
@@ -3602,7 +3608,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)
     {
@@ -5048,7 +5054,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_user_field_types()
     {
@@ -5340,7 +5346,7 @@ 
 
     /**
      * Get the boss user ID from a followed user id
-     * @param $userId
+     * @param integer $userId
      * @return bool
      */
     public static function getStudentBossList($userId)
@@ -5392,7 +5398,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
@@ -5767,9 +5773,9 @@ 
      * @param bool $get_count
      * @param bool $reverse_order
      * @param int $start
-     * @param null $maxPerPage
+     * @param integer $maxPerPage
      * @param null $categoryFilter
-     * @return array
+     * @return integer
      */
     public static function getCategories(
         $user_id,

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

main/gradebook/lib/be/category.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -749,7 +749,7 @@ 
 
     /**
      * @param int $course_id
-     * @return bool|string
+     * @return string|false
      */
     public function show_message_resource_delete($course_id)
     {
@@ -1554,7 +1554,7 @@ 
      * Retrieve all categories inside a course independent category
      * that should be visible to a student.
      * @param integer $cat_id parent category
-     * @param $stud_id student id
+     * @param integer $stud_id student id
      * @param $cats optional: if defined, the categories will be added to this array
      */
     public function get_independent_categories_with_result_for_student($cat_id, $stud_id, $cats = array())

main/gradebook/lib/be/evaluation.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -95,6 +95,9 @@ 
 		return $this->user_id;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function get_course_code()
 	{
 		return $this->course_code;
@@ -278,7 +281,7 @@ 
 	}
 
 	/**
-	 * @param array $result
+	 * @param Doctrine\DBAL\Driver\Statement|null $result
 	 * @return array
 	 */
 	private static function create_evaluation_objects_from_sql_result($result)