chamilo / chamilo-lms

main/webservices/cm_webservice_user.php

Doc Comments +1 added lines, -1 removed lines

@@ -137,7 +137,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 Use the UserManager class

Indentation +6 added lines, -6 removed lines

@@ -171,14 +171,14 @@
 
 
     /**
-    * 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
-    * @return array An array with all users of the platform.
-    * @todo optional course code parameter, optional sorting parameters...
+     * 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
+     * @return array An array with all users of the platform.
+     * @todo optional course code parameter, optional sorting parameters...
      *@todo Use the UserManager class
      * @todo security filter order by
-    */
+     */
     private static function get_user_list_like_start($conditions = [], $order_by = [])
     {
         $user_table = Database::get_main_table(TABLE_MAIN_USER);

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/openmeetings/lib/openmeetings.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -213,7 +213,8 @@
     /**
      * 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
+     * @param false|string $meetingId
+     * @return false|null The URL to join the meeting, or false on error
      * @todo implement moderator pass
      * @assert ('') === false
      * @assert ('abcdefghijklmnopqrstuvwxyzabcdefghijklmno') === false

Indentation +5 added lines, -5 removed lines

@@ -214,10 +214,10 @@ 
         return true;
     }
 
-     /**
-     * Gets the password for a specific meeting for the current user
-     * @return string A moderator password if user is teacher, or the course code otherwise
-     */
+        /**
+         * Gets the password for a specific meeting for the current user
+         * @return string A moderator password if user is teacher, or the course code otherwise
+         */
     public function getMeetingUserPassword()
     {
         if ($this->isTeacher()) {
@@ -473,7 +473,7 @@ 
     //
     //            }
     //
-                 //$item['created_at'] = api_convert_and_format_date($meetingDb['created_at']);
+                    //$item['created_at'] = api_convert_and_format_date($meetingDb['created_at']);
     //            //created_at
     //
     //            $item['publish_url'] = api_get_self().'?action=publish&id='.$meetingDb['id'];

plugin/openmeetings/lib/openmeetings_gateway.php

Doc Comments +5 added lines

@@ -36,6 +36,11 @@
     private $_pass;
     private $_url;
 
+    /**
+     * @param string $host
+     * @param string $user
+     * @param string $pass
+     */
     public function __construct($host, $user, $pass)
     {
         $this->_user = urlencode($user);

Indentation +3 added lines, -3 removed lines

@@ -351,9 +351,9 @@
                 . '&externalRoomType='.$room->externalRoomType;
         if ($room->allowRecording) {
             $url .= '&allowUserQuestions='.$this->var_to_str($room->allowUserQuestions)
-                 . '&isAudioOnly='.$this->var_to_str($room->isAudioOnly)
-                 . '&waitForRecording='.$this->var_to_str($room->waitForRecording)
-                 . '&allowRecording='.$this->var_to_str($room->allowRecording);
+                    . '&isAudioOnly='.$this->var_to_str($room->isAudioOnly)
+                    . '&waitForRecording='.$this->var_to_str($room->waitForRecording)
+                    . '&allowRecording='.$this->var_to_str($room->allowRecording);
         } elseif ($room->isAudioOnly) {
             $url .= '&isAudioOnly='.$this->var_to_str($room->isAudioOnly);
         }

plugin/openmeetings/lib/openmeetings_rest_service.php

Doc Comments +6 added lines

@@ -27,6 +27,9 @@ 
  */
 class OpenMeetingsRestService
 {
+    /**
+     * @param string $request
+     */
     function call($request, $returnAttribute = "return")
     {
         // This will allow you to view errors in the browser
@@ -121,6 +124,9 @@ 
             
     }
 
+    /**
+     * @param DOMDocument $node
+     */
     function getArray($node)
     {
         if (is_null($node) || !is_object($node)) {

plugin/openmeetings/lib/room.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -99,7 +99,7 @@
     /**
      * Gets a string from a boolean attribute
      * @param string $attribute Name of the attribute
-     * @param mixed  $voidReturn What to return if the value is not defined
+     * @param string  $voidReturn What to return if the value is not defined
      * @return string The boolean value expressed as string ('true' or 'false')
      */
     public function getString($attribute, $voidReturn = false)

plugin/search_course/lib/search_course_widget.class.php

Doc Comments +8 added lines

@@ -40,11 +40,19 @@
         return isset($_GET[$key]) ? $_GET[$key] : $default;
     }
 
+    /**
+     * @param string $key
+     *
+     * @return string
+     */
     public static function server($key, $default = '')
     {
         return isset($_SERVER[$key]) ? $_SERVER[$key] : $default;
     }
 
+    /**
+     * @param string $name
+     */
     public static function get_lang($name)
     {
         return SearchCoursePlugin::create()->get_lang($name);

Upper-Lower-Casing +5 added lines, -5 removed lines

@@ -184,7 +184,7 @@ 
         <div class="well course_search">
         <div class="menusection">
             <h4>$search_course_label</h4>
-EOT;
+eot;
     }
 
     function display_footer()
@@ -209,7 +209,7 @@ 
             <input type="text" name="search_term" class="span2" value="$search_term" />
             &nbsp;<input class="btn btn-default" type="submit" value="$search_label" />
         </form>
-EOT;
+eot;
         echo $form;
     }
 
@@ -293,7 +293,7 @@ 
                 <form action="$self?action=subscribe" method="post">
                     <input type="hidden" name="sec_token" value="$stok" />
                     <input type="hidden" name="subscribe" value="$code" />
-EOT;
+eot;
 
         $search_term = $this->post('search_term');
         if ($search_term)
@@ -302,7 +302,7 @@ 
             echo <<<EOT
                     <input type="hidden" name="search_course" value="1" />
                     <input type="hidden" name="search_term" value="$search_term" />
-EOT;
+eot;
         }
         echo '<input type="image" name="unsub" src="'.Display::returnIconPath('enroll.gif').'" alt="'.get_lang('Subscribe').'" />
                 '.get_lang('Subscribe').'
@@ -346,7 +346,7 @@ 
                 SELECT * FROM $course_table
                 WHERE ($course_fiter) AND (code LIKE '%$search_term%' OR visual_code LIKE '%$search_term%' OR title LIKE '%$search_term%' OR tutor_name LIKE '%$search_term%')
                 ORDER BY title, visual_code ASC
-EOT;
+eot;
 
         $result = array();
         $resultset = Database::query($sql);

Braces +15 added lines, -33 removed lines

@@ -108,8 +108,7 @@ 
      */
     function run()
     {
-        if (!$this->accept())
-        {
+        if (!$this->accept()) {
             return;
         }
         $this->display_header();
@@ -120,21 +119,15 @@ 
         $action = self::get('action');
 
         $has_content = !empty($search_term) || !empty($action);
-        if ($has_content)
-        {
+        if ($has_content) {
             echo '<div class="list">';
-        }
-        else
-        {
+        } else {
             echo '<div>';
         }
 
-        if (RegisterCourseWidget::factory()->run())
-        {
+        if (RegisterCourseWidget::factory()->run()) {
             $result = true;
-        }
-        else
-        {
+        } else {
             $result = $this->action_display();
         }
 
@@ -148,8 +141,7 @@ 
     {
         $self = $_SERVER['PHP_SELF'];
         $parameters = array();
-        if ($action)
-        {
+        if ($action) {
             $parameters[self::PARAM_ACTION] = $action;
         }
         $parameters = implode('&', $parameters);
@@ -165,8 +157,7 @@ 
         global $charset;
 
         $search_term = self::post('search_term');
-        if ($search_term)
-        {
+        if ($search_term) {
             $search_result_for_label = self::get_lang('SearchResultsFor');
             $search_term_html = htmlentities($search_term, ENT_QUOTES, $charset);
             echo "<h5>$search_result_for_label $search_term_html</h5>";
@@ -275,8 +266,7 @@ 
 
         //Already subscribed
         $code = $current_course['code'];
-        if (isset($user_courses[$code]))
-        {
+        if (isset($user_courses[$code])) {
             echo self::get_lang('AlreadySubscribed');
             return false;
         }
@@ -296,8 +286,7 @@ 
 EOT;
 
         $search_term = $this->post('search_term');
-        if ($search_term)
-        {
+        if ($search_term) {
             $search_term = Security::remove_XSS($search_term);
             echo <<<EOT
                     <input type="hidden" name="search_course" value="1" />
@@ -324,19 +313,15 @@ 
      */
     function retrieve_courses($search_term)
     {
-        if (empty($search_term))
-        {
+        if (empty($search_term)) {
             return array();
         }
         $search_term = Database::escape_string($search_term);
         $course_table = Database::get_main_table(TABLE_MAIN_COURSE);
 
-        if (api_is_anonymous())
-        {
+        if (api_is_anonymous()) {
             $course_fiter = 'visibility = '.COURSE_VISIBILITY_OPEN_WORLD;
-        }
-        else
-        {
+        } else {
             $course_fiter = 'visibility = '.COURSE_VISIBILITY_OPEN_WORLD.' OR ';
             $course_fiter .= 'visibility = '.COURSE_VISIBILITY_OPEN_PLATFORM.' OR ';
             $course_fiter .= '(visibility = '.COURSE_VISIBILITY_REGISTERED.' AND subscribe = 1)';
@@ -374,8 +359,7 @@ 
      */
     function retrieve_user_courses($user_id = null)
     {
-        if (is_null($user_id))
-        {
+        if (is_null($user_id)) {
             global $_user;
             $user_id = $_user['user_id'];
         }
@@ -423,8 +407,7 @@ 
      */
     function filter_out_user_courses($courses)
     {
-        if (empty($courses))
-        {
+        if (empty($courses)) {
             return $courses;
         }
 
@@ -432,8 +415,7 @@ 
         $user_id = $_user['user_id'];
 
         $user_courses = $this->retrieve_user_courses($user_id);
-        foreach ($user_courses as $key => $value)
-        {
+        foreach ($user_courses as $key => $value) {
             unset($courses[$key]);
         }
         return $courses;

src/Chamilo/CoreBundle/Component/Editor/CkEditor/CkEditor.php

Doc Comments +1 added lines, -1 removed lines

@@ -94,7 +94,7 @@
     /**
      * @param array $templates
      *
-     * @return null
+     * @return null|string
      */
     public function formatTemplates($templates)
     {

Spacing +2 added lines, -2 removed lines

@@ -109,7 +109,7 @@ 
         /** @var \Chamilo\CoreBundle\Entity\SystemTemplate $template */
         $templateList = array();
         $cssTheme = api_get_path(WEB_CSS_PATH).'themes/'.api_get_visual_theme().'/';
-        $search = array('{CSS_THEME}', '{IMG_DIR}', '{REL_PATH}', '{COURSE_DIR}','{CSS}');
+        $search = array('{CSS_THEME}', '{IMG_DIR}', '{REL_PATH}', '{COURSE_DIR}', '{CSS}');
         $replace = array(
             $cssTheme,
             api_get_path(REL_CODE_PATH).'img/',
@@ -177,7 +177,7 @@ 
         $entityManager = \Database::getManager();
         $systemTemplates = $entityManager->getRepository('ChamiloCoreBundle:SystemTemplate')->findAll();
         $cssTheme = api_get_path(WEB_CSS_PATH).'themes/'.api_get_visual_theme().'/';
-        $search = array('{CSS_THEME}', '{IMG_DIR}', '{REL_PATH}', '{COURSE_DIR}','{CSS}');
+        $search = array('{CSS_THEME}', '{IMG_DIR}', '{REL_PATH}', '{COURSE_DIR}', '{CSS}');
         $replace = array(
             $cssTheme,
             api_get_path(REL_CODE_PATH).'img/',

src/Chamilo/CoreBundle/Component/Editor/Connector.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 
     /**
      * Available driver list.
-     * @return array
+     * @return string[]
      */
     private function getDefaultDriverList()
     {