chamilo / chamilo-lms

main/webservices/webservice_user.php

Doc Comments +6 added lines

@@ -36,6 +36,7 @@ 
 	 *
 	 * @param array Users
 	 * @param int Set to 1 to enable and to 0 to disable
+	 * @param integer $state
 	 * @return array Array of results
 	 */
 	protected function changeUsersActiveState($users, $state) {
@@ -217,6 +218,11 @@ 
 	 * @param string Phone.
 	 * @param string Expiration date
 	 * @param array Extra fields. An array with elements of the form ('field_name' => 'name_of_the_field', 'field_value' => 'value_of_the_field').
+	 * @param integer|null $visibility
+	 * @param string|null $email
+	 * @param string|null $language
+	 * @param string|null $phone
+	 * @param string|null $expiration_date
 	 * @return mixed New user id generated by the system, WSError otherwise
 	 */
 	protected function createUserHelper($firstname, $lastname, $status, $login, $password, $encrypt_method, $user_id_field_name, $user_id_value, $visibility, $email, $language, $phone, $expiration_date, $extras = array()) {

main/work/downloadfolder.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -212,7 +212,7 @@
  * @param array $arr1 first array
  * @param array $arr2 second array
  *
- * @return array difference between the two arrays
+ * @return string difference between the two arrays
  */
 function diff($arr1, $arr2)
 {

main/work/work.lib.php

Doc Comments +18 added lines, -17 removed lines

@@ -158,7 +158,7 @@ 
  * Create a group of select from a date
  * @param FormValidator $form
  * @param string $prefix
- * @return array
+ * @return HTML_QuickForm_element[]
  */
 function create_group_date_select($form, $prefix = '')
 {
@@ -752,7 +752,7 @@ 
  * @author Bert Vanderkimpen
  * @author Yannick Warnier <ywarnier@beeznest.org> Adaptation for work tool
  * @param   string $base_work_dir Base work dir (.../work)
- * @param   string $desiredDirName complete path of the desired name
+ * @param   string $desired_dir_name complete path of the desired name
  *
  * @return  string actual directory name if it succeeds, boolean false otherwise
  */
@@ -774,7 +774,7 @@ 
 /**
  * Delete a work-tool directory
  * @param   int  $id work directory id to delete
- * @return  integer -1 on error
+ * @return  boolean|null -1 on error
  */
 function deleteDirWork($id)
 {
@@ -917,7 +917,7 @@ 
  * Update the url of a dir in the student_publication table
  * @param  array $work_data work original data
  * @param  string $newPath Example: "folder1"
- * @return bool
+ * @return boolean|null
  */
 function updateDirName($work_data, $newPath)
 {
@@ -974,6 +974,7 @@ 
 /**
  * Transform an all directory structure (only directories) in an array
  * @param   string path of the directory
+ * @param string $directory
  * @return  array the directory structure into an array
  * @author  Julio Montoya Dokeos
  * @version April 2008
@@ -1043,7 +1044,7 @@ 
  * @param   string the path of the directory
  * @param   boolean true if we want the total quantity of files
  * include in others child directories, false only  files in the directory
- * @return  array the first element is an integer with the number of files
+ * @return  integer[] the first element is an integer with the number of files
  * in the folder, the second element is the number of directories
  * @author  Julio Montoya
  * @version April 2008
@@ -2319,7 +2320,7 @@ 
 }
 
 /**
- * @param $name
+ * @param string $name
  * @param $values
  * @param string $checked
  * @return string
@@ -2845,7 +2846,7 @@ 
  * @param int $userId
  * @param int $workId
  * @param int $courseId
- * @return bool
+ * @return boolean|null
  */
 function allowOnlySubscribedUser($userId, $workId, $courseId)
 {
@@ -2963,7 +2964,7 @@ 
 /**
  * Get total score from a work list
  * @param $workList
- * @return int|null
+ * @return integer
  */
 function getTotalWorkScore($workList)
 {
@@ -2979,7 +2980,7 @@ 
  * Get comment count from a work list (docs sent by students)
  * @param array $workList
  * @param array $courseInfo
- * @return int|null
+ * @return integer
  */
 function getTotalWorkComment($workList, $courseInfo = array())
 {
@@ -3122,6 +3123,7 @@ 
  * @param int $parentId
  * @param array $courseInfo
  * @param int $sessionId
+ * @param integer $userId
  * @return int
  */
 function getLastWorkStudentFromParentByUser(
@@ -3738,12 +3740,11 @@ 
 
 /**
  * Creates a new task (directory) in the assignment tool
- * @param array $params
  * @param int $user_id
  * @param array $courseInfo
  * @param int $group_id
  * @param int $session_id
- * @return bool|int
+ * @return string|false
  * @note $params can have the following elements, but should at least have the 2 first ones: (
  *       'new_dir' => 'some-name',
  *       'description' => 'some-desc',
@@ -4239,7 +4240,7 @@ 
 }
 
 /**
- * @return array
+ * @return string[]
  */
 function getUploadDocumentType()
 {
@@ -4611,7 +4612,7 @@ 
  * @param int Session ID
  * @param $correction
  *
- * @return array|bool
+ * @return boolean
  */
 function getFileContents($id, $course_info, $sessionId = 0, $correction = false)
 {
@@ -4729,7 +4730,7 @@ 
  * @param int $userId
  * @param array $courseInfo
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllWork($userId, $courseInfo, $format = 'pdf')
 {
@@ -4777,7 +4778,7 @@ 
  * @param array $courseInfo
  * @param int $sessionId
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllStudentWorkFromPublication(
     $workId,
@@ -4915,7 +4916,7 @@ 
  * Downloads all user files per user
  * @param int $userId
  * @param array $courseInfo
- * @return bool
+ * @return false|null
  */
 function downloadAllFilesPerUser($userId, $courseInfo)
 {
@@ -5029,7 +5030,7 @@ 
 /**
  * @param array $courseInfo
  * @param int $workId
- * @return bool
+ * @return boolean|null
  */
 function protectWork($courseInfo, $workId)
 {

plugin/advanced_subscription/src/AdvancedSubscriptionPlugin.php

Doc Comments +7 added lines, -7 removed lines

@@ -370,7 +370,7 @@ 
      * Register a user into a queue for a session
      * @param $userId
      * @param $sessionId
-     * @return bool|int
+     * @return false|string
      */
     public function addToQueue($userId, $sessionId)
     {
@@ -396,7 +396,7 @@ 
      * Register message with type and status
      * @param $mailId
      * @param $userId
-     * @param $sessionId
+     * @param integer $sessionId
      * @return bool|int
      */
     public function saveLastMessage($mailId, $userId, $sessionId)
@@ -509,7 +509,7 @@ 
 
     /**
      * Check if session is open for subscription
-     * @param $sessionId
+     * @param integer $sessionId
      * @param string $fieldVariable
      * @return bool
      */
@@ -531,8 +531,8 @@ 
 
     /**
      * Check if user is in the session's target group based on its area
-     * @param $userId
-     * @param $sessionId
+     * @param integer $userId
+     * @param integer $sessionId
      * @param string $userFieldVariable
      * @param string $sessionFieldVariable
      * @return bool
@@ -1002,7 +1002,7 @@ 
     /**
      * Return the session details data from a session ID (including the extra
      * fields used for the advanced subscription mechanism)
-     * @param $sessionId
+     * @param integer $sessionId
      * @return bool|mixed
      */
     public function getSessionDetails($sessionId)
@@ -1102,7 +1102,7 @@ 
 
     /**
      * Return the url to go to session
-     * @param $sessionId
+     * @param integer $sessionId
      *
      * @return string
      */

plugin/bbb/lib/bbb.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -240,7 +240,7 @@ 
     /**
      * Returns a meeting "join" URL
      * @param string The name of the meeting (usually the course code)
-     * @return mixed The URL to join the meeting, or false on error
+     * @return false|string The URL to join the meeting, or false on error
      * @todo implement moderator pass
      * @assert ('') === false
      * @assert ('abcdefghijklmnopqrstuvwxyzabcdefghijklmno') === false
@@ -647,7 +647,7 @@ 
      * Closes a meeting (usually when the user click on the close button from
      * the conferences listing.
      * @param string The internal ID of the meeting (id field for this meeting)
-     * @return void
+     * @return false|null
      * @assert (0) === false
      */
     public function endMeeting($id)

plugin/bbb/lib/bbb_api.php

Doc Comments +3 added lines

@@ -59,6 +59,9 @@
 		$this->_bbbServerBaseUrl 	= CONFIG_SERVER_BASE_URL;
 	}
 
+	/**
+	 * @param string $url
+	 */
 	private function _processXmlResponse($url){
 	/*
 	A private utility method used by other public methods to process XML responses.

plugin/buycourses/src/buy_course_plugin.class.php

Doc Comments +10 added lines, -10 removed lines

@@ -32,7 +32,7 @@ 
 

     /**

      *

-     * @return StaticPlugin

+     * @return BuyCoursesPlugin

      */

     static function create()

     {

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

     {

@@ -609,7 +609,7 @@ 
     /**

      * Get session info

      * @param array $sessionId The session ID

-     * @return array

+     * @return Chamilo\CoreBundle\Entity\Session

      */

     public function getSessionInfo($sessionId)

     {

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

     {

@@ -884,7 +884,7 @@ 
 

     /**

      * Get payment types

-     * @return array

+     * @return string[]

      */

     public function getPaymentTypes()

     {

@@ -922,7 +922,7 @@ 
 

     /**

      * Get the statuses for sales

-     * @return array

+     * @return string[]

      */

     public function getSaleStatuses()

     {

@@ -935,7 +935,7 @@ 
     

     /**

      * Get the statuses for Payouts

-     * @return array

+     * @return string[]

      */

     public function getPayoutStatuses()

     {

@@ -948,7 +948,7 @@ 
 

     /**

      * Get the list of product types

-     * @return array

+     * @return string[]

      */

     public function getProductTypes()

     {

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

     {

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

     {

plugin/buycourses/src/paypalfunctions.php

Doc Comments +2 added lines

@@ -324,6 +324,8 @@
  * @nvpStr is nvp string.

  * returns an associtive array containing the response from the server.

  *

+ * @param string $methodName
+ * @param string $nvpStr
  */

 function hash_call($methodName, $nvpStr)

 {

plugin/clockworksms/lib/clockworksms_plugin.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
     /**
      * create (a singleton function that ensures ClockworksmsPlugin instance is
      * created only once. If it is already created, it returns the instance)
-     * @return  object  ClockworksmsPlugin instance
+     * @return  ClockworksmsPlugin  ClockworksmsPlugin instance
      */
     public static function create()
     {