[GT-183] Update code to line limit

GOCDB · Aug 24, 2023 · fb9a3ce · fb9a3ce
1 parent bf4b0a1
commit fb9a3ce
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 18 deletions.
diff --git a/htdocs/web_portal/components/Draw_Components/menu.php b/htdocs/web_portal/components/Draw_Components/menu.php
@@ -37,7 +37,9 @@ function draw_menu($mainMenuNameFromXML)
     $user = $userService->getUserByPrinciple($identifier);
 
     // Open the XML file of possible menus as a SimpleXML object
-    $menusInXML = simplexml_load_file(__DIR__ . '/../../../../config/web_portal/menu.xml');
+    $menusInXML = simplexml_load_file(
+        __DIR__ . '/../../../../config/web_portal/menu.xml'
+    );
     $menusInHTML = xml_to_html($mainMenuNameFromXML, $menusInXML, $user);
 
     return $menusInHTML;
@@ -54,8 +56,13 @@ function xml_to_html($mainMenuNameFromXML, $menusInXML, $user)
     $html .= "<ul class=\"Smaller_Left_Padding Smaller_Top_Margin\">";
     $isUserAdmin = isset($user) ? $user->isAdmin() : false;
 
-    foreach ($menusInXML->$mainMenuNameFromXML->children() as $key => $value) {
-        // Check if the display of menu is overridden in the local configuration
+    foreach (
+        $menusInXML->$mainMenuNameFromXML->children() as $key => $value
+    ) {
+        /**
+         * Check if the display of menu is overridden
+         * in the local configuration
+         */
         if (\Factory::getConfigService()->showMenu($key)) {
             if ($key == "ViewServiceTypes") {
                 if ($isUserAdmin) {
@@ -80,14 +87,22 @@ function add_menu_item($menuItem, $isUserAdmin)
         if ($key == "spacer") {
             $showOnInstanceValue = $menuItem->show_on_instance;
 
-            // If the spacer has a show_on_instance type that we want to show, then show it
+            /**
+             * If the spacer has a show_on_instance type that we want to show,
+             * then show it.
+             */
             if (
                 !empty($showOnInstanceValue) &&
-                canMenuItemBeDisplayed($showOnInstanceValue, $portalIsReadOnly, $isUserAdmin)
+                canMenuItemBeDisplayed(
+                    $showOnInstanceValue,
+                    $portalIsReadOnly,
+                    $isUserAdmin
+                )
             ) {
                 return "</ul>
                         <h4 class='menu_title'>$value</h4>
-                        <ul class=\"Smaller_Left_Padding Smaller_Top_Margin\">";
+                        <ul class=\"Smaller_Left_Padding Smaller_Top_Margin\">
+                        ";
             }
 
             return;
@@ -98,7 +113,13 @@ function add_menu_item($menuItem, $isUserAdmin)
     $name = $menuItem->name;
     $link = $menuItem->link;
 
-    if (canMenuItemBeDisplayed($showOnInstanceValue, $portalIsReadOnly, $isUserAdmin)) {
+    if (
+        canMenuItemBeDisplayed(
+            $showOnInstanceValue,
+            $portalIsReadOnly,
+            $isUserAdmin
+        )
+    ) {
         $html .= "<li class=\"Menu_Item\">" .
                     "<a href=\"" . htmlspecialchars($link) . "\">
                         <span class=\"menu_link\">" .
@@ -111,11 +132,17 @@ function add_menu_item($menuItem, $isUserAdmin)
     return $html;
 }
 
-function canMenuItemBeDisplayed($showOnInstanceValue, $portalIsReadOnly, $isUserAdmin)
-{
+function canMenuItemBeDisplayed(
+    $showOnInstanceValue,
+    $portalIsReadOnly,
+    $isUserAdmin
+) {
     return (
         ($showOnInstanceValue == "all") or
-        ($showOnInstanceValue == "write_enabled" and (!$portalIsReadOnly or $isUserAdmin)) or
+        (
+            $showOnInstanceValue == "write_enabled" and
+            (!$portalIsReadOnly or $isUserAdmin)
+        ) or
         (($showOnInstanceValue == "admin") and ($isUserAdmin))
     );
 }
diff --git a/htdocs/web_portal/controllers/admin/view_service_type.php b/htdocs/web_portal/controllers/admin/view_service_type.php
@@ -31,7 +31,8 @@ function view_service_type($slicedURLSearchName)
     $params['isUserAdmin'] = checkUserForAdminCredentials($user);
 
     if (!$params['isUserAdmin'] && $slicedURLSearchName == "Admin") {
-        checkUserIsAdmin(); // Since the user is NOT an Admin, it will throw an ERROR.
+        // Since the user is NOT an Admin, it will throw an ERROR.
+        checkUserIsAdmin();
     }
 
     if (!isset($_REQUEST['id']) || !is_numeric($_REQUEST['id'])) {

diff --git a/htdocs/web_portal/controllers/admin/view_service_types.php b/htdocs/web_portal/controllers/admin/view_service_types.php
@@ -31,7 +31,8 @@ function show_all($slicedURLSearchName)
     $params['isUserAdmin'] = checkUserForAdminCredentials($user);
 
     if (!$params['isUserAdmin'] && $slicedURLSearchName == 'Admin') {
-        checkUserIsAdmin(); // Since the user is NOT an Admin, it will throw an ERROR.
+        // Since the user is NOT an Admin, it will throw an ERROR.
+        checkUserIsAdmin();
     }
 
     $serviceTypes = \Factory::getServiceTypeService()->getServiceTypes();

diff --git a/htdocs/web_portal/controllers/utils.php b/htdocs/web_portal/controllers/utils.php
@@ -208,7 +208,8 @@ function portalIsReadOnlyAndUserIsNotAdmin(\user $user = null)
     // this block is required to deal with unregistered users (where $user is null)
     $userIsAdmin = false;
     if (! is_null($user)) {
-        if (checkUserForAdminCredentials($user)) { // sub query required becauser ->isAdmin can't be called on null
+        // Sub query required becauser ->isAdmin can't be called on null
+        if (checkUserForAdminCredentials($user)) {
             $userIsAdmin = true;
         }
     }

diff --git a/htdocs/web_portal/index.php b/htdocs/web_portal/index.php
@@ -116,8 +116,8 @@ function testForHtmlSpecialChars($value, $key){
 
 /**
  * Helper method to get a relative PATH for the required file when `Page_type`
- * is equals to either `Service_Types`, `Service_Type`, `Admin_Service_Types` or
- * `Admin_Service_Type`.
+ * is equals to either `Service_Types`, `Service_Type`, `Admin_Service_Types`
+ * or `Admin_Service_Type`.
  */
 function helperForServiceTypes($iServiceType)
 {

diff --git a/htdocs/web_portal/views/admin/view_service_types.php b/htdocs/web_portal/views/admin/view_service_types.php
@@ -42,7 +42,9 @@
             </tr>
             <?php
             $num = 2;
-            $searchName = $params['isUserAdmin'] ? 'Admin_Service_Type' : 'Service_Type';
+            $searchName = $params['isUserAdmin']
+                            ? 'Admin_Service_Type'
+                            : 'Service_Type';
 
             if ($numberOfServiceTypes > 0) {
                 foreach ($params['ServiceTypes'] as $serviceType) {
@@ -52,8 +54,10 @@
                         <div style="background-color: inherit;">
                             <span style="vertical-align: middle;">
                                 <?php
-                                    echo "<a href=\"index.php?Page_Type=" . $searchName
-                                        . "&amp;id=" . $serviceType->getId() . "\">"
+                                    echo "<a href=\"index.php?Page_Type="
+                                        . $searchName
+                                        . "&amp;id=" . $serviceType->getId()
+                                        . "\">"
                                         . $serviceType->getName()
                                         . "</a>";
                                 ?>