chamilo / chamilo-lms

src/Chamilo/CourseBundle/Component/CourseCopy/Resources/DummyCourseCreator.php

Doc Comments +1 added lines

@@ -25,6 +25,7 @@
 
     /**
      * Useful finder - experimental akelos like only use in notification.lib.php send function
+     * @param string $type
      */
     public function find($type, $options = null)
     {

plugin/buycourses/src/buy_course_plugin.class.php

Doc Comments +10 added lines, -10 removed lines

@@ -36,7 +36,7 @@ 
 

     /**

      *

-     * @return StaticPlugin

+     * @return BuyCoursesPlugin

      */

     static function create()

     {

@@ -252,7 +252,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)

     {

@@ -664,7 +664,7 @@ 
     /**

      * Get session info

      * @param array $sessionId The session ID

-     * @return array

+     * @return Session

      */

     public function getSessionInfo($sessionId)

     {

@@ -757,7 +757,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)

     {

@@ -939,7 +939,7 @@ 
 

     /**

      * Get payment types

-     * @return array

+     * @return string[]

      */

     public function getPaymentTypes()

     {

@@ -977,7 +977,7 @@ 
 

     /**

      * Get the statuses for sales

-     * @return array

+     * @return string[]

      */

     public function getSaleStatuses()

     {

@@ -990,7 +990,7 @@ 
 

     /**

      * Get the statuses for Payouts

-     * @return array

+     * @return string[]

      */

     public function getPayoutStatuses()

     {

@@ -1003,7 +1003,7 @@ 
 

     /**

      * Get the list of product types

-     * @return array

+     * @return string[]

      */

     public function getProductTypes()

     {

@@ -1384,7 +1384,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)

     {

@@ -1542,7 +1542,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)

     {

main/inc/lib/usermanager.lib.php

Doc Comments +34 added lines, -16 removed lines

@@ -138,7 +138,7 @@ 
     /**
      * Validates the password
      *
-     * @param $encoded
+     * @param string $encoded
      * @param $raw
      * @param $salt
      * @return bool
@@ -160,7 +160,7 @@ 
      * @param string $raw
      * @param User   $user
      *
-     * @return bool
+     * @return string
      */
     public static function encryptPassword($raw, User $user)
     {
@@ -979,6 +979,7 @@ 
      * Disables or enables a user
      * @param int user_id
      * @param int Enable or disable
+     * @param integer $active
      * @return void
      * @assert (-1,0) === false
      * @assert (1,1) === true
@@ -1009,6 +1010,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
@@ -1025,6 +1027,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
@@ -1189,6 +1192,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)
@@ -1386,7 +1390,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
      */
@@ -1754,7 +1758,7 @@ 
      * @param    int $user_id    User id
      * @param    $force    Optional parameter to force building after a removal request
      *
-     * @return    A string containing the XHTML code to dipslay the production list, or FALSE
+     * @return    boolean|string string containing the XHTML code to dipslay the production list, or FALSE
      */
     public static function build_production_list($user_id, $force = false, $showdelete = false)
     {
@@ -1790,7 +1794,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)
@@ -1945,7 +1949,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
@@ -2050,7 +2054,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)
     {
@@ -2084,6 +2088,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(
@@ -2270,7 +2275,6 @@ 
     /**
      * Get all the extra field information of a certain field (also the options)
      *
-     * @param int $field_name the name of the field we want to know everything of
      * @return array $return containing all th information about the extra profile field
      * @author Julio Montoya
      * @deprecated
@@ -2315,6 +2319,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)
@@ -2864,7 +2869,7 @@ 
      * @param    string    User ID
      * @param   string  course directory
      * @param   string  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')
     {
@@ -2944,7 +2949,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')
     {
@@ -2999,6 +3004,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)
@@ -3028,6 +3034,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)
@@ -3239,7 +3246,8 @@ 
      * @param int user_id
      * @param int field_id
      * @param bool show links or not
-     * @return array
+     * @param integer $user_id
+     * @return string
      */
     public static function get_user_tags_to_string($user_id, $field_id, $show_links = true)
     {
@@ -3284,6 +3292,8 @@ 
      * Get the tag id
      * @param int tag
      * @param int field_id
+     * @param string $tag
+     * @param integer $field_id
      * @return int returns 0 if fails otherwise the tag id
      */
     public static function get_tag_id($tag, $field_id)
@@ -3330,7 +3340,9 @@ 
      * @param mixed tag
      * @param int The user id
      * @param int field id of the tag
-     * @return bool
+     * @param integer $user_id
+     * @param integer $field_id
+     * @return boolean|null
      */
     public static function add_tag($tag, $user_id, $field_id)
     {
@@ -4148,7 +4160,7 @@ 
      * Add subscribed users to a user by relation type
      * @param int $userId The user id
      * @param array $subscribedUsersId The id of suscribed users
-     * @param action $relationType The relation type
+     * @param integer $relationType The relation type
      */
     public static function subscribeUsersToUser($userId, $subscribedUsersId, $relationType, $deleteUsersBeforeInsert = false)
     {
@@ -4213,6 +4225,8 @@ 
      * This function check if an user is followed by human resources manager
      * @param     int     User id
      * @param    int        Human resources manager
+     * @param integer $user_id
+     * @param integer $hr_dept_id
      * @return    bool
      */
     public static function is_user_followed_by_drh($user_id, $hr_dept_id)
@@ -4285,6 +4299,8 @@ 
      * Determines if a user is a gradebook certified
      * @param int The category id of gradebook
      * @param int The user id
+     * @param integer $cat_id
+     * @param integer $user_id
      * @return boolean
      */
     public static function is_user_certified($cat_id, $user_id)
@@ -4307,6 +4323,8 @@ 
      * Gets the info about a gradebook certificate for a user by course
      * @param string The course code
      * @param int The user id
+     * @param integer $course_code
+     * @param integer $user_id
      * @return array  if there is not information return false
      */
     public static function get_info_gradebook_certificate($course_code, $user_id)
@@ -4770,7 +4788,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     static function get_user_field_types()
     {
@@ -5063,7 +5081,7 @@ 
 
     /**
      * Get the boss user ID from a followed user id
-     * @param $userId
+     * @param integer $userId
      * @return bool
      */
     public static function getStudentBossList($userId)
@@ -5115,7 +5133,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/newscorm/learnpath.class.php

Doc Comments +28 added lines, -25 removed lines

@@ -84,7 +84,7 @@ 
      * @param	string	$course Course code
      * @param	integer	$lp_id
      * @param	integer	$user_id
-     * @return mixed True on success, false on error
+     * @return boolean True on success, false on error
      */
     public function __construct($course, $lp_id, $user_id)
     {
@@ -486,7 +486,7 @@ 
      * @param int $max_time_allowed
      * @param int $userId
      *
-     * @return int
+     * @return false|string
      */
     public function add_item(
         $parent,
@@ -1037,7 +1037,7 @@ 
      * @param	array $courseInfo
      * @param	integer	Learnpath ID
      * @param	string	Whether to delete data or keep it (default: 'keep', others: 'remove')
-     * @return	boolean	True on success, false on failure (might change that to return number of elements deleted)
+     * @return	false|null	True on success, false on failure (might change that to return number of elements deleted)
      */
     public function delete($courseInfo = null, $id = null, $delete = 'keep')
     {
@@ -1171,7 +1171,7 @@ 
      * @param	integer	$id Elem ID (0 if first)
      * @param	integer	$remove Whether to remove the resource/data from the
      * system or leave it (default: 'keep', others 'remove')
-     * @return	integer	Number of elements moved
+     * @return	false|null	Number of elements moved
      * @todo implement resource removal
      */
     public function delete_item($id, $remove = 'keep')
@@ -1253,7 +1253,7 @@ 
      * @param   array   $audio The array resulting of the $_FILES[mp3] element
      * @param   int     $max_time_allowed
      * @param   string  $url
-     * @return  boolean True on success, false on error
+     * @return  false|null True on success, false on error
      */
     public function edit_item(
         $id,
@@ -1773,7 +1773,7 @@ 
 
     /**
      * Gets the first element URL.
-     * @return	string	URL to load into the viewer
+     * @return	false|null	URL to load into the viewer
      */
     public function first()
     {
@@ -2289,6 +2289,7 @@ 
      * @param int $student_id
      * @param string Course code (optional)
      * @param int $sessionId
+     * @param string $courseCode
      * @return	bool
      */
     public static function is_lp_visible_for_student(
@@ -2586,7 +2587,7 @@ 
 
     /**
      * Gets the learnpath session id
-     * @return	string	Learnpath theme
+     * @return	integer	Learnpath theme
      */
     public function get_lp_session_id()
     {
@@ -2619,7 +2620,7 @@ 
     /**
      * @param string $size
      * @param string $path_type
-     * @return bool|string
+     * @return string|false
      */
     public function get_preview_image_path($size = null, $path_type = 'web')
     {
@@ -2765,6 +2766,8 @@ 
      * Returns the XML DOM document's node
      * @param	resource	Reference to a list of objects to search for the given ITEM_*
      * @param	string		The identifier to look for
+     * @param DOMNodeList $children
+     * @param string $id
      * @return	mixed		The reference to the element found with that identifier. False if not found
      */
     public function get_scorm_xml_node(& $children, $id)
@@ -3012,7 +3015,7 @@ 
     /**
      * Generate and return the table of contents for this learnpath. The (flat) table returned can be
      * used by get_html_toc() to be ready to display
-     * @return	array	TOC as a table with 4 elements per row: title, link, status and level
+     * @return	boolean	TOC as a table with 4 elements per row: title, link, status and level
      */
     public function get_toc()
     {
@@ -3148,7 +3151,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getChapterTypes()
     {
@@ -4057,7 +4060,7 @@ 
      * Open a resource = initialise all local variables relative to this resource. Depending on the child
      * class, this might be redefined to allow several behaviours depending on the document type.
      * @param integer Resource ID
-     * @return boolean True on success, false otherwise
+     * @return boolean|null True on success, false otherwise
      */
     public function open($id)
     {
@@ -4186,7 +4189,7 @@ 
      * Can be used as abstract
      * @param	integer	$lp_id Learnpath id
      * @param	string	$set_visibility New visibility (v/i - visible/invisible)
-     * @return bool
+     * @return false|null
      */
     public static function toggle_publish($lp_id, $set_visibility = 'v')
     {
@@ -4271,7 +4274,7 @@ 
      * Make sure the results are saved with anoter method. This method should probably be
      * redefined in children classes.
      * To use a similar method  statically, use the create_new_attempt() method
-     * @return string URL to load in the viewer
+     * @return boolean URL to load in the viewer
      */
     public function restart()
     {
@@ -4349,6 +4352,7 @@ 
      * Saves the given item
      * @param	integer	$item_id. Optional (will take from $_REQUEST if null)
      * @param	boolean	$from_outside Save from url params (true) or from current attributes (false). Optional. Defaults to true
+     * @param integer $item_id
      * @return	boolean
      */
     public function save_item($item_id = null, $from_outside = true)
@@ -4846,7 +4850,7 @@ 
 
     /**
      * Sets use_max_score
-     * @param   string  $use_max_score Optional string giving the new location of this learnpath
+     * @param   integer  $use_max_score Optional string giving the new location of this learnpath
      * @return  boolean True on success / False on error
      */
     public function set_use_max_score($use_max_score = 1)
@@ -5249,6 +5253,7 @@ 
      * Register the attempt mode into db thanks to flags prevent_reinit and seriousgame_mode flags
      *
      * @param string 'seriousgame', 'single' or 'multiple'
+     * @param string $mode
      * @return boolean
      * @author ndiechburg <noel@cblue.be>
      **/
@@ -5291,7 +5296,7 @@ 
     /**
      * Switch between multiple attempt, single attempt or serious_game mode (only for scorm)
      *
-     * @return boolean
+     * @return boolean|null
      * @author ndiechburg <noel@cblue.be>
      **/
     public function switch_attempt_mode()
@@ -5482,7 +5487,6 @@ 
     /**
      * Function that creates a html list of learning path items so that we can add audio files to them
      * @author Kevin Van Den Haute
-     * @param int $lp_id
      * @return string
      */
     public function overview()
@@ -5902,7 +5906,7 @@ 
     /**
      * This function builds the action menu
      * @param bool $returnContent
-     * @return void
+     * @return string|null
      */
     public function build_action_menu($returnContent = false)
     {
@@ -6447,7 +6451,7 @@ 
     /**
      * Function that displays a list with al the resources that
      * could be added to the learning path
-     * @return string
+     * @return boolean
      */
     public function display_resources()
     {
@@ -10028,7 +10032,7 @@ 
 
     /**
      * @param int $lp_id
-     * @return bool
+     * @return false|null
      */
     public function scorm_export_to_pdf($lp_id)
     {
@@ -10569,7 +10573,7 @@ 
 
     /**
      * @param int $itemId
-     * @return learnpathItem|false
+     * @return string
      */
     public function getItem($itemId)
     {
@@ -10619,7 +10623,6 @@ 
     /**
      * Set whether this is a learning path with the possibility to subscribe
      * users or not
-     * @param int $subscribeUsers (0 = false, 1 = true)
      */
     public function setSubscribeUsers($value)
     {
@@ -10744,7 +10747,7 @@ 
 
     /**
      * Get the item of exercise type (evaluation type)
-     * @return array The final evaluation. Otherwise return false
+     * @return integer The final evaluation. Otherwise return false
      */
     public function getFinalEvaluationItem()
     {
@@ -10968,7 +10971,7 @@ 
     /**
      * Create a forum for this learning path
      * @param type $forumCategoryId
-     * @return int The forum ID if was created. Otherwise return false
+     * @return false|string The forum ID if was created. Otherwise return false
      */
     public function createForum($forumCategoryId)
     {
@@ -11017,7 +11020,7 @@ 
     /**
      * Get the LP Final Item Template
      *
-     * @return html
+     * @return string
      */
     private function getFinalItemTemplate()
     {
@@ -11040,7 +11043,7 @@ 
     /**
      * Get the LP Final Item form
      *
-     * @return html
+     * @return string
      */
     public function getFinalItemForm()
     {

main/exercice/question.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -264,7 +264,7 @@
     }
 
     /**
-     * @return string|false
+     * @return string
      */
     public function selectPicturePath()
     {

src/Chamilo/CoreBundle/Entity/Language.php

Doc Comments +1 added lines, -1 removed lines

@@ -230,7 +230,7 @@
     /**
      * Get id
      *
-     * @return boolean
+     * @return integer
      */
     public function getId()
     {