chamilo / chamilo-lms

main/webservices/webservice_user.php

Doc Comments +6 added lines

@@ -42,6 +42,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)
@@ -257,6 +258,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(

main/exercise/hotpotatoes.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -261,7 +261,7 @@ 
  * Searches for a node in the given array.
  * @param    array    $array Reference to the array to search
  * @param    string   $node  Node we are looking for in the array
- * @return   mixed    Node name or false if not found
+ * @return   false|string    Node name or false if not found
  */
 function myarraysearch(&$array, $node)
 {
@@ -282,7 +282,7 @@ 
  * Searches an image name into an array.
  * @param    array        $imgparams Reference to an array to search
  * @param    string       $string String to look for
- * @return   mixed        String given if found, false otherwise
+ * @return   false|string        String given if found, false otherwise
  * @uses     myarraysearch    This function is just an additional layer on the myarraysearch() function
  */
 function CheckImageName(&$imgparams, $string)

plugin/maintenancemode/MaintenanceModePlugin.php

Doc Comments +1 added lines, -1 removed lines

@@ -7,7 +7,7 @@
 class MaintenanceModePlugin extends Plugin
 {
     /**
-     * @return EditHtaccessPlugin
+     * @return MaintenanceModePlugin
      */
     public static function create()
     {

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

Doc Comments +4 added lines, -1 removed lines

@@ -120,6 +120,9 @@ 
         return $this->created_at;
     }
 
+    /**
+     * @return string
+     */
     public function get_weight()
     {
         return $this->weight;
@@ -271,7 +274,7 @@ 
     }
 
     /**
-     * @param array $result
+     * @param Doctrine\DBAL\Driver\Statement $result
      * @return array
      */
     private static function create_evaluation_objects_from_sql_result($result)

main/inc/lib/extra_field_option.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -115,7 +115,7 @@ 
      * Delete all the options of a specific field
      * @param int $field_id
      *
-     * @return void
+     * @return Statement
      * @assert (-1) === false
      */
     public function delete_all_options_by_field_id($field_id)
@@ -412,7 +412,7 @@ 
      * Gets an array of options for a specific field
      * @param int $field_id The field ID
      * @param bool $add_id_in_array Whether to add the row ID in the result
-     * @param null $ordered_by Extra ordering query bit
+     * @param null|string $ordered_by Extra ordering query bit
      * @return array The options if they exists. Otherwise return false
      */
     public function get_field_options_by_field($field_id, $add_id_in_array = false, $ordered_by = null)
@@ -784,8 +784,8 @@ 
     }
 
     /**
-     * @param $defaultDisplayText
-     * @return mixed|string
+     * @param string $defaultDisplayText
+     * @return string
      */
     public static function getLanguageVariable($defaultDisplayText)
     {

plugin/search_course/lib/register_course_widget.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
     /**
      * Handle the subscribe action.
      *
-     * @return bool
+     * @return null|boolean
      */
     function action_subscribe_user()
     {

main/inc/lib/table_sort.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
      * @param string $direction The direction to sort (SORT_ASC (default) orSORT_DESC)
      * @param array $column_show The columns that we will show in the table i.e: $column_show = array('1','0','1') we will show the 1st and the 3th column.
      * @param array $column_order Changes how the columns will be sorted ie. $column_order = array('0','3','2','3') The column [1] will be sorted like the column [3]
-     * @param constant $type How should data be sorted (SORT_REGULAR, SORT_NUMERIC, SORT_STRING, SORT_DATE, SORT_IMAGE)
+     * @param integer $type How should data be sorted (SORT_REGULAR, SORT_NUMERIC, SORT_STRING, SORT_DATE, SORT_IMAGE)
      * @return array The sorted dataset
      * @author bart.mollet@hogent.be
      */

src/Chamilo/CoreBundle/Component/Utils/ChamiloApi.php

Doc Comments +1 added lines, -1 removed lines

@@ -133,7 +133,7 @@
     /**
      * Like strip_tags(), but leaves an additional space and removes only the given tags
      * @param string $string
-     * @param array $tags Tags to be removed
+     * @param string[] $tags Tags to be removed
      * @return  string The original string without the given tags
      */
     public static function stripGivenTags($string, $tags)

main/work/work.lib.php

Doc Comments +14 added lines, -12 removed lines

@@ -729,7 +729,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
  */
@@ -751,7 +751,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)
 {
@@ -955,7 +955,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)
 {
@@ -1014,6 +1014,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
  * @version April 2008
@@ -1087,7 +1088,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
@@ -2898,7 +2899,7 @@ 
  * @param int $userId
  * @param int $workId
  * @param int $courseId
- * @return bool
+ * @return boolean|null
  */
 function allowOnlySubscribedUser($userId, $workId, $courseId)
 {
@@ -3175,6 +3176,7 @@ 
  * @param array $parentInfo
  * @param array $courseInfo
  * @param int $sessionId
+ * @param integer $userId
  * @return int
  */
 function getLastWorkStudentFromParentByUser(
@@ -3326,7 +3328,7 @@ 
  * @param array $parentWork
  * @param array $work
  * @param array $data
- * @return int
+ * @return false|null
  */
 function addWorkComment($courseInfo, $userId, $parentWork, $work, $data)
 {
@@ -4616,7 +4618,7 @@ 
 }
 
 /**
- * @return array
+ * @return string[]
  */
 function getUploadDocumentType()
 {
@@ -5004,7 +5006,7 @@ 
  * @param int Session ID
  * @param $correction
  *
- * @return array|bool
+ * @return boolean
  */
 function getFileContents($id, $course_info, $sessionId = 0, $correction = false)
 {
@@ -5133,7 +5135,7 @@ 
  * @param int $userId
  * @param array $courseInfo
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllWork($userId, $courseInfo, $format = 'pdf')
 {
@@ -5179,7 +5181,7 @@ 
  * @param array $courseInfo
  * @param int $sessionId
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllStudentWorkFromPublication(
     $workId,
@@ -5313,7 +5315,7 @@ 
  * Downloads all user files per user
  * @param int $userId
  * @param array $courseInfo
- * @return bool
+ * @return false|null
  */
 function downloadAllFilesPerUser($userId, $courseInfo)
 {
@@ -5428,7 +5430,7 @@ 
 /**
  * @param array $courseInfo
  * @param int $workId
- * @return bool
+ * @return boolean|null
  */
 function protectWork($courseInfo, $workId)
 {