chamilo / chamilo-lms

main/forum/forumfunction.inc.php

Doc Comments +17 added lines, -8 removed lines

@@ -1047,7 +1047,7 @@ 
  * an up and down icon except for the first (no up icon) and the last (no down icon)
  *          The key of this $list array is the id of the item.
  *
- * @return void HTML
+ * @return string HTML
  **/
 function return_up_down_icon($content, $id, $list)
 {
@@ -2007,7 +2007,7 @@ 
  * This function retrieves forum thread users details
  * @param   int Thread ID
  * @param   string  Course DB name (optional)
- * @return  resource array Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
+ * @return  Doctrine\DBAL\Driver\Statement|null array Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
  * @author Christian Fasanando <christian.fasanando@dokeos.com>,
  * @todo     this function need to be improved
  * @version octubre 2008, dokeos 1.8
@@ -2062,7 +2062,7 @@ 
  * This function retrieves forum thread users qualify
  * @param   int Thread ID
  * @param   string  Course DB name (optional)
- * @return  array Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
+ * @return  Doctrine\DBAL\Driver\Statement|null Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
  * @author Jhon Hinojosa
  * @todo     this function need to be improved
  */
@@ -2129,7 +2129,7 @@ 
  * This function retrieves forum thread users not qualify
  * @param   int Thread ID
  * @param   string  Course DB name (optional)
- * @return  array Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
+ * @return  Doctrine\DBAL\Driver\Statement|null Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
  * @author   Jhon Hinojosa<jhon.hinojosa@dokeos.com>,
  * @version oct 2008, dokeos 1.8
  */
@@ -2733,7 +2733,7 @@ 
  *  2. replythread: Replying to a thread ($action = replythread) => I-frame with the complete thread (if enabled)
  *  3. replymessage: Replying to a message ($action =replymessage) => I-frame with the complete thread (if enabled) (I first thought to put and I-frame with the message only)
  *  4. quote: Quoting a message ($action= quotemessage) => I-frame with the complete thread (if enabled). The message will be in the reply. (I first thought not to put an I-frame here)
- * @return void HMTL
+ * @return false|null HMTL
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8
  */
@@ -3153,6 +3153,10 @@ 
  * @param integer contains the information the current user id
  * @param integer contains the information the current thread id
  * @param integer contains the information the current qualify
+ * @param string $option
+ * @param integer $course_id
+ * @param integer $user_id
+ * @param integer $thread_id
  * @return void
  * <code>$option=1 obtained the qualification of the current thread</code>
  * @author Isaac Flores <isaac.flores@dokeos.com>, U.N.A.S University
@@ -3710,6 +3714,8 @@ 
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8
+ * @param string $last_post_id
+ * @param string $post_date
  */
 function updateThreadInfo($thread_id, $last_post_id, $post_date)
 {
@@ -4013,6 +4019,8 @@ 
  *
  * @param string  Content type (post, thread, forum, forum_category)
  * @param int     Item DB ID
+ * @param string $content
+ * @param integer $id
  * @return string language variable
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8
@@ -4490,6 +4498,7 @@ 
 /**
  * Display the search results
  * @param string
+ * @param string $search_term
  * @return void display the results
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version march 2008, dokeos 1.8.5
@@ -4619,7 +4628,7 @@ 
  * This function adds an attachment file into a forum
  * @param string $file_comment  a comment about file
  * @param int $last_id from forum_post table
- * @return int|bool
+ * @return false|null
  */
 function add_forum_attachment_file($file_comment, $last_id)
 {
@@ -4830,7 +4839,7 @@ 
  * @param post id
  * @param int $id_attach
  * @param bool $display to show or not result message
- * @return void
+ * @return integer
  * @author Julio Montoya Dokeos
  * @version october 2014, chamilo 1.9.8
  */
@@ -5112,7 +5121,7 @@ 
  * @param integer $forum_id the id of the forum
  * @param integer $thread_id the id of the thread
  * @param integer $post_id the id of the post
- * @return bool
+ * @return false|null
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version May 2008, dokeos 1.8.5

main/forum/index.php

Spacing +38 added lines, -38 removed lines

@@ -64,7 +64,7 @@ 
 
 if (!empty($gradebook) && $gradebook == 'view') {
     $interbreadcrumb[] = array(
-        'url' => '../gradebook/' . $_SESSION['gradebook_dest'],
+        'url' => '../gradebook/'.$_SESSION['gradebook_dest'],
         'name' => get_lang('ToolGradebook'),
     );
 }
@@ -79,7 +79,7 @@ 
     switch ($_GET['content']) {
         case 'forum':
             $interbreadcrumb[] = array(
-                'url' => 'index.php?search=' . $search_forum . '&' . api_get_cidreq(),
+                'url' => 'index.php?search='.$search_forum.'&'.api_get_cidreq(),
                 'name' => get_lang('Forum'),
             );
             $interbreadcrumb[] = array(
@@ -89,7 +89,7 @@ 
             break;
         case 'forumcategory':
             $interbreadcrumb[] = array(
-                'url' => 'index.php?search=' . $search_forum . '&' . api_get_cidreq(),
+                'url' => 'index.php?search='.$search_forum.'&'.api_get_cidreq(),
                 'name' => get_lang('Forum'),
             );
             $interbreadcrumb[] = array(
@@ -185,7 +185,7 @@ 
         . "&gradebook=&action=add_item&type=step&lp_id=$lp_id#resource_tab-5\">"
         . Display::return_icon(
             'back.png',
-            get_lang("BackTo") . ' ' . get_lang("LearningPaths"),
+            get_lang("BackTo").' '.get_lang("LearningPaths"),
             '',
             ICON_SIZE_MEDIUM
         )
@@ -197,8 +197,8 @@ 
 
 if (api_is_allowed_to_edit(false, true)) {
     echo '<a href="'
-        . api_get_self() . '?' . api_get_cidreq()
-        . '&action=add&content=forumcategory&lp_id=' . $lp_id . '"> ' .
+        . api_get_self().'?'.api_get_cidreq()
+        . '&action=add&content=forumcategory&lp_id='.$lp_id.'"> '.
         Display::return_icon(
             'new_folder.png', get_lang('AddForumCategory'), '', ICON_SIZE_MEDIUM
         )
@@ -248,7 +248,7 @@ 
         );
 
         if (empty($sessionId) && !empty($forumCategory['session_name'])) {
-            $session_displayed = ' (' . Security::remove_XSS($forumCategory['session_name']) . ')';
+            $session_displayed = ' ('.Security::remove_XSS($forumCategory['session_name']).')';
         } else {
             $session_displayed = '';
         }
@@ -260,7 +260,7 @@ 
         $html = '';
         $iconsEdit = '';
         $idCategory = $forumCategory['cat_id'];
-        $urlCategory = 'viewforumcategory.php?' . api_get_cidreq() . '&forumcategory=' . intval($idCategory);
+        $urlCategory = 'viewforumcategory.php?'.api_get_cidreq().'&forumcategory='.intval($idCategory);
         $titleCategory = Display::tag(
             'a',
             $forumCategory['cat_title'],
@@ -278,9 +278,9 @@ 
                 !($forumCategory['session_id'] == 0 &&
                 intval($sessionId) != 0)
             ) {
-                $iconsEdit .= '<a href="' . api_get_self() . '?' . api_get_cidreq()
-                    . '&action=edit&content=forumcategory&id=' . intval($idCategory)
-                    . '">' . Display::return_icon(
+                $iconsEdit .= '<a href="'.api_get_self().'?'.api_get_cidreq()
+                    . '&action=edit&content=forumcategory&id='.intval($idCategory)
+                    . '">'.Display::return_icon(
                         'edit.png',
                         get_lang('Edit'),
                         array(),
@@ -288,8 +288,8 @@ 
                     )
                     . '</a>';
 
-                $iconsEdit .='<a href="' . api_get_self() . '?' . api_get_cidreq()
-                    . '&action=delete&content=forumcategory&id=' . intval($idCategory)
+                $iconsEdit .= '<a href="'.api_get_self().'?'.api_get_cidreq()
+                    . '&action=delete&content=forumcategory&id='.intval($idCategory)
                     . "\" onclick=\"javascript:if(!confirm('"
                     . addslashes(api_htmlentities(
                         get_lang('DeleteForumCategory'),
@@ -303,7 +303,7 @@ 
                         ICON_SIZE_SMALL
                     )
                     . '</a>';
-                $iconsEdit .=  return_visible_invisible_icon(
+                $iconsEdit .= return_visible_invisible_icon(
                     'forumcategory',
                     strval(intval($idCategory)),
                     strval(intval($forumCategory['visibility']))
@@ -337,7 +337,7 @@ 
             array(),
             ICON_SIZE_MEDIUM
         );
-        $html .= '<h3>' . $icoCategory . $titleCategory . '</h3>';
+        $html .= '<h3>'.$icoCategory.$titleCategory.'</h3>';
 
         if ($descriptionCategory != '' && trim($descriptionCategory) != '&nbsp;') {
             $html .= '<div class="forum-description">'.$descriptionCategory.'</div>';
@@ -470,15 +470,15 @@ 
                                 30
                             );
                             $forum_title_group_addition = ' (<a href="../group/group_space.php?'
-                                . api_get_cidreq() . '&gidReq=' . $forum['forum_of_group']
-                                . '" class="forum_group_link">' . get_lang('GoTo') . ' ' . $group_title . '</a>)'
+                                . api_get_cidreq().'&gidReq='.$forum['forum_of_group']
+                                . '" class="forum_group_link">'.get_lang('GoTo').' '.$group_title.'</a>)'
                                 . $session_img;
                         } else {
                             $forum_title_group_addition = '';
                         }
 
                         if (empty($sessionId) && !empty($forum['session_name'])) {
-                            $session_displayed = ' (' . $forum['session_name'] . ')';
+                            $session_displayed = ' ('.$forum['session_name'].')';
                         } else {
                             $session_displayed = '';
                         }
@@ -490,7 +490,7 @@ 
                         $html .= '<div class="row">';
                         $html .= '<div class="col-md-6">';
                         $html .= '<div class="col-md-3">';
-                        $html .= '<div class="number-post">'.$forum_image.'<p>'.$number_threads.' ' . get_lang('ForumThreads') . '</p>'
+                        $html .= '<div class="number-post">'.$forum_image.'<p>'.$number_threads.' '.get_lang('ForumThreads').'</p>'
                             . '</div>';
                         $html .= '</div>';
 
@@ -505,15 +505,15 @@ 
                         $linkForum .= Display::tag(
                             'a',
                             $forum['forum_title'],
-                            array (
-                                'href' => 'viewforum.php?' . api_get_cidreq()
-                                    . '&gidReq=' . intval($groupid)
-                                    . '&forum=' . intval($forum['forum_id']),
-                                'class' => return_visible_invisible( strval( intval($forum['visibility']) ) )
+                            array(
+                                'href' => 'viewforum.php?'.api_get_cidreq()
+                                    . '&gidReq='.intval($groupid)
+                                    . '&forum='.intval($forum['forum_id']),
+                                'class' => return_visible_invisible(strval(intval($forum['visibility'])))
                             )
                         );
 
-                        $html .= '<h3 class="title">' . $iconForum . $linkForum . '</h3>';
+                        $html .= '<h3 class="title">'.$iconForum.$linkForum.'</h3>';
                         $html .= Display::tag(
                             'p',
                             Security::remove_XSS($forum['forum_comment']),
@@ -528,9 +528,9 @@ 
 
                         // The number of topics and posts.
                         if ($forum['forum_of_group'] !== '0') {
-                            $newPost='';
+                            $newPost = '';
                             if (is_array($mywhatsnew_post_info) && !empty($mywhatsnew_post_info)) {
-                                $newPost = ' ' . Display::return_icon(
+                                $newPost = ' '.Display::return_icon(
                                     'alert.png',
                                     get_lang('Forum'),
                                     null,
@@ -541,7 +541,7 @@ 
                             }
                         } else {
                             if (is_array($mywhatsnew_post_info) && !empty($mywhatsnew_post_info)) {
-                                $newPost = ' ' . Display::return_icon(
+                                $newPost = ' '.Display::return_icon(
                                     'alert.png',
                                     get_lang('Forum'),
                                     null,
@@ -583,9 +583,9 @@ 
                                     null,
                                     ICON_SIZE_TINY
                                 )
-                                . ' ' .
+                                . ' '.
                                 api_convert_and_format_date($forum['last_post_date'])
-                                . '<br /> ' . get_lang('By') . ' ' .
+                                . '<br /> '.get_lang('By').' '.
                                 display_user_link(
                                     $poster_id,
                                     $name,
@@ -600,13 +600,13 @@ 
                             api_is_allowed_to_edit(false, true) &&
                             !($forum['session_id'] == 0 && intval($sessionId) != 0)
                         ) {
-                            $html .= '<a href="'.api_get_self() . '?' . api_get_cidreq()
-                                . '&action=edit&content=forum&id=' . $forum['forum_id'] . '">'
+                            $html .= '<a href="'.api_get_self().'?'.api_get_cidreq()
+                                . '&action=edit&content=forum&id='.$forum['forum_id'].'">'
                                 . Display::return_icon('edit.png', get_lang('Edit'), array(), ICON_SIZE_SMALL)
                                 . '</a>';
-                            $html .= '<a href="' . api_get_self() . '?' . api_get_cidreq()
-                                . '&action=delete&content=forum&id=' . $forum['forum_id']
-                                . "\" onclick=\"javascript:if(!confirm('" . addslashes(
+                            $html .= '<a href="'.api_get_self().'?'.api_get_cidreq()
+                                . '&action=delete&content=forum&id='.$forum['forum_id']
+                                . "\" onclick=\"javascript:if(!confirm('".addslashes(
                                     api_htmlentities(get_lang('DeleteForum'), ENT_QUOTES)
                                 )
                                 . "')) return false;\">"
@@ -644,8 +644,8 @@ 
                             !api_is_anonymous() &&
                             api_is_allowed_to_session_edit(false, true)
                         ) {
-                            $html .= '<a href="' . api_get_self() . '?' . api_get_cidreq()
-                                . '&action=notify&content=forum&id=' . $forum['forum_id'] . '">'
+                            $html .= '<a href="'.api_get_self().'?'.api_get_cidreq()
+                                . '&action=notify&content=forum&id='.$forum['forum_id'].'">'
                                 . Display::return_icon($iconnotify, get_lang('NotifyMe'), null, ICON_SIZE_SMALL)
                                 . '</a>';
                         }
@@ -662,7 +662,7 @@ 
                 }
             }
         } else {
-            echo '<div class="alert alert-warning">' . get_lang('NoForumInThisCategory') . '</div>'
+            echo '<div class="alert alert-warning">'.get_lang('NoForumInThisCategory').'</div>'
                 . (api_is_allowed_to_edit(false, true) ? '<div>' : '</div>')
                 . '</div>';
         }