chamilo / chamilo-lms

src/Chamilo/CourseBundle/Component/CourseCopy/CourseRecycler.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
     }
 
     /**
-     * @return bool
+     * @return false|null
      */
     public function create_user_folder()
     {

src/Chamilo/CourseBundle/Component/CourseCopy/CourseRestorer.php

Doc Comments +1 added lines

@@ -1212,6 +1212,7 @@
 	 * Restore a forum-post
 	 * @TODO Restore tree-structure of posts. For example: attachments to posts.
 	 * @param false|string $topic_id
+	 * @param false|string $forum_id
 	 */
     public function restore_post($id, $topic_id, $forum_id, $sessionId = 0)
     {

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

src/Chamilo/CourseBundle/Component/CourseCopy/CourseBuilder.php

Doc Comments +1 added lines, -1 removed lines

@@ -91,7 +91,7 @@
     }
 
     /**
-     * @param array $array
+     * @param string[] $array
      */
     public function set_tools_to_build($array)
     {

main/forum/forumfunction.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -3054,7 +3054,7 @@
  * @param integer $thread_qualify
  * @param integer $qualify_time
  * @param integer $session_id
- * @return array optional
+ * @return string|null optional
  * @author Isaac Flores <isaac.flores@dokeos.com>, U.N.A.S University
  * @version October 2008, dokeos  1.8.6
  */