chamilo / chamilo-lms

main/inc/lib/AnnouncementEmail.php

Doc Comments +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
     /**
      *
      * @param int|array $course
-     * @param int|array $annoucement
+     * @param integer $announcement
      *
      * @return AnnouncementEmail
      */
@@ -50,7 +50,7 @@ 
      *
      * @param string $key
      *
-     * @return array
+     * @return string|null
      */
     public function course($key = '')
     {

Spacing +1 added lines, -1 removed lines

@@ -196,7 +196,7 @@
      *
      * @return array
      */
-    public function sender($key = '',  $userId = '')
+    public function sender($key = '', $userId = '')
     {
         $_user = api_get_user_info($userId);
 

main/inc/lib/AnnouncementManager.php

Doc Comments +9 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_tags()
     {
@@ -40,7 +40,7 @@ 
      * @param string    $course_code
      * @param int       $session_id
      *
-     * @return mixed
+     * @return string
      */
     public static function parse_content($userId, $content, $course_code, $session_id = 0)
     {
@@ -349,7 +349,7 @@ 
      * @param array	    uploaded file $_FILES
      * @param string    Comment describing the attachment
      * @param bool  $sendToUsersInSession
-     * @return int      false on failure, ID of the announcement on success
+     * @return false|string      false on failure, ID of the announcement on success
      */
     public static function add_announcement(
         $emailTitle,
@@ -460,7 +460,7 @@ 
      * @param $to_users
      * @param array $file
      * @param string $file_comment
-     * @return bool|int
+     * @return false|string
      */
     public static function add_group_announcement(
         $emailTitle,
@@ -699,7 +699,7 @@ 
 
     /**
      * @param int $insert_id
-     * @return bool
+     * @return false|null
      */
     public static function update_mail_sent($insert_id)
     {
@@ -719,6 +719,7 @@ 
      * Gets all announcements from a user by course
      * @param	string course db
      * @param	int user id
+     * @param integer $user_id
      * @return	array html with the content and count of announcements or false otherwise
      */
     public static function get_all_annoucement_by_user_course($course_code, $user_id)
@@ -1184,6 +1185,7 @@ 
      * has been sent to
      * @param    string  The tool (announcement, agenda, ...)
      * @param    int     ID of the element of the corresponding type
+     * @param string $tool
      * @return   array   Array of users and groups to whom the element has been sent
      */
     public static function sent_to($tool, $id)
@@ -1308,6 +1310,8 @@ 
      * @param int attach id
      * @param array uploaded file $_FILES
      * @param string file comment
+     * @param integer $id_attach
+     * @param string $file_comment
      * @return int
      */
     public static function edit_announcement_attachment_file($id_attach, $file, $file_comment)

Indentation +1 added lines, -1 removed lines

@@ -1510,7 +1510,7 @@
                             ip.to_user_id=$user_id OR (ip.to_group_id IS NULL OR ip.to_group_id IN (0, ".implode(", ", $group_memberships)."))
                         ) ";
                     } else {
-                       $cond_user_id = " AND (
+                        $cond_user_id = " AND (
                             ip.to_user_id=$user_id OR (ip.to_group_id IS NULL OR ip.to_group_id IN (0, ".api_get_group_id()."))
                         )";
                     }

Spacing +74 added lines, -74 removed lines

@@ -216,8 +216,8 @@ 
                             announcement.id = '$announcement_id' AND
                             toolitemproperties.tool='announcement' AND
                             (
-                                toolitemproperties.to_user_id='" . api_get_user_id() . "' OR
-                                toolitemproperties.to_group_id IN ('0', '" . implode("', '", $group_list) . "') OR
+                                toolitemproperties.to_user_id='".api_get_user_id()."' OR
+                                toolitemproperties.to_group_id IN ('0', '" . implode("', '", $group_list)."') OR
                                 toolitemproperties.to_group_id IS NULL
                             ) AND
                             toolitemproperties.visibility='1' AND
@@ -246,13 +246,13 @@ 
             $title = $result['title'];
             $content = $result['content'];
             $html .= "<table height=\"100\" width=\"100%\" cellpadding=\"5\" cellspacing=\"0\" class=\"data_table\">";
-            $html .= "<tr><td><h2>" . $title . "</h2></td></tr>";
+            $html .= "<tr><td><h2>".$title."</h2></td></tr>";
 
             if (api_is_allowed_to_edit(false, true) ||
                 (api_get_course_setting('allow_user_edit_announcement') && !api_is_anonymous())
             ) {
-                $modify_icons = "<a href=\"" . api_get_self() . "?" . api_get_cidreq() . "&action=modify&id=" . $announcement_id . "\">" .
-                    Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL) . "</a>";
+                $modify_icons = "<a href=\"".api_get_self()."?".api_get_cidreq()."&action=modify&id=".$announcement_id."\">".
+                    Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL)."</a>";
                 if ($result['visibility'] == 1) {
                     $image_visibility = "visible";
                     $alt_visibility = get_lang('Hide');
@@ -262,12 +262,12 @@ 
                 }
                 global $stok;
 
-                $modify_icons .= "<a href=\"" . api_get_self() . "?" . api_get_cidreq() . "&origin=" . (!empty($_GET['origin']) ? Security::remove_XSS($_GET['origin']) : '') . "&action=showhide&id=" . $announcement_id . "&sec_token=" . $stok . "\">" .
-                    Display::return_icon($image_visibility . '.png', $alt_visibility, '', ICON_SIZE_SMALL) . "</a>";
+                $modify_icons .= "<a href=\"".api_get_self()."?".api_get_cidreq()."&origin=".(!empty($_GET['origin']) ? Security::remove_XSS($_GET['origin']) : '')."&action=showhide&id=".$announcement_id."&sec_token=".$stok."\">".
+                    Display::return_icon($image_visibility.'.png', $alt_visibility, '', ICON_SIZE_SMALL)."</a>";
 
                 if (api_is_allowed_to_edit(false, true)) {
-                    $modify_icons .= "<a href=\"" . api_get_self() . "?" . api_get_cidreq() . "&action=delete&id=" . $announcement_id . "&sec_token=" . $stok . "\" onclick=\"javascript:if(!confirm('" . addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES, $charset)) . "')) return false;\">" .
-                        Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL) .
+                    $modify_icons .= "<a href=\"".api_get_self()."?".api_get_cidreq()."&action=delete&id=".$announcement_id."&sec_token=".$stok."\" onclick=\"javascript:if(!confirm('".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES, $charset))."')) return false;\">".
+                        Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).
                         "</a>";
                 }
                 $html .= "<tr><th style='text-align:right'>$modify_icons</th></tr>";
@@ -276,7 +276,7 @@ 
             $content = self::parse_content($result['to_user_id'], $content, api_get_course_id(), api_get_session_id());
 
             $html .= "<tr><td>$content</td></tr>";
-            $html .= "<tr><td class=\"announcements_datum\">" . get_lang('LastUpdateDate') . " : " . api_convert_and_format_date($result['insert_date'], DATE_TIME_FORMAT_LONG) . "</td></tr>";
+            $html .= "<tr><td class=\"announcements_datum\">".get_lang('LastUpdateDate')." : ".api_convert_and_format_date($result['insert_date'], DATE_TIME_FORMAT_LONG)."</td></tr>";
 
             // User or group icon
             $sent_to_icon = '';
@@ -288,7 +288,7 @@ 
                 $sent_to_form = self::sent_to_form($sent_to);
                 $html .= Display::tag(
                     'td',
-                    get_lang('SentTo') . ' : ' . $sent_to_form,
+                    get_lang('SentTo').' : '.$sent_to_form,
                     array('class' => 'announcements_datum')
                 );
             }
@@ -298,15 +298,15 @@ 
                 $html .= "<tr><td>";
                 $realname = $attachment_list['path'];
                 $user_filename = $attachment_list['filename'];
-                $full_file_name = 'download.php?'.api_get_cidreq().'&file=' . $realname;
+                $full_file_name = 'download.php?'.api_get_cidreq().'&file='.$realname;
                 $html .= '<br/>';
                 $html .= Display::return_icon('attachment.gif', get_lang('Attachment'));
-                $html .= '<a href="' . $full_file_name . ' "> ' . $user_filename . ' </a>';
-                $html .= ' - <span class="forum_attach_comment" >' . $attachment_list['comment'] . '</span>';
+                $html .= '<a href="'.$full_file_name.' "> '.$user_filename.' </a>';
+                $html .= ' - <span class="forum_attach_comment" >'.$attachment_list['comment'].'</span>';
                 if (api_is_allowed_to_edit(false, true)) {
                     $html .= Display::url(
                         Display::return_icon('delete.png', get_lang('Delete'), '', 16),
-                        api_get_self() . "?" . api_get_cidreq() . "&action=delete_attachment&id_attach=" . $attachment_list['id'] . "&sec_token=" . $stok
+                        api_get_self()."?".api_get_cidreq()."&action=delete_attachment&id_attach=".$attachment_list['id']."&sec_token=".$stok
                     );
                 }
                 $html .= '</td></tr>';
@@ -334,7 +334,7 @@ 
         $order = 0;
         if (Database::num_rows($res_max)) {
             $row_max = Database::fetch_array($res_max);
-            $order = intval($row_max[0])+1;
+            $order = intval($row_max[0]) + 1;
         }
 
         return $order;
@@ -754,8 +754,8 @@ 
             $result = array();
             if ($num_rows > 0) {
                 while ($myrow = Database::fetch_array($rs)) {
-                    $content.= '<strong>' . $myrow['title'] . '</strong><br /><br />';
-                    $content.= $myrow['content'];
+                    $content .= '<strong>'.$myrow['title'].'</strong><br /><br />';
+                    $content .= $myrow['content'];
                     $i++;
                 }
                 $result['content'] = $content;
@@ -786,7 +786,7 @@ 
         echo "<table id=\"recipient_list\" >";
         echo '<tr>';
         echo '<td>';
-        echo '<label><input type="checkbox" id="send_to_all_users">'.get_lang('SendToAllUsers') . "</label>";
+        echo '<label><input type="checkbox" id="send_to_all_users">'.get_lang('SendToAllUsers')."</label>";
         echo "</td>";
         echo '</tr>';
         echo '<tr>';
@@ -794,7 +794,7 @@ 
 
         // the form containing all the groups and all the users of the course
         echo '<td>';
-        echo "<strong>" . get_lang('Users') . "</strong><br />";
+        echo "<strong>".get_lang('Users')."</strong><br />";
 
         self::construct_not_selected_select_form($groupList, $userList, $to_already_selected);
         echo "</td>";
@@ -809,7 +809,7 @@ 
         echo "<td>";
 
         // the form containing the selected groups and users
-        echo "<strong>" . get_lang('DestinationUsers') . "</strong><br />";
+        echo "<strong>".get_lang('DestinationUsers')."</strong><br />";
         self::construct_selected_select_form($groupList, $userList, $to_already_selected);
         echo "</td>";
         echo "</tr>";
@@ -827,8 +827,8 @@ 
         echo "<select id=\"not_selected_form\" name=\"not_selected_form[]\" size=5 style=\"width:200px\" multiple>";
         $group_users = GroupManager::getStudentsAndTutors($group_id);
         foreach ($group_users as $user) {
-            echo '<option value="' . $user['user_id'] . '" title="' . sprintf(get_lang('LoginX'), $user['username']) . '" >' .
-                api_get_person_name($user['firstname'], $user['lastname']) .
+            echo '<option value="'.$user['user_id'].'" title="'.sprintf(get_lang('LoginX'), $user['username']).'" >'.
+                api_get_person_name($user['firstname'], $user['lastname']).
                 '</option>';
         }
         echo '</select>';
@@ -866,12 +866,12 @@ 
         if (!empty($groupList)) {
             foreach ($groupList as $this_group) {
                 if (is_array($to_already_selected)) {
-                    if (!in_array("GROUP:" . $this_group['id'], $to_already_selected)) {
+                    if (!in_array("GROUP:".$this_group['id'], $to_already_selected)) {
                         // $to_already_selected is the array containing the groups (and users) that are already selected
-                        $user_label = ($this_group['userNb'] > 0) ? get_lang('Users') : get_lang('LowerCaseUser') ;
-                        $user_disabled = ($this_group['userNb'] > 0) ? "" : "disabled=disabled" ;
-                        echo "<option $user_disabled value=\"GROUP:" . $this_group['id'] . "\">",
-                        "G: ", $this_group['name'], " - " . $this_group['userNb'] . " " . $user_label .
+                        $user_label = ($this_group['userNb'] > 0) ? get_lang('Users') : get_lang('LowerCaseUser');
+                        $user_disabled = ($this_group['userNb'] > 0) ? "" : "disabled=disabled";
+                        echo "<option $user_disabled value=\"GROUP:".$this_group['id']."\">",
+                        "G: ", $this_group['name'], " - ".$this_group['userNb']." ".$user_label.
                             "</option>";
                     }
                 }
@@ -885,15 +885,15 @@ 
         if (!empty($userList)) {
             foreach ($userList as $user) {
                 if (is_array($to_already_selected)) {
-                    if (!in_array("USER:" . $user['user_id'], $to_already_selected)) {
+                    if (!in_array("USER:".$user['user_id'], $to_already_selected)) {
                         // $to_already_selected is the array containing the users (and groups) that are already selected
-                        echo "<option value=\"USER:" . $user['user_id'] . "\" title='" . sprintf(get_lang('LoginX'), $user['username']) . "'>",
+                        echo "<option value=\"USER:".$user['user_id']."\" title='".sprintf(get_lang('LoginX'), $user['username'])."'>",
                         "", api_get_person_name($user['firstname'], $user['lastname']),
                         "</option>";
 
                         if (isset($user['drh_list']) && !empty($user['drh_list'])) {
                             foreach ($user['drh_list'] as $drh) {
-                                echo "<option value=\"USER:" . $drh['user_id'] . "\" title='" . sprintf(get_lang('LoginX'), $drh['username']) . "'>&nbsp;&nbsp;&nbsp;&nbsp;",
+                                echo "<option value=\"USER:".$drh['user_id']."\" title='".sprintf(get_lang('LoginX'), $drh['username'])."'>&nbsp;&nbsp;&nbsp;&nbsp;",
                                 "", api_get_person_name($drh['firstname'], $drh['lastname']),
                                 "</option>";
                             }
@@ -925,16 +925,16 @@ 
             foreach ($to_already_selected as $groupuser) {
                 list($type, $id) = explode(":", $groupuser);
                 if ($type == "GROUP") {
-                    echo "<option value=\"" . $groupuser . "\">G: " . $ref_array_groups[$id]['name'] . "</option>";
+                    echo "<option value=\"".$groupuser."\">G: ".$ref_array_groups[$id]['name']."</option>";
                 } else {
                     foreach ($ref_array_users as $key => $value) {
                         if ($value['user_id'] == $id) {
-                            echo "<option value=\"" . $groupuser . "\" title='" . sprintf(get_lang('LoginX'), $value['username']) . "'>" .
-                                api_get_person_name($value['firstname'], $value['lastname']) . "</option>";
+                            echo "<option value=\"".$groupuser."\" title='".sprintf(get_lang('LoginX'), $value['username'])."'>".
+                                api_get_person_name($value['firstname'], $value['lastname'])."</option>";
 
                             if (isset($value['drh_list']) && !empty($value['drh_list'])) {
                                 foreach ($value['drh_list'] as $drh) {
-                                    echo "<option value=\"USER:" . $drh['user_id'] . "\" title='" . sprintf(get_lang('LoginX'), $drh['username']) . "'>&nbsp;&nbsp;&nbsp;&nbsp;",
+                                    echo "<option value=\"USER:".$drh['user_id']."\" title='".sprintf(get_lang('LoginX'), $drh['username'])."'>&nbsp;&nbsp;&nbsp;&nbsp;",
                                     "", api_get_person_name($drh['firstname'], $drh['lastname']),
                                     "</option>";
                                 }
@@ -950,17 +950,17 @@ 
                 if (is_array($ref_array_groups)) {
                     foreach ($ref_array_groups as $this_group) {
                         //api_display_normal_message("group " . $thisGroup[id] . $thisGroup[name]);
-                        if (!is_array($to_already_selected) || !in_array("GROUP:" . $this_group['id'], $to_already_selected)) { // $to_already_selected is the array containing the groups (and users) that are already selected
-                            echo "<option value=\"GROUP:" . $this_group['id'] . "\">",
-                            "G: ", $this_group['name'], " &ndash; " . $this_group['userNb'] . " " . get_lang('Users') .
+                        if (!is_array($to_already_selected) || !in_array("GROUP:".$this_group['id'], $to_already_selected)) { // $to_already_selected is the array containing the groups (and users) that are already selected
+                            echo "<option value=\"GROUP:".$this_group['id']."\">",
+                            "G: ", $this_group['name'], " &ndash; ".$this_group['userNb']." ".get_lang('Users').
                                 "</option>";
                         }
                     }
                 }
                 // adding the individual users to the select form
                 foreach ($ref_array_users as $this_user) {
-                    if (!is_array($to_already_selected) || !in_array("USER:" . $this_user['user_id'], $to_already_selected)) { // $to_already_selected is the array containing the users (and groups) that are already selected
-                        echo "<option value=\"USER:", $this_user['user_id'], "\"  title='" . sprintf(get_lang('LoginX'), $this_user['username']) . "'>",
+                    if (!is_array($to_already_selected) || !in_array("USER:".$this_user['user_id'], $to_already_selected)) { // $to_already_selected is the array containing the users (and groups) that are already selected
+                        echo "<option value=\"USER:", $this_user['user_id'], "\"  title='".sprintf(get_lang('LoginX'), $this_user['username'])."'>",
                         "", api_get_person_name($this_user['firstname'], $this_user['lastname']),
                         "</option>";
                     }
@@ -1073,14 +1073,14 @@ 
             switch ($to_group) {
                 // it was send to one specific user
                 case null:
-                    $to[] = "USER:" . $row['to_user_id'];
+                    $to[] = "USER:".$row['to_user_id'];
                     break;
                 // it was sent to everyone
                 case 0:
                     return "everyone";
                     break;
                 default:
-                    $to[] = "GROUP:" . $row['to_group_id'];
+                    $to[] = "GROUP:".$row['to_group_id'];
             }
         }
         return $to;
@@ -1161,10 +1161,10 @@ 
                 $sent_to_array['groups'][0] !== 0
             ) {
                 $group_id = $sent_to_array['groups'][0];
-                $output[] = "&nbsp;" . $group_names[$group_id]['name'];
+                $output[] = "&nbsp;".$group_names[$group_id]['name'];
             }
             if (empty($sent_to_array['groups']) and empty($sent_to_array['users'])) {
-                $output[] = "&nbsp;" . get_lang('Everybody');
+                $output[] = "&nbsp;".get_lang('Everybody');
             }
         }
 
@@ -1199,7 +1199,7 @@ 
 
         $sql = "SELECT to_group_id, to_user_id
                 FROM $tbl_item_property
-                WHERE c_id = $course_id AND tool = '$tool' AND ref=" . $id;
+                WHERE c_id = $course_id AND tool = '$tool' AND ref=".$id;
         $result = Database::query($sql);
 
         while ($row = Database::fetch_array($result)) {
@@ -1238,8 +1238,8 @@ 
         $announcement_id = intval($announcement_id);
         $course_id = api_get_course_int_id();
         $row = array();
-        $sql = 'SELECT id, path, filename, comment FROM ' . $tbl_announcement_attachment . '
-				WHERE c_id = ' . $course_id . ' AND announcement_id = ' . $announcement_id . '';
+        $sql = 'SELECT id, path, filename, comment FROM '.$tbl_announcement_attachment.'
+				WHERE c_id = ' . $course_id.' AND announcement_id = '.$announcement_id.'';
         $result = Database::query($sql);
         if (Database::num_rows($result) != 0) {
             $row = Database::fetch_array($result, 'ASSOC');
@@ -1264,9 +1264,9 @@ 
 
         if (is_array($file) && $file['error'] == 0) {
             // TODO: This path is obsolete. The new document repository scheme should be kept in mind here.
-            $courseDir = $_course['path'] . '/upload/announcements';
+            $courseDir = $_course['path'].'/upload/announcements';
             $sys_course_path = api_get_path(SYS_COURSE_PATH);
-            $updir = $sys_course_path . $courseDir;
+            $updir = $sys_course_path.$courseDir;
 
             // Try to add an extension to the file if it hasn't one
             $new_file_name = add_ext_on_mime(stripslashes($file['name']), $file['type']);
@@ -1278,7 +1278,7 @@ 
                 Display :: display_error_message(get_lang('UplUnableToSaveFileFilteredExtension'));
             } else {
                 $new_file_name = uniqid('');
-                $new_path = $updir . '/' . $new_file_name;
+                $new_path = $updir.'/'.$new_file_name;
                 move_uploaded_file($file['tmp_name'], $new_path);
 
                 $params = [
@@ -1319,9 +1319,9 @@ 
 
         if (is_array($file) && $file['error'] == 0) {
             // TODO: This path is obsolete. The new document repository scheme should be kept in mind here.
-            $courseDir = $_course['path'] . '/upload/announcements';
+            $courseDir = $_course['path'].'/upload/announcements';
             $sys_course_path = api_get_path(SYS_COURSE_PATH);
-            $updir = $sys_course_path . $courseDir;
+            $updir = $sys_course_path.$courseDir;
 
             // Try to add an extension to the file if it hasn't one
             $new_file_name = add_ext_on_mime(stripslashes($file['name']), $file['type']);
@@ -1333,13 +1333,13 @@ 
                 Display :: display_error_message(get_lang('UplUnableToSaveFileFilteredExtension'));
             } else {
                 $new_file_name = uniqid('');
-                $new_path = $updir . '/' . $new_file_name;
+                $new_path = $updir.'/'.$new_file_name;
                 @move_uploaded_file($file['tmp_name'], $new_path);
                 $safe_file_comment = Database::escape_string($file_comment);
                 $safe_file_name = Database::escape_string($file_name);
                 $safe_new_file_name = Database::escape_string($new_file_name);
                 $id_attach = intval($id_attach);
-                $sql = "UPDATE $tbl_announcement_attachment SET filename = '$safe_file_name', comment = '$safe_file_comment', path = '$safe_new_file_name', size ='" . intval($file['size']) . "'
+                $sql = "UPDATE $tbl_announcement_attachment SET filename = '$safe_file_name', comment = '$safe_file_comment', path = '$safe_new_file_name', size ='".intval($file['size'])."'
 					 	WHERE c_id = $course_id AND id = '$id_attach'";
                 $result = Database::query($sql);
                 if ($result === false) {
@@ -1441,7 +1441,7 @@ 
 
             //if (!empty($user_id)) {
             if (0) {
-                if (is_array($group_memberships) && count($group_memberships) > 0 ) {
+                if (is_array($group_memberships) && count($group_memberships) > 0) {
                     $sql = "SELECT $select
                             FROM $tbl_announcement announcement, $tbl_item_property ip
                             WHERE
@@ -1524,7 +1524,7 @@ 
             }
         } else {
             // STUDENT
-            if (is_array($group_memberships) && count($group_memberships)>0) {
+            if (is_array($group_memberships) && count($group_memberships) > 0) {
                 if ($allowUserEditSetting && !api_is_anonymous()) {
                     if (api_get_group_id() == 0) {
                         // No group
@@ -1651,8 +1651,8 @@ 
                 $attachment_list = AnnouncementManager::get_attachment($myrow['id']);
 
                 $attachment_icon = '';
-                if (count($attachment_list)>0) {
-                    $attachment_icon = ' '.Display::return_icon('attachment.gif',get_lang('Attachment'));
+                if (count($attachment_list) > 0) {
+                    $attachment_icon = ' '.Display::return_icon('attachment.gif', get_lang('Attachment'));
                 }
 
                 /* TITLE */
@@ -1671,16 +1671,16 @@ 
                     || (api_get_course_setting('allow_user_edit_announcement') && !api_is_anonymous())
                 ) {
                     $modify_icons = "<a href=\"".$actionUrl."&action=modify&id=".$myrow['id']."\">".
-                        Display::return_icon('edit.png', get_lang('Edit'),'',ICON_SIZE_SMALL)."</a>";
-                    if ($myrow['visibility']==1) {
-                        $image_visibility="visible";
-                        $alt_visibility=get_lang('Hide');
+                        Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL)."</a>";
+                    if ($myrow['visibility'] == 1) {
+                        $image_visibility = "visible";
+                        $alt_visibility = get_lang('Hide');
                     } else {
-                        $image_visibility="invisible";
-                        $alt_visibility=get_lang('Visible');
+                        $image_visibility = "invisible";
+                        $alt_visibility = get_lang('Visible');
                     }
-                    $modify_icons .=  "<a href=\"".$actionUrl."&origin=".$origin."&action=showhide&id=".$myrow['id']."&sec_token=".$stok."\">".
-                        Display::return_icon($image_visibility.'.png', $alt_visibility,'',ICON_SIZE_SMALL)."</a>";
+                    $modify_icons .= "<a href=\"".$actionUrl."&origin=".$origin."&action=showhide&id=".$myrow['id']."&sec_token=".$stok."\">".
+                        Display::return_icon($image_visibility.'.png', $alt_visibility, '', ICON_SIZE_SMALL)."</a>";
 
                     // DISPLAY MOVE UP COMMAND only if it is not the top announcement
                     if ($iterator != 1) {
@@ -1695,12 +1695,12 @@ 
                     } else {
                         $modify_icons .= Display::return_icon('down_na.gif', get_lang('Down'));
                     }
-                    if (api_is_allowed_to_edit(false,true)) {
-                        $modify_icons .= "<a href=\"".$actionUrl."&action=delete&id=".$myrow['id']."&sec_token=".$stok."\" onclick=\"javascript:if(!confirm('".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'),ENT_QUOTES,api_get_system_encoding()))."')) return false;\">".
-                            Display::return_icon('delete.png', get_lang('Delete'),'',ICON_SIZE_SMALL).
+                    if (api_is_allowed_to_edit(false, true)) {
+                        $modify_icons .= "<a href=\"".$actionUrl."&action=delete&id=".$myrow['id']."&sec_token=".$stok."\" onclick=\"javascript:if(!confirm('".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES, api_get_system_encoding()))."')) return false;\">".
+                            Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).
                             "</a>";
                     }
-                    $iterator ++;
+                    $iterator++;
                 } else {
                     $modify_icons = Display::url(
                         Display::return_icon('default.png'),
@@ -1730,7 +1730,7 @@ 
     public static function getNumberAnnouncements()
     {
         // Maximum title messages to display
-        $maximum 	= '12';
+        $maximum = '12';
         // Database Table Definitions
         $tbl_announcement = Database::get_course_table(TABLE_ANNOUNCEMENT);
         $tbl_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY);
@@ -1741,7 +1741,7 @@ 
         $userId = api_get_user_id();
         $condition_session = api_get_session_condition($session_id, true, true, 'announcement.session_id');
 
-        if (api_is_allowed_to_edit(false,true))  {
+        if (api_is_allowed_to_edit(false, true)) {
             // check teacher status
             if (empty($_GET['origin']) or $_GET['origin'] !== 'learnpath') {
 
@@ -1804,7 +1804,7 @@ 
                 }
 
                 // the user is member of several groups => display personal announcements AND his group announcements AND the general announcements
-                if (is_array($group_memberships) && count($group_memberships)>0) {
+                if (is_array($group_memberships) && count($group_memberships) > 0) {
                     $sql = "SELECT announcement.*, ip.visibility, ip.to_group_id, ip.insert_user_id
                     FROM $tbl_announcement announcement, $tbl_item_property ip
                     WHERE
@@ -1854,7 +1854,7 @@ 
                         }
 
                         // the user is not identiefied => show only the general announcements
-                        $sql="SELECT announcement.*, ip.visibility, ip.to_group_id, ip.insert_user_id
+                        $sql = "SELECT announcement.*, ip.visibility, ip.to_group_id, ip.insert_user_id
                                 FROM $tbl_announcement announcement, $tbl_item_property ip
                                 WHERE
                                     announcement.c_id = $course_id AND

main/inc/lib/app_view.php

Doc Comments +3 added lines

@@ -18,6 +18,7 @@ 
     /**
      * Constructor, init tool path for rendering
      * @param string  tool name (optional)
+     * @param string $template_path
      */
     public function __construct($toolname = '', $template_path=null)
     {
@@ -50,6 +51,7 @@ 
     /**
      * Set layout view sent from a controller
      * @param string layout view
+     * @param string $layout
      */
     public function set_layout( $layout )
     {
@@ -59,6 +61,7 @@ 
     /**
      * Set template view sent from a controller
      * @param string template view
+     * @param string $template
      */
     public function set_template($template)
     {

Spacing +4 added lines, -4 removed lines

@@ -19,7 +19,7 @@ 
      * Constructor, init tool path for rendering
      * @param string  tool name (optional)
      */
-    public function __construct($toolname = '', $template_path=null)
+    public function __construct($toolname = '', $template_path = null)
     {
         if (!empty($toolname)) {
             if (isset($template_path)) {
@@ -30,7 +30,7 @@ 
             if (is_dir($path)) {
                 $this->tool_path = $path;
             } else {
-                throw new ViewException('View::__construct() $path directory does not exist ' . $path);
+                throw new ViewException('View::__construct() $path directory does not exist '.$path);
             }
         }
     }
@@ -42,7 +42,7 @@ 
     public function set_data($data)
     {
         if (!is_array($data)) {
-            throw new ViewException('View::set_data() $data must to be an array, you have sent a' . gettype( $data ));
+            throw new ViewException('View::set_data() $data must to be an array, you have sent a'.gettype($data));
         }
         $this->data = $data;
     }
@@ -51,7 +51,7 @@ 
      * Set layout view sent from a controller
      * @param string layout view
      */
-    public function set_layout( $layout )
+    public function set_layout($layout)
     {
         $this->layout = $layout;
     }

main/inc/lib/browser/Browser.php

Doc Comments +2 added lines, -2 removed lines

@@ -158,7 +158,7 @@ 
 
     /**
      * Set the name of the browser
-     * @param $browser string The name of the Browser
+     * @param string $browser string The name of the Browser
      */
     public function setBrowser($browser)
     {
@@ -266,7 +266,7 @@ 
 
     /**
      * Set the browser to be from AOL
-     * @param $isAol
+     * @param boolean $isAol
      */
     public function setAol($isAol)
     {

Spacing +16 added lines, -16 removed lines

@@ -345,9 +345,9 @@ 
      */
     public function __toString()
     {
-        return "<strong>Browser Name:</strong> {$this->getBrowser()}<br/>\n" .
-        "<strong>Browser Version:</strong> {$this->getVersion()}<br/>\n" .
-        "<strong>Browser User Agent String:</strong> {$this->getUserAgent()}<br/>\n" .
+        return "<strong>Browser Name:</strong> {$this->getBrowser()}<br/>\n".
+        "<strong>Browser Version:</strong> {$this->getVersion()}<br/>\n".
+        "<strong>Browser User Agent String:</strong> {$this->getUserAgent()}<br/>\n".
         "<strong>Platform:</strong> {$this->getPlatform()}<br/>";
     }
 
@@ -585,13 +585,13 @@ 
             $aresult = explode(' ', stristr(str_replace(';', '; ', $this->_agent), 'msie'));
             $this->setBrowser(self::BROWSER_IE);
             $this->setVersion(str_replace(array('(', ')', ';'), '', $aresult[1]));
-            if(stripos($this->_agent, 'IEMobile') !== false) {
+            if (stripos($this->_agent, 'IEMobile') !== false) {
                 $this->setBrowser(self::BROWSER_POCKET_IE);
                 $this->setMobile(true);
             }
             return true;
         } // Test for versions > IE 10
-		else if(stripos($this->_agent, 'trident') !== false) {
+		else if (stripos($this->_agent, 'trident') !== false) {
 			$this->setBrowser(self::BROWSER_IE);
 			$result = explode('rv:', $this->_agent);
 			$this->setVersion(preg_replace('/[^0-9.]+/', '', $result[1]));
@@ -1012,7 +1012,7 @@ 
      */
     protected function checkFacebookExternalHit()
     {
-        if(stristr($this->_agent,'FacebookExternalHit'))
+        if (stristr($this->_agent, 'FacebookExternalHit'))
         {
             $this->setRobot(true);
             $this->setFacebook(true);
@@ -1027,7 +1027,7 @@ 
      */
     protected function checkForFacebookIos()
     {
-        if(stristr($this->_agent,'FBIOS'))
+        if (stristr($this->_agent, 'FBIOS'))
         {
             $this->setFacebook(true);
             return true;
@@ -1041,10 +1041,10 @@ 
      */
     protected function getSafariVersionOnIos() 
     {
-        $aresult = explode('/',stristr($this->_agent,'Version'));
-        if( isset($aresult[1]) ) 
+        $aresult = explode('/', stristr($this->_agent, 'Version'));
+        if (isset($aresult[1])) 
         {
-            $aversion = explode(' ',$aresult[1]);
+            $aversion = explode(' ', $aresult[1]);
             $this->setVersion($aversion[0]);
             return true;
         }
@@ -1057,10 +1057,10 @@ 
      */
     protected function getChromeVersionOnIos() 
     {
-        $aresult = explode('/',stristr($this->_agent,'CriOS'));
-        if( isset($aresult[1]) ) 
+        $aresult = explode('/', stristr($this->_agent, 'CriOS'));
+        if (isset($aresult[1])) 
         {
-            $aversion = explode(' ',$aresult[1]);
+            $aversion = explode(' ', $aresult[1]);
             $this->setVersion($aversion[0]);
             $this->setBrowser(self::BROWSER_CHROME);
             return true;
@@ -1073,7 +1073,7 @@ 
      * @return boolean True if the browser is iPhone otherwise false
      */
     protected function checkBrowseriPhone() {
-        if( stripos($this->_agent,'iPhone') !== false ) {
+        if (stripos($this->_agent, 'iPhone') !== false) {
             $this->setVersion(self::VERSION_UNKNOWN);
             $this->setBrowser(self::BROWSER_IPHONE);
             $this->getSafariVersionOnIos();
@@ -1090,7 +1090,7 @@ 
      * @return boolean True if the browser is iPad otherwise false
      */
     protected function checkBrowseriPad() {
-        if( stripos($this->_agent,'iPad') !== false ) {
+        if (stripos($this->_agent, 'iPad') !== false) {
             $this->setVersion(self::VERSION_UNKNOWN);
             $this->setBrowser(self::BROWSER_IPAD);
             $this->getSafariVersionOnIos();
@@ -1107,7 +1107,7 @@ 
      * @return boolean True if the browser is iPod otherwise false
      */
     protected function checkBrowseriPod() {
-        if( stripos($this->_agent,'iPod') !== false ) {
+        if (stripos($this->_agent, 'iPod') !== false) {
             $this->setVersion(self::VERSION_UNKNOWN);
             $this->setBrowser(self::BROWSER_IPOD);
             $this->getSafariVersionOnIos();

Braces +16 added lines, -32 removed lines

@@ -1152,68 +1152,52 @@
         if (stripos($this->_agent, 'windows') !== false) 
         {
             $this->_platform = self::PLATFORM_WINDOWS;
-        } 
-        else if (stripos($this->_agent, 'iPad') !== false) 
+        } else if (stripos($this->_agent, 'iPad') !== false) 
         {
             $this->_platform = self::PLATFORM_IPAD;
-        } 
-        else if (stripos($this->_agent, 'iPod') !== false) 
+        } else if (stripos($this->_agent, 'iPod') !== false) 
         {
             $this->_platform = self::PLATFORM_IPOD;
-        } 
-        else if (stripos($this->_agent, 'iPhone') !== false) 
+        } else if (stripos($this->_agent, 'iPhone') !== false) 
         {
             $this->_platform = self::PLATFORM_IPHONE;
-        } 
-        elseif (stripos($this->_agent, 'mac') !== false) 
+        } elseif (stripos($this->_agent, 'mac') !== false) 
         {
             $this->_platform = self::PLATFORM_APPLE;
-        } 
-        elseif (stripos($this->_agent, 'android') !== false) 
+        } elseif (stripos($this->_agent, 'android') !== false) 
         {
             $this->_platform = self::PLATFORM_ANDROID;
-        } 
-        elseif (stripos($this->_agent, 'linux') !== false) 
+        } elseif (stripos($this->_agent, 'linux') !== false) 
         {
             $this->_platform = self::PLATFORM_LINUX;
-        } 
-        else if (stripos($this->_agent, 'Nokia') !== false) 
+        } else if (stripos($this->_agent, 'Nokia') !== false) 
         {
             $this->_platform = self::PLATFORM_NOKIA;
-        } 
-        else if (stripos($this->_agent, 'BlackBerry') !== false) 
+        } else if (stripos($this->_agent, 'BlackBerry') !== false) 
         {
             $this->_platform = self::PLATFORM_BLACKBERRY;
-        } 
-        elseif (stripos($this->_agent, 'FreeBSD') !== false) 
+        } elseif (stripos($this->_agent, 'FreeBSD') !== false) 
         {
             $this->_platform = self::PLATFORM_FREEBSD;
-        } 
-        elseif (stripos($this->_agent, 'OpenBSD') !== false) 
+        } elseif (stripos($this->_agent, 'OpenBSD') !== false) 
         {
             $this->_platform = self::PLATFORM_OPENBSD;
-        } 
-        elseif (stripos($this->_agent, 'NetBSD') !== false) 
+        } elseif (stripos($this->_agent, 'NetBSD') !== false) 
         {
             $this->_platform = self::PLATFORM_NETBSD;
-        } 
-        elseif (stripos($this->_agent, 'OpenSolaris') !== false) 
+        } elseif (stripos($this->_agent, 'OpenSolaris') !== false) 
         {
             $this->_platform = self::PLATFORM_OPENSOLARIS;
-        } 
-        elseif (stripos($this->_agent, 'SunOS') !== false) 
+        } elseif (stripos($this->_agent, 'SunOS') !== false) 
         {
             $this->_platform = self::PLATFORM_SUNOS;
-        } 
-        elseif (stripos($this->_agent, 'OS\/2') !== false) 
+        } elseif (stripos($this->_agent, 'OS\/2') !== false) 
         {
             $this->_platform = self::PLATFORM_OS2;
-        } 
-        elseif (stripos($this->_agent, 'BeOS') !== false) 
+        } elseif (stripos($this->_agent, 'BeOS') !== false) 
         {
             $this->_platform = self::PLATFORM_BEOS;
-        } 
-        elseif (stripos($this->_agent, 'win') !== false) 
+        } elseif (stripos($this->_agent, 'win') !== false) 
         {
             $this->_platform = self::PLATFORM_WINDOWS;
         }

Indentation +42 added lines, -42 removed lines

@@ -1,38 +1,38 @@ 
 <?php
 /**
- * File: Browser.php
- * Author: Chris Schuld (http://chrisschuld.com/)
- * Last Modified: August 20th, 2010
- * @version 1.9
- * @package PegasusPHP
- *
- * Copyright (C) 2008-2010 Chris Schuld  (chris@chrisschuld.com)
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of
- * the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details at:
- * http://www.gnu.org/copyleft/gpl.html
- *
- *
- * Typical Usage:
- *
- *   $browser = new Browser();
- *   if( $browser->getBrowser() == Browser::BROWSER_FIREFOX && $browser->getVersion() >= 2 ) {
- *    echo 'You have FireFox version 2 or greater';
- *   }
- *
- * User Agents Sampled from: http://www.useragentstring.com/
- *
- * This implementation is based on the original work from Gary White
- * http://apptools.com/phptools/browser/
- * Git and Packagist info: https://github.com/cbschuld/Browser.php
- */
+     * File: Browser.php
+     * Author: Chris Schuld (http://chrisschuld.com/)
+     * Last Modified: August 20th, 2010
+     * @version 1.9
+     * @package PegasusPHP
+     *
+     * Copyright (C) 2008-2010 Chris Schuld  (chris@chrisschuld.com)
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License as
+     * published by the Free Software Foundation; either version 2 of
+     * the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details at:
+     * http://www.gnu.org/copyleft/gpl.html
+     *
+     *
+     * Typical Usage:
+     *
+     *   $browser = new Browser();
+     *   if( $browser->getBrowser() == Browser::BROWSER_FIREFOX && $browser->getVersion() >= 2 ) {
+     *    echo 'You have FireFox version 2 or greater';
+     *   }
+     *
+     * User Agents Sampled from: http://www.useragentstring.com/
+     *
+     * This implementation is based on the original work from Gary White
+     * http://apptools.com/phptools/browser/
+     * Git and Packagist info: https://github.com/cbschuld/Browser.php
+     */
 
 class Browser
 {
@@ -256,9 +256,9 @@ 
     }
 
     /**
-    * Is the browser from facebook?
-    * @return boolean True if the browser is from facebook otherwise false
-    */
+     * Is the browser from facebook?
+     * @return boolean True if the browser is from facebook otherwise false
+     */
     public function isFacebook() 
     { 
         return $this->_is_facebook;
@@ -591,12 +591,12 @@ 
             }
             return true;
         } // Test for versions > IE 10
-		else if(stripos($this->_agent, 'trident') !== false) {
-			$this->setBrowser(self::BROWSER_IE);
-			$result = explode('rv:', $this->_agent);
-			$this->setVersion(preg_replace('/[^0-9.]+/', '', $result[1]));
-			$this->_agent = str_replace(array("Mozilla", "Gecko"), "MSIE", $this->_agent);
-		} // Test for Pocket IE
+        else if(stripos($this->_agent, 'trident') !== false) {
+            $this->setBrowser(self::BROWSER_IE);
+            $result = explode('rv:', $this->_agent);
+            $this->setVersion(preg_replace('/[^0-9.]+/', '', $result[1]));
+            $this->_agent = str_replace(array("Mozilla", "Gecko"), "MSIE", $this->_agent);
+        } // Test for Pocket IE
         else if (stripos($this->_agent, 'mspie') !== false || stripos($this->_agent, 'pocket') !== false) {
             $aresult = explode(' ', stristr($this->_agent, 'mspie'));
             $this->setPlatform(self::PLATFORM_WINDOWS_CE);

main/inc/lib/chat.lib.php

Doc Comments +2 added lines

@@ -41,6 +41,7 @@ 
     /**
     * Set user chat status
     * @param int 0 if disconnected, 1 if connected
+    * @param integer $status
      *
     * @return void
     */
@@ -164,6 +165,7 @@ 
     /**
      * Saves into session the fact that a chat window exists with the given user
      * @param int The ID of the user with whom the current user is chatting
+     * @param integer $user_id
      * @return void
      */
     public function save_window($user_id)

Spacing +4 added lines, -4 removed lines

@@ -186,7 +186,7 @@ 
         $to_user_id,
         $message,
         $printResult = true,
-        $sanitize =  true
+        $sanitize = true
     )
     {
         $user_friend_relation = SocialManager::get_relation_between_contacts(
@@ -206,7 +206,7 @@ 
                 $messagesan = $message;
             }
 
-            error_log(print_r($sanitize) . '----' . $messagesan);
+            error_log(print_r($sanitize).'----'.$messagesan);
 
             if (!isset($_SESSION['chatHistory'][$to_user_id])) {
                 $_SESSION['chatHistory'][$to_user_id] = array();
@@ -289,9 +289,9 @@ 
      */
     public static function disableChat()
     {
-        if (!empty($_SESSION['disable_chat'])){
+        if (!empty($_SESSION['disable_chat'])) {
             $status = $_SESSION['disable_chat'];
-            if ($status == true){
+            if ($status == true) {
                 $_SESSION['disable_chat'] = null;
                 return true;
             }

Indentation +8 added lines, -8 removed lines

@@ -44,11 +44,11 @@ 
     }
 
     /**
-    * Set user chat status
-    * @param int 0 if disconnected, 1 if connected
+     * Set user chat status
+     * @param int 0 if disconnected, 1 if connected
      *
-    * @return void
-    */
+     * @return void
+     */
     public function setUserStatus($status)
     {
         UserManager::update_extra_field_value(api_get_user_id(), 'user_chat_status', $status);
@@ -149,10 +149,10 @@ 
     }
 
     /**
-    * Returns an array of messages inside a chat session with a specific user
-    * @param int The ID of the user with whom the current user is chatting
-    * @return array Messages list
-    */
+     * Returns an array of messages inside a chat session with a specific user
+     * @param int The ID of the user with whom the current user is chatting
+     * @return array Messages list
+     */
     public function box_session($user_id)
     {
         $items = array();

main/inc/lib/course_description.lib.php

Doc Comments +6 added lines, -6 removed lines

@@ -95,7 +95,7 @@ 
      * Get all data by description and session id,
      * first you must set session_id property with the object CourseDescription
      * @param    int  $description_type Description type
-     * @param   string $course_code Course code (optional)
+     * @param   string $courseId Course code (optional)
      * @param    int $session_id Session id (optional)
      * @return array    List of fields from the descriptions found of the given type
      */
@@ -359,7 +359,7 @@ 
 
     /**
      * Get description titles by default
-     * @return array
+     * @return string[]
      */
     public function get_default_description_title()
     {
@@ -378,7 +378,7 @@ 
 
     /**
      * Get description titles editable by default
-     * @return array
+     * @return boolean[]
      */
     public function get_default_description_title_editable()
     {
@@ -397,7 +397,7 @@ 
 
     /**
      * Get description icons by default
-     * @return array
+     * @return string[]
      */
     public function get_default_description_icon()
     {
@@ -417,7 +417,7 @@ 
 
     /**
      * Get questions by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_question()
     {
@@ -436,7 +436,7 @@ 
 
     /**
      * Get informations by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_information()
     {

Spacing +5 added lines, -5 removed lines

@@ -176,7 +176,7 @@ 
 
         $sql = "SELECT MAX(description_type) as MAX
                 FROM $tbl_course_description
-		        WHERE c_id = $course_id AND session_id='" . $this->session_id . "'";
+		        WHERE c_id = $course_id AND session_id='".$this->session_id."'";
         $rs = Database::query($sql);
         $max = Database::fetch_array($rs);
         $description_type = $max['MAX'] + 1;
@@ -211,7 +211,7 @@ 
             'session_id' => $this->session_id
         ];
 
-        $last_id  = Database::insert($table, $params);
+        $last_id = Database::insert($table, $params);
 
         if ($last_id > 0) {
             $sql = "UPDATE $table SET id = iid WHERE iid = $last_id";
@@ -319,8 +319,8 @@ 
         $sql = "DELETE FROM $tbl_course_description
 			 	WHERE
 			 	    c_id = $course_id AND
-			 	    id = '" . intval($this->id) . "' AND
-			 	    session_id = '" . intval($this->session_id) . "'";
+			 	    id = '".intval($this->id)."' AND
+			 	    session_id = '" . intval($this->session_id)."'";
         $result = Database::query($sql);
         $affected_rows = Database::affected_rows($result);
         if ($this->id > 0) {
@@ -349,7 +349,7 @@ 
         $course_id = api_get_course_int_id();
 
         $sql = "SELECT id FROM $tbl_course_description
-		        WHERE c_id = $course_id AND description_type = '" . intval($description_type) . "'";
+		        WHERE c_id = $course_id AND description_type = '".intval($description_type)."'";
         $rs = Database::query($sql);
         $row = Database::fetch_array($rs);
         $description_id = $row['id'];

main/inc/lib/dashboard.lib.php

Doc Comments +1 added lines

@@ -493,6 +493,7 @@
 	 * This function update extra user blocks data after closing a dashboard block
 	 * @param int 		User id
 	 * @param string	plugin path
+	 * @param integer $user_id
 	 * @return bool
 	 */
 	public static function close_user_block($user_id, $path)

Braces +3 added lines, -1 removed lines

@@ -380,7 +380,9 @@
 					// check if user is allowed to see the block
 					if (method_exists($obj_block, 'is_block_visible_for_user')) {
 						$is_block_visible_for_user = $obj_block->is_block_visible_for_user($user_id);
-						if (!$is_block_visible_for_user) continue;
+						if (!$is_block_visible_for_user) {
+						    continue;
+						}
 					}
 
 					echo '<tr>';

Indentation +255 added lines, -255 removed lines

@@ -249,286 +249,286 @@
         return $affected_rows;
     }
 
-	/**
-	 * Get all plugins path inside dashboard directory
-	 * @return array name plugins directories
-	 */
-	public static function getPossibleDashboardPluginsPath()
+    /**
+     * Get all plugins path inside dashboard directory
+     * @return array name plugins directories
+     */
+    public static function getPossibleDashboardPluginsPath()
     {
-		// get all plugins path inside plugin directory
-		/* We scan the plugin directory. Each folder is a potential plugin. */
-		$possiblePlugins = array();
-		$dashboard_pluginpath = api_get_path(SYS_PLUGIN_PATH).'dashboard/';
-		$handle = @opendir($dashboard_pluginpath);
-		while (false !== ($file = readdir($handle))) {
-			if ($file <> '.' AND $file <> '..' AND is_dir($dashboard_pluginpath.$file)) {
-				$possiblePlugins[] = $file;
-			}
-		}
-		@closedir($handle);
-
-		return $possiblePlugins;
-	}
-
-	/**
-	 * Get all blocks data without plugin directory
-	 * @return array Block data
-	 */
-	public static function get_block_data_without_plugin()
+        // get all plugins path inside plugin directory
+        /* We scan the plugin directory. Each folder is a potential plugin. */
+        $possiblePlugins = array();
+        $dashboard_pluginpath = api_get_path(SYS_PLUGIN_PATH).'dashboard/';
+        $handle = @opendir($dashboard_pluginpath);
+        while (false !== ($file = readdir($handle))) {
+            if ($file <> '.' AND $file <> '..' AND is_dir($dashboard_pluginpath.$file)) {
+                $possiblePlugins[] = $file;
+            }
+        }
+        @closedir($handle);
+
+        return $possiblePlugins;
+    }
+
+    /**
+     * Get all blocks data without plugin directory
+     * @return array Block data
+     */
+    public static function get_block_data_without_plugin()
     {
-		$tbl_block = Database :: get_main_table(TABLE_MAIN_BLOCK);
-		$possibleplugins = self::getPossibleDashboardPluginsPath();
-
-		// We check if plugin exists inside directory for updating active field
-		$sql = "SELECT * FROM $tbl_block";
-		$rs = Database::query($sql);
-		if (Database::num_rows($rs) > 0){
-			while ($row = Database::fetch_array($rs)) {
-				$path = $row['path'];
-				if (!in_array($row['path'],$possibleplugins)) {
-					$active = 0;
-				} else {
-					$active = 1;
-				}
-				// update active
-				$upd = "UPDATE $tbl_block SET active = '$active'
+        $tbl_block = Database :: get_main_table(TABLE_MAIN_BLOCK);
+        $possibleplugins = self::getPossibleDashboardPluginsPath();
+
+        // We check if plugin exists inside directory for updating active field
+        $sql = "SELECT * FROM $tbl_block";
+        $rs = Database::query($sql);
+        if (Database::num_rows($rs) > 0){
+            while ($row = Database::fetch_array($rs)) {
+                $path = $row['path'];
+                if (!in_array($row['path'],$possibleplugins)) {
+                    $active = 0;
+                } else {
+                    $active = 1;
+                }
+                // update active
+                $upd = "UPDATE $tbl_block SET active = '$active'
 				        WHERE path = '".$row['path']."'";
-				Database::query($upd);
-			}
-		}
-
-		// get disabled block data
-		$block_data = array();
-		$sql = "SELECT * FROM $tbl_block WHERE active = 0";
-		$rs_block = Database::query($sql);
-		if (Database::num_rows($rs_block) > 0) {
-			while ($row_block = Database::fetch_array($rs_block)) {
-				$block_data[] = $row_block;
-			}
-		}
-
-		return $block_data;
-
-	}
-
-	/**
-	 * get data about enabled dashboard block (stored insise block table)
-	 * @param  string	plugin path
-	 * @return array 	data
-	 */
-	public static function get_enabled_dashboard_blocks($path = '')
+                Database::query($upd);
+            }
+        }
+
+        // get disabled block data
+        $block_data = array();
+        $sql = "SELECT * FROM $tbl_block WHERE active = 0";
+        $rs_block = Database::query($sql);
+        if (Database::num_rows($rs_block) > 0) {
+            while ($row_block = Database::fetch_array($rs_block)) {
+                $block_data[] = $row_block;
+            }
+        }
+
+        return $block_data;
+
+    }
+
+    /**
+     * get data about enabled dashboard block (stored insise block table)
+     * @param  string	plugin path
+     * @return array 	data
+     */
+    public static function get_enabled_dashboard_blocks($path = '')
     {
-		$tbl_block = Database :: get_main_table(TABLE_MAIN_BLOCK);
-		$condition_path = '';
-		if (!empty($path)) {
-			$path = Database::escape_string($path);
-			$condition_path = ' AND path = "'.$path.'" ';
-		}
-
-		$sql = "SELECT * FROM $tbl_block WHERE active = 1 $condition_path ";
-		$rs  = Database::query($sql);
-		$block_data = array();
-		if (Database::num_rows($rs) > 0) {
-			while ($row = Database::fetch_array($rs)) {
-				$block_data[$row['path']] = $row;
-			}
-		}
-		return $block_data;
-	}
-
-	/**
-	 * display user dashboard list
-	 * @param int  User id
-	 * @return void
-	 */
-	public static function display_user_dashboard_list($user_id)
+        $tbl_block = Database :: get_main_table(TABLE_MAIN_BLOCK);
+        $condition_path = '';
+        if (!empty($path)) {
+            $path = Database::escape_string($path);
+            $condition_path = ' AND path = "'.$path.'" ';
+        }
+
+        $sql = "SELECT * FROM $tbl_block WHERE active = 1 $condition_path ";
+        $rs  = Database::query($sql);
+        $block_data = array();
+        if (Database::num_rows($rs) > 0) {
+            while ($row = Database::fetch_array($rs)) {
+                $block_data[$row['path']] = $row;
+            }
+        }
+        return $block_data;
+    }
+
+    /**
+     * display user dashboard list
+     * @param int  User id
+     * @return void
+     */
+    public static function display_user_dashboard_list($user_id)
     {
-		$enabled_dashboard_plugins = self::get_enabled_dashboard_blocks();
-		$user_block_data = self::get_user_block_data($user_id);
-
-		if (count($enabled_dashboard_plugins) > 0) {
-			echo '<div style="margin-top:20px">';
-			echo '<div><strong>'.get_lang('SelectBlockForDisplayingInsideBlocksDashboardView').'</strong></div><br />';
-			echo '<form name="dashboard_list" method="post" action="index.php?action=store_user_block">';
-			echo '<table class="data_table">';
-			echo '<tr>';
-			echo '<th width="5%">';
-			echo get_lang('Enabled');
-			echo '</th>';
-			echo '<th width="30%">';
-			echo get_lang('Name');
-			echo '</th>';
-			echo '<th width="40%">';
-			echo get_lang('Description');
-			echo '</th>';
-			echo '<th>';
-			echo get_lang('ColumnPosition');
-			echo '</th>';
-			echo '</tr>';
-
-			// We display all enabled plugins and the checkboxes
-			foreach ($enabled_dashboard_plugins as $block) {
-
-				$path = $block['path'];
-				$controller_class = $block['controller'];
-				$filename_controller = $path.'.class.php';
-				$dashboard_plugin_path = api_get_path(SYS_PLUGIN_PATH).'dashboard/'.$path.'/';
-				require_once $dashboard_plugin_path.$filename_controller;
-				if (class_exists($controller_class)) {
-					$obj_block = new $controller_class($user_id);
-
-					// check if user is allowed to see the block
-					if (method_exists($obj_block, 'is_block_visible_for_user')) {
-						$is_block_visible_for_user = $obj_block->is_block_visible_for_user($user_id);
-						if (!$is_block_visible_for_user) continue;
-					}
-
-					echo '<tr>';
-					// checkboxes
-					self::display_user_dashboard_list_checkboxes($user_id, $block['id']);
-					echo '<td>'.$block['name'].'</td>';
-					echo '<td>'.$block['description'].'</td>';
-					echo '<td>
+        $enabled_dashboard_plugins = self::get_enabled_dashboard_blocks();
+        $user_block_data = self::get_user_block_data($user_id);
+
+        if (count($enabled_dashboard_plugins) > 0) {
+            echo '<div style="margin-top:20px">';
+            echo '<div><strong>'.get_lang('SelectBlockForDisplayingInsideBlocksDashboardView').'</strong></div><br />';
+            echo '<form name="dashboard_list" method="post" action="index.php?action=store_user_block">';
+            echo '<table class="data_table">';
+            echo '<tr>';
+            echo '<th width="5%">';
+            echo get_lang('Enabled');
+            echo '</th>';
+            echo '<th width="30%">';
+            echo get_lang('Name');
+            echo '</th>';
+            echo '<th width="40%">';
+            echo get_lang('Description');
+            echo '</th>';
+            echo '<th>';
+            echo get_lang('ColumnPosition');
+            echo '</th>';
+            echo '</tr>';
+
+            // We display all enabled plugins and the checkboxes
+            foreach ($enabled_dashboard_plugins as $block) {
+
+                $path = $block['path'];
+                $controller_class = $block['controller'];
+                $filename_controller = $path.'.class.php';
+                $dashboard_plugin_path = api_get_path(SYS_PLUGIN_PATH).'dashboard/'.$path.'/';
+                require_once $dashboard_plugin_path.$filename_controller;
+                if (class_exists($controller_class)) {
+                    $obj_block = new $controller_class($user_id);
+
+                    // check if user is allowed to see the block
+                    if (method_exists($obj_block, 'is_block_visible_for_user')) {
+                        $is_block_visible_for_user = $obj_block->is_block_visible_for_user($user_id);
+                        if (!$is_block_visible_for_user) continue;
+                    }
+
+                    echo '<tr>';
+                    // checkboxes
+                    self::display_user_dashboard_list_checkboxes($user_id, $block['id']);
+                    echo '<td>'.$block['name'].'</td>';
+                    echo '<td>'.$block['description'].'</td>';
+                    echo '<td>
                             <select class="selectpicker show-tick form-control" name="columns['.$block['id'].']">
                             <option value="1" '.(isset($user_block_data[$block['id']]) && $user_block_data[$block['id']]['column']==1?'selected':'').' >1</option>
                             <option value="2" '.(isset($user_block_data[$block['id']]) && $user_block_data[$block['id']]['column']==2?'selected':'').' >2</option>
                             </select>
                           </td>';
-					echo '</tr>';
-				} else {
-					echo Display::tag('tr',  Display::tag('td', get_lang('Error').' '.$controller_class, array('colspan'=>'3')));
-				}
-			}
-
-			echo '</table>';
-			echo '<div class="row"><div class="col-md-12">';
-			echo '<button class="btn btn-default" type="submit" name="submit_dashboard_list" value="'.get_lang('EnableDashboardBlock').'"><em class="fa fa-check-square"></em> '.
+                    echo '</tr>';
+                } else {
+                    echo Display::tag('tr',  Display::tag('td', get_lang('Error').' '.$controller_class, array('colspan'=>'3')));
+                }
+            }
+
+            echo '</table>';
+            echo '<div class="row"><div class="col-md-12">';
+            echo '<button class="btn btn-default" type="submit" name="submit_dashboard_list" value="'.get_lang('EnableDashboardBlock').'"><em class="fa fa-check-square"></em> '.
                 get_lang('EnableDashboardBlock').'</button></form>';
-			echo '</div></div>';
-		} else {
-			echo '<div style="margin-top:20px">'.get_lang('ThereAreNoEnabledDashboardPlugins').'</div>';
-			if (api_is_platform_admin()) {
-				echo '<a class="btn btn-default" href="'.api_get_path(WEB_CODE_PATH).'admin/settings.php?category=Plugins">'.
+            echo '</div></div>';
+        } else {
+            echo '<div style="margin-top:20px">'.get_lang('ThereAreNoEnabledDashboardPlugins').'</div>';
+            if (api_is_platform_admin()) {
+                echo '<a class="btn btn-default" href="'.api_get_path(WEB_CODE_PATH).'admin/settings.php?category=Plugins">'.
                     get_lang('ConfigureDashboardPlugin').'</a>';
-			}
-		}
-	}
-
-	/**
-	 * display checkboxes for user dashboard list
-	 * @param int 	User id
-	 * @param int	Block id
-	 * @return void
-	 */
-	public static function display_user_dashboard_list_checkboxes($user_id, $block_id) {
-
-		$user_id = intval($user_id);
-		$user_block_data = self::get_user_block_data($user_id);
-		$enabled_blocks_id = array_keys($user_block_data);
-
-		$checked = '';
-		if (in_array($block_id, $enabled_blocks_id)) {
-			$checked = "checked";
-		}
-
-		echo "<td align=\"center\">";
-		echo '<input type="checkbox" name="enabled_blocks['.$block_id.']" value="true" '.$checked.'/>';
-		echo "</td>";
-	}
-
-	/**
-	 * This function store enabled blocks id with its column position (block_id1:colum;block_id2:colum; ...) inside extra user fields
-	 * @param int User id
-	 * @param array selected blocks
-	 * @param array columns position
-	 * @return bool
-	 */
-	public static function store_user_blocks($user_id, $enabled_blocks, $columns) {
-		$selected_blocks_id  = array();
-		if (is_array($enabled_blocks) && count($enabled_blocks) > 0) {
-			$selected_blocks_id = array_keys($enabled_blocks);
-		}
-
-		// build data for storing inside extra user field
-		$fname = 'dashboard';
-		$fvalue = array();
-		foreach ($selected_blocks_id as $block_id) {
-			$fvalue[] = $block_id.':'.$columns[$block_id];
-		}
+            }
+        }
+    }
+
+    /**
+     * display checkboxes for user dashboard list
+     * @param int 	User id
+     * @param int	Block id
+     * @return void
+     */
+    public static function display_user_dashboard_list_checkboxes($user_id, $block_id) {
+
+        $user_id = intval($user_id);
+        $user_block_data = self::get_user_block_data($user_id);
+        $enabled_blocks_id = array_keys($user_block_data);
+
+        $checked = '';
+        if (in_array($block_id, $enabled_blocks_id)) {
+            $checked = "checked";
+        }
+
+        echo "<td align=\"center\">";
+        echo '<input type="checkbox" name="enabled_blocks['.$block_id.']" value="true" '.$checked.'/>';
+        echo "</td>";
+    }
+
+    /**
+     * This function store enabled blocks id with its column position (block_id1:colum;block_id2:colum; ...) inside extra user fields
+     * @param int User id
+     * @param array selected blocks
+     * @param array columns position
+     * @return bool
+     */
+    public static function store_user_blocks($user_id, $enabled_blocks, $columns) {
+        $selected_blocks_id  = array();
+        if (is_array($enabled_blocks) && count($enabled_blocks) > 0) {
+            $selected_blocks_id = array_keys($enabled_blocks);
+        }
+
+        // build data for storing inside extra user field
+        $fname = 'dashboard';
+        $fvalue = array();
+        foreach ($selected_blocks_id as $block_id) {
+            $fvalue[] = $block_id.':'.$columns[$block_id];
+        }
         $upd_extra_field = UserManager::update_extra_field_value(
             $user_id,
             $fname,
             $fvalue
         );
 
-		return $upd_extra_field;
+        return $upd_extra_field;
 
-	}
+    }
 
-	/**
-	 * This function get user block data (block id with its number of column) from extra user data
-	 * @param int  		User id
-	 * @return array  	data (block_id,column)
-	 */
-	public static function get_user_block_data($user_id)
+    /**
+     * This function get user block data (block id with its number of column) from extra user data
+     * @param int  		User id
+     * @return array  	data (block_id,column)
+     */
+    public static function get_user_block_data($user_id)
     {
-		$user_id = intval($user_id);
-		$field_variable = 'dashboard';
-		$extra_user_data = UserManager::get_extra_user_data_by_field($user_id, $field_variable);
+        $user_id = intval($user_id);
+        $field_variable = 'dashboard';
+        $extra_user_data = UserManager::get_extra_user_data_by_field($user_id, $field_variable);
 
-		if (isset($extra_user_data[$field_variable])) {
+        if (isset($extra_user_data[$field_variable])) {
             $extra_user_data = explode(';', $extra_user_data[$field_variable]);
         }
 
-		$data = array();
-		foreach ($extra_user_data as $extra) {
-			$split_extra = explode(':',$extra);
-			if (!empty($split_extra)) {
-				$block_id = $split_extra[0];
-				$column = isset($split_extra[1]) ? $split_extra[1] : null;
-				$data[$block_id] = array('block_id' => $block_id, 'column' => $column);
-			}
-		}
-
-		return $data;
-	}
-
-	/**
-	 * This function update extra user blocks data after closing a dashboard block
-	 * @param int 		User id
-	 * @param string	plugin path
-	 * @return bool
-	 */
-	public static function close_user_block($user_id, $path)
+        $data = array();
+        foreach ($extra_user_data as $extra) {
+            $split_extra = explode(':',$extra);
+            if (!empty($split_extra)) {
+                $block_id = $split_extra[0];
+                $column = isset($split_extra[1]) ? $split_extra[1] : null;
+                $data[$block_id] = array('block_id' => $block_id, 'column' => $column);
+            }
+        }
+
+        return $data;
+    }
+
+    /**
+     * This function update extra user blocks data after closing a dashboard block
+     * @param int 		User id
+     * @param string	plugin path
+     * @return bool
+     */
+    public static function close_user_block($user_id, $path)
     {
-		$enabled_dashboard_blocks = self::get_enabled_dashboard_blocks($path);
-		$user_block_data = self::get_user_block_data($user_id);
-
-		foreach ($enabled_dashboard_blocks as $enabled_block) {
-			unset($user_block_data[$enabled_block['id']]);
-		}
-
-		// get columns and blocks id for updating extra user data
-		$columns = array();
-		$user_blocks_id = array();
-		foreach ($user_block_data as $data) {
-			$user_blocks_id[$data['block_id']] = true;
-			$columns[$data['block_id']] = $data['column'];
-		}
-
-		// update extra user blocks data
-		$upd_extra_field = self::store_user_blocks($user_id, $user_blocks_id, $columns);
-
-		return $upd_extra_field;
-	}
-
-	/**
-	 * get links for styles from dashboard plugins
-	 * @return string   links
-	 */
-	public static function get_links_for_styles_from_dashboard_plugins() {
-
-		return '<link rel="stylesheet" href="'.api_get_path(WEB_PLUGIN_PATH).'dashboard/css/default.css" type="text/css" />'.PHP_EOL;
-	}
+        $enabled_dashboard_blocks = self::get_enabled_dashboard_blocks($path);
+        $user_block_data = self::get_user_block_data($user_id);
+
+        foreach ($enabled_dashboard_blocks as $enabled_block) {
+            unset($user_block_data[$enabled_block['id']]);
+        }
+
+        // get columns and blocks id for updating extra user data
+        $columns = array();
+        $user_blocks_id = array();
+        foreach ($user_block_data as $data) {
+            $user_blocks_id[$data['block_id']] = true;
+            $columns[$data['block_id']] = $data['column'];
+        }
+
+        // update extra user blocks data
+        $upd_extra_field = self::store_user_blocks($user_id, $user_blocks_id, $columns);
+
+        return $upd_extra_field;
+    }
+
+    /**
+     * get links for styles from dashboard plugins
+     * @return string   links
+     */
+    public static function get_links_for_styles_from_dashboard_plugins() {
+
+        return '<link rel="stylesheet" href="'.api_get_path(WEB_PLUGIN_PATH).'dashboard/css/default.css" type="text/css" />'.PHP_EOL;
+    }
 
 }

Spacing +12 added lines, -12 removed lines

@@ -52,7 +52,7 @@ 
 
                 echo '<tr>';
                 self::display_dashboard_plugin_checkboxes($testplugin);
-                for ($i = 0 ; $i < count($table_cols); $i++) {
+                for ($i = 0; $i < count($table_cols); $i++) {
                     if (isset($plugin_info[strtolower($table_cols[$i])])) {
                         echo '<td>';
                         echo $plugin_info[$table_cols[$i]];
@@ -67,7 +67,7 @@ 
                     echo Display::tag(
                         'tr',
                         Display::tag('td',
-                            get_lang('CheckFilePermissions') . ' ' . Security::remove_XSS($plugin_info_file),
+                            get_lang('CheckFilePermissions').' '.Security::remove_XSS($plugin_info_file),
                             array('colspan' => '3'))
                     );
                 }
@@ -79,7 +79,7 @@ 
             foreach ($disabled_blocks_data as $disabled_block) {
                 echo '<tr style="background-color:#eee">';
                 echo '<td><center><input type="checkbox" name="disabled_block" value="true" checked disabled /></center>';
-                for ($j = 0 ; $j < count($table_cols); $j++) {
+                for ($j = 0; $j < count($table_cols); $j++) {
                     if (isset($disabled_block[strtolower($table_cols[$j])])) {
                         if ($j == 2) {
                             echo '<td>';
@@ -189,10 +189,10 @@ 
             }
             // clean from block data
             if (!empty($not_selected_blocks_id)) {
-                $sql_check = "SELECT id FROM $tbl_block WHERE id IN(".implode(',',$not_selected_blocks_id).")";
+                $sql_check = "SELECT id FROM $tbl_block WHERE id IN(".implode(',', $not_selected_blocks_id).")";
                 $rs_check = Database::query($sql_check);
                 if (Database::num_rows($rs_check) > 0) {
-                    $del = "DELETE FROM $tbl_block WHERE id IN(".implode(',',$not_selected_blocks_id).")";
+                    $del = "DELETE FROM $tbl_block WHERE id IN(".implode(',', $not_selected_blocks_id).")";
                     Database::query($del);
                 }
             }
@@ -212,7 +212,7 @@ 
                         $affected_rows = Database::affected_rows($result);
                     } else {
                         // insert
-                        $plugin_info_file = $dashboard_pluginpath . $testplugin . "/$testplugin.info";
+                        $plugin_info_file = $dashboard_pluginpath.$testplugin."/$testplugin.info";
                         $plugin_info = array();
                         if (file_exists($plugin_info_file)) {
                             $plugin_info = parse_info_file($plugin_info_file);
@@ -282,10 +282,10 @@ 
 		// We check if plugin exists inside directory for updating active field
 		$sql = "SELECT * FROM $tbl_block";
 		$rs = Database::query($sql);
-		if (Database::num_rows($rs) > 0){
+		if (Database::num_rows($rs) > 0) {
 			while ($row = Database::fetch_array($rs)) {
 				$path = $row['path'];
-				if (!in_array($row['path'],$possibleplugins)) {
+				if (!in_array($row['path'], $possibleplugins)) {
 					$active = 0;
 				} else {
 					$active = 1;
@@ -390,13 +390,13 @@ 
 					echo '<td>'.$block['description'].'</td>';
 					echo '<td>
                             <select class="selectpicker show-tick form-control" name="columns['.$block['id'].']">
-                            <option value="1" '.(isset($user_block_data[$block['id']]) && $user_block_data[$block['id']]['column']==1?'selected':'').' >1</option>
-                            <option value="2" '.(isset($user_block_data[$block['id']]) && $user_block_data[$block['id']]['column']==2?'selected':'').' >2</option>
+                            <option value="1" '.(isset($user_block_data[$block['id']]) && $user_block_data[$block['id']]['column'] == 1 ? 'selected' : '').' >1</option>
+                            <option value="2" '.(isset($user_block_data[$block['id']]) && $user_block_data[$block['id']]['column'] == 2 ? 'selected' : '').' >2</option>
                             </select>
                           </td>';
 					echo '</tr>';
 				} else {
-					echo Display::tag('tr',  Display::tag('td', get_lang('Error').' '.$controller_class, array('colspan'=>'3')));
+					echo Display::tag('tr', Display::tag('td', get_lang('Error').' '.$controller_class, array('colspan'=>'3')));
 				}
 			}
 
@@ -482,7 +482,7 @@ 
 
 		$data = array();
 		foreach ($extra_user_data as $extra) {
-			$split_extra = explode(':',$extra);
+			$split_extra = explode(':', $extra);
 			if (!empty($split_extra)) {
 				$block_id = $split_extra[0];
 				$column = isset($split_extra[1]) ? $split_extra[1] : null;

main/inc/lib/database.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -66,7 +66,7 @@ 
      *
      * @param string $table
      *
-     * @return mixed
+     * @return string
      */
     public static function get_main_table($table)
     {
@@ -265,7 +265,7 @@ 
 
     /**
      * Frees all the memory associated with the provided result identifier.
-     * @return bool     Returns TRUE on success or FALSE on failure.
+     * @return boolean|null     Returns TRUE on success or FALSE on failure.
      * Notes: Use this method if you are concerned about how much memory is being used for queries that return large result sets.
      * Anyway, all associated result memory is automatically freed at the end of the script's execution.
      */
@@ -381,7 +381,7 @@ 
      * @param array     $attributes
      * @param bool      $show_query
      *
-     * @return bool|int
+     * @return false|string
      */
     public static function insert($table_name, $attributes, $show_query = false)
     {

Spacing +18 added lines, -19 removed lines

@@ -115,8 +115,7 @@ 
      */
     public static function getUTCDateTimeTypeClass()
     {
-        return isset(self::$utcDateTimeClass) ? self::$utcDateTimeClass :
-        'Application\DoctrineExtensions\DBAL\Types\UTCDateTimeType';
+        return isset(self::$utcDateTimeClass) ? self::$utcDateTimeClass : 'Application\DoctrineExtensions\DBAL\Types\UTCDateTimeType';
     }
 
     /**
@@ -393,7 +392,7 @@ 
 
         if (!empty($params)) {
             $sql = 'INSERT INTO '.$table_name.' ('.implode(',', $params).')
-                    VALUES (:'.implode(', :' ,$params).')';
+                    VALUES (:'.implode(', :', $params).')';
 
             $statement = self::getManager()->getConnection()->prepare($sql);
             $result = $statement->execute($attributes);
@@ -434,7 +433,7 @@ 
             foreach ($attributes as $key => $value) {
                 $update_sql .= "$key = :$key ";
                 if ($count < count($attributes)) {
-                    $update_sql.=', ';
+                    $update_sql .= ', ';
                 }
                 $count++;
             }
@@ -481,7 +480,7 @@ 
             if ($columns == '*') {
                 $clean_columns = '*';
             } else {
-                $clean_columns = (string)$columns;
+                $clean_columns = (string) $columns;
             }
         }
 
@@ -527,9 +526,9 @@ 
                     foreach ($condition_data as $condition => $value_array) {
                         if (is_array($value_array)) {
                             $clean_values = array();
-                            foreach($value_array as $item) {
+                            foreach ($value_array as $item) {
                                 $item = Database::escape_string($item);
-                                $clean_values[]= $item;
+                                $clean_values[] = $item;
                             }
                         } else {
                             $value_array = Database::escape_string($value_array);
@@ -537,23 +536,23 @@ 
                         }
 
                         if (!empty($condition) && $clean_values != '') {
-                            $condition = str_replace('%',"'@percentage@'", $condition); //replace "%"
-                            $condition = str_replace("'?'","%s", $condition);
-                            $condition = str_replace("?","%s", $condition);
+                            $condition = str_replace('%', "'@percentage@'", $condition); //replace "%"
+                            $condition = str_replace("'?'", "%s", $condition);
+                            $condition = str_replace("?", "%s", $condition);
 
-                            $condition = str_replace("@%s@","@-@", $condition);
-                            $condition = str_replace("%s","'%s'", $condition);
-                            $condition = str_replace("@-@","@%s@", $condition);
+                            $condition = str_replace("@%s@", "@-@", $condition);
+                            $condition = str_replace("%s", "'%s'", $condition);
+                            $condition = str_replace("@-@", "@%s@", $condition);
 
                             // Treat conditions as string
                             $condition = vsprintf($condition, $clean_values);
-                            $condition = str_replace('@percentage@','%', $condition); //replace "%"
+                            $condition = str_replace('@percentage@', '%', $condition); //replace "%"
                             $where_return .= $condition;
                         }
                     }
 
                     if (!empty($where_return)) {
-                        $return_value = " WHERE $where_return" ;
+                        $return_value = " WHERE $where_return";
                     }
                     break;
                 case 'order':
@@ -565,7 +564,7 @@ 
                         $new_order_array = explode(',', $order_array);
                         $temp_value = array();
 
-                        foreach($new_order_array as $element) {
+                        foreach ($new_order_array as $element) {
                             $element = explode(' ', $element);
                             $element = array_filter($element);
                             $element = array_values($element);
@@ -576,10 +575,10 @@ 
                                 if (in_array($element[1], array('desc', 'asc'))) {
                                     $order = $element[1];
                                 }
-                                $temp_value[]= $element[0].' '.$order.' ';
+                                $temp_value[] = $element[0].' '.$order.' ';
                             } else {
                                 //by default DESC
-                                $temp_value[]= $element[0].' DESC ';
+                                $temp_value[] = $element[0].' DESC ';
                             }
                         }
                         if (!empty($temp_value)) {
@@ -594,7 +593,7 @@ 
                     if (!empty($limit_array)) {
                         if (count($limit_array) > 1) {
                             $return_value .= ' LIMIT '.intval($limit_array[0]).' , '.intval($limit_array[1]);
-                        }  else {
+                        } else {
                             $return_value .= ' LIMIT '.intval($limit_array[0]);
                         }
                     }

Braces +1 added lines, -1 removed lines

@@ -594,7 +594,7 @@
                     if (!empty($limit_array)) {
                         if (count($limit_array) > 1) {
                             $return_value .= ' LIMIT '.intval($limit_array[0]).' , '.intval($limit_array[1]);
-                        }  else {
+                        } else {
                             $return_value .= ' LIMIT '.intval($limit_array[0]);
                         }
                     }

main/inc/lib/diagnoser.lib.php

Doc Comments +6 added lines

@@ -351,6 +351,12 @@
 
     /**
      * Additional functions needed for fast integration
+     * @param integer $status
+     * @param string $section
+     * @param string $title
+     * @param string $url
+     * @param string|null $formatter
+     * @param string $comment
      */
     public function build_setting($status, $section, $title, $url, $current_value, $expected_value, $formatter, $comment, $img_path = null) {
         switch ($status) {

Indentation +13 added lines, -13 removed lines

@@ -401,19 +401,19 @@
 
     public function format_yes_no_optional($value)
     {
-    	$return = '';
-    	switch($value) {
-     		case 0:
-     			$return = get_lang('No');
-     			break;
-     		case 1:
-     			$return = get_lang('Yes');
-     			break;
-			case 2:
-				$return = get_lang('Optional');
-				break;
-    	}
-    	return $return;
+        $return = '';
+        switch($value) {
+                case 0:
+                 $return = get_lang('No');
+                    break;
+                case 1:
+                 $return = get_lang('Yes');
+                    break;
+            case 2:
+                $return = get_lang('Optional');
+                break;
+        }
+        return $return;
 
     }
 

Braces +13 added lines, -9 removed lines

@@ -158,8 +158,9 @@ 
         $array[] = $this->build_setting($status, '[INI]', 'display_errors', 'http://www.php.net/manual/en/ini.core.php#ini.display_errors', $setting, $req_setting, 'on_off', get_lang('DisplayErrorsInfo'));
 
         $setting = ini_get('default_charset');
-        if ($setting == '')
-            $setting = null;
+        if ($setting == '') {
+                    $setting = null;
+        }
         $req_setting = null;
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_ERROR;
         $array[] = $this->build_setting($status, '[INI]', 'default_charset', 'http://www.php.net/manual/en/ini.core.php#ini.default-charset', $setting, $req_setting, null, get_lang('DefaultCharsetInfo'));
@@ -177,22 +178,25 @@ 
         $setting = ini_get('memory_limit');
         $req_setting = '>= '.REQUIRED_MIN_MEMORY_LIMIT.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_MEMORY_LIMIT)
-            $status = self :: STATUS_OK;
+        if ((float)$setting >= REQUIRED_MIN_MEMORY_LIMIT) {
+                    $status = self :: STATUS_OK;
+        }
         $array[] = $this->build_setting($status, '[INI]', 'memory_limit', 'http://www.php.net/manual/en/ini.core.php#ini.memory-limit', $setting, $req_setting, null, get_lang('MemoryLimitInfo'));
 
         $setting = ini_get('post_max_size');
         $req_setting = '>= '.REQUIRED_MIN_POST_MAX_SIZE.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_POST_MAX_SIZE)
-            $status = self :: STATUS_OK;
+        if ((float)$setting >= REQUIRED_MIN_POST_MAX_SIZE) {
+                    $status = self :: STATUS_OK;
+        }
         $array[] = $this->build_setting($status, '[INI]', 'post_max_size', 'http://www.php.net/manual/en/ini.core.php#ini.post-max-size', $setting, $req_setting, null, get_lang('PostMaxSizeInfo'));
 
         $setting = ini_get('upload_max_filesize');
         $req_setting = '>= '.REQUIRED_MIN_UPLOAD_MAX_FILESIZE.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE)
-            $status = self :: STATUS_OK;
+        if ((float)$setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE) {
+                    $status = self :: STATUS_OK;
+        }
         $array[] = $this->build_setting($status, '[INI]', 'upload_max_filesize', 'http://www.php.net/manual/en/ini.core.php#ini.upload_max_filesize', $setting, $req_setting, null, get_lang('UploadMaxFilesizeInfo'));
 
         $setting = ini_get('variables_order');
@@ -205,7 +209,7 @@ 
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[SESSION]', 'session.gc_maxlifetime', 'http://www.php.net/manual/en/ini.core.php#session.gc-maxlifetime', $setting, $req_setting, null, get_lang('SessionGCMaxLifetimeInfo'));
 
-        if (api_check_browscap()){$setting = true;}else{$setting=false;}
+        if (api_check_browscap()){$setting = true;} else{$setting=false;}
         $req_setting = true;
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[INI]', 'browscap', 'http://www.php.net/manual/en/misc.configuration.php#ini.browscap', $setting, $req_setting, 'on_off', get_lang('BrowscapInfo'));

Spacing +27 added lines, -27 removed lines

@@ -15,7 +15,7 @@ 
 {
     const STATUS_OK = 1;
     const STATUS_WARNING = 2;
-    const STATUS_ERROR 	= 3;
+    const STATUS_ERROR = 3;
     const STATUS_INFORMATION = 4;
 
     /**
@@ -44,21 +44,21 @@ 
                 $html .= '<li>';
             }
             $params['section'] = $section;
-            $html .='<a href="system_status.php?section='.$section.'">'.get_lang($section).'</a></li>';
+            $html .= '<a href="system_status.php?section='.$section.'">'.get_lang($section).'</a></li>';
         }
 
         $html .= '</ul><div class="tab-pane">';
 
-        $data = call_user_func(array($this, 'get_' . $current_section . '_data'));
+        $data = call_user_func(array($this, 'get_'.$current_section.'_data'));
         echo $html;
         $table = new SortableTableFromArray($data, 1, 100);
 
-        $table->set_header(0,'', false);
-        $table->set_header(1,get_lang('Section'), false);
-        $table->set_header(2,get_lang('Setting'), false);
-        $table->set_header(3,get_lang('Current'), false);
-        $table->set_header(4,get_lang('Expected'), false);
-        $table->set_header(5,get_lang('Comment'), false);
+        $table->set_header(0, '', false);
+        $table->set_header(1, get_lang('Section'), false);
+        $table->set_header(2, get_lang('Setting'), false);
+        $table->set_header(3, get_lang('Current'), false);
+        $table->set_header(4, get_lang('Expected'), false);
+        $table->set_header(5, get_lang('Comment'), false);
 
         $table->display();
         echo '</div></div>';
@@ -72,11 +72,11 @@ 
     {
         $array = array();
         $writable_folders = array(
-            api_get_path(SYS_APP_PATH) .'cache',
+            api_get_path(SYS_APP_PATH).'cache',
             api_get_path(SYS_COURSE_PATH),
-            api_get_path(SYS_APP_PATH) .'home',
-            api_get_path(SYS_APP_PATH) .'upload/users/',
-            api_get_path(SYS_PATH) .'main/default_course_document/images/',
+            api_get_path(SYS_APP_PATH).'home',
+            api_get_path(SYS_APP_PATH).'upload/users/',
+            api_get_path(SYS_PATH).'main/default_course_document/images/',
         );
         foreach ($writable_folders as $index => $folder) {
             $writable = is_writable($folder);
@@ -95,10 +95,10 @@ 
 
         $exists = file_exists(api_get_path(SYS_CODE_PATH).'install');
         $status = $exists ? self :: STATUS_WARNING : self :: STATUS_OK;
-        $array[] = $this->build_setting($status, '[FILES]', get_lang('DirectoryExists') . ': /install', 'http://be2.php.net/file_exists', $exists, 0, 'yes_no', get_lang('DirectoryShouldBeRemoved'));
+        $array[] = $this->build_setting($status, '[FILES]', get_lang('DirectoryExists').': /install', 'http://be2.php.net/file_exists', $exists, 0, 'yes_no', get_lang('DirectoryShouldBeRemoved'));
 
         $app_version = api_get_setting('chamilo_database_version');
-        $array[] = $this->build_setting(self :: STATUS_INFORMATION, '[DB]', 'chamilo_database_version', '#', $app_version, 0, null,  'Chamilo DB version');
+        $array[] = $this->build_setting(self :: STATUS_INFORMATION, '[DB]', 'chamilo_database_version', '#', $app_version, 0, null, 'Chamilo DB version');
 
         return $array;
     }
@@ -165,33 +165,33 @@ 
         $array[] = $this->build_setting($status, '[INI]', 'default_charset', 'http://www.php.net/manual/en/ini.core.php#ini.default-charset', $setting, $req_setting, null, get_lang('DefaultCharsetInfo'));
 
         $setting = ini_get('max_execution_time');
-        $req_setting = '300 (' . get_lang('Minimum') . ')';
+        $req_setting = '300 ('.get_lang('Minimum').')';
         $status = $setting >= 300 ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[INI]', 'max_execution_time', 'http://www.php.net/manual/en/ini.core.php#ini.max-execution-time', $setting, $req_setting, null, get_lang('MaxExecutionTimeInfo'));
 
         $setting = ini_get('max_input_time');
-        $req_setting = '300 (' . get_lang('Minimum') . ')';
+        $req_setting = '300 ('.get_lang('Minimum').')';
         $status = $setting >= 300 ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[INI]', 'max_input_time', 'http://www.php.net/manual/en/ini.core.php#ini.max-input-time', $setting, $req_setting, null, get_lang('MaxInputTimeInfo'));
 
         $setting = ini_get('memory_limit');
         $req_setting = '>= '.REQUIRED_MIN_MEMORY_LIMIT.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_MEMORY_LIMIT)
+        if ((float) $setting >= REQUIRED_MIN_MEMORY_LIMIT)
             $status = self :: STATUS_OK;
         $array[] = $this->build_setting($status, '[INI]', 'memory_limit', 'http://www.php.net/manual/en/ini.core.php#ini.memory-limit', $setting, $req_setting, null, get_lang('MemoryLimitInfo'));
 
         $setting = ini_get('post_max_size');
         $req_setting = '>= '.REQUIRED_MIN_POST_MAX_SIZE.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_POST_MAX_SIZE)
+        if ((float) $setting >= REQUIRED_MIN_POST_MAX_SIZE)
             $status = self :: STATUS_OK;
         $array[] = $this->build_setting($status, '[INI]', 'post_max_size', 'http://www.php.net/manual/en/ini.core.php#ini.post-max-size', $setting, $req_setting, null, get_lang('PostMaxSizeInfo'));
 
         $setting = ini_get('upload_max_filesize');
         $req_setting = '>= '.REQUIRED_MIN_UPLOAD_MAX_FILESIZE.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE)
+        if ((float) $setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE)
             $status = self :: STATUS_OK;
         $array[] = $this->build_setting($status, '[INI]', 'upload_max_filesize', 'http://www.php.net/manual/en/ini.core.php#ini.upload_max_filesize', $setting, $req_setting, null, get_lang('UploadMaxFilesizeInfo'));
 
@@ -205,7 +205,7 @@ 
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[SESSION]', 'session.gc_maxlifetime', 'http://www.php.net/manual/en/ini.core.php#session.gc-maxlifetime', $setting, $req_setting, null, get_lang('SessionGCMaxLifetimeInfo'));
 
-        if (api_check_browscap()){$setting = true;}else{$setting=false;}
+        if (api_check_browscap()) {$setting = true; } else {$setting = false; }
         $req_setting = true;
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[INI]', 'browscap', 'http://www.php.net/manual/en/misc.configuration.php#ini.browscap', $setting, $req_setting, 'on_off', get_lang('BrowscapInfo'));
@@ -261,7 +261,7 @@ 
 
             $loaded = extension_loaded($extension);
             $status = $loaded ? self :: STATUS_OK : self :: STATUS_ERROR;
-            $array[] = $this->build_setting($status, '[EXTENSION]', get_lang('LoadedExtension') . ': ' . $extension, $url, $loaded, $expected_value, 'yes_no_optional', $comment);
+            $array[] = $this->build_setting($status, '[EXTENSION]', get_lang('LoadedExtension').': '.$extension, $url, $loaded, $expected_value, 'yes_no_optional', $comment);
         }
 
         return $array;
@@ -384,9 +384,9 @@ 
         $formatted_expected_value = $expected_value;
 
         if ($formatter) {
-            if (method_exists($this, 'format_' . $formatter)) {
-                $formatted_current_value = call_user_func(array($this, 'format_' . $formatter), $current_value);
-                $formatted_expected_value = call_user_func(array($this, 'format_' . $formatter), $expected_value);
+            if (method_exists($this, 'format_'.$formatter)) {
+                $formatted_current_value = call_user_func(array($this, 'format_'.$formatter), $current_value);
+                $formatted_expected_value = call_user_func(array($this, 'format_'.$formatter), $expected_value);
             }
         }
 
@@ -401,13 +401,13 @@ 
      */
     public function get_link($title, $url)
     {
-        return '<a href="' . $url . '" target="about:bank">' . $title . '</a>';
+        return '<a href="'.$url.'" target="about:bank">'.$title.'</a>';
     }
 
     public function format_yes_no_optional($value)
     {
     	$return = '';
-    	switch($value) {
+    	switch ($value) {
      		case 0:
      			$return = get_lang('No');
      			break;