Cleaned up code - some adjustments to selected files

The following adjustments were made:
- Sections of code should not be commented out (PHP:S125)
- Files should end with a newline (PHP:S113)
- Mergeable "if" statements should be combined (PHP:S1066)
- Redundant pairs of parentheses should be removed (PHP:1110)
- Boolean literals should not be redundant (PHP:S1125)
- Lines should not end with trailing whitespaces (PHP:S1131)
- Use empty() to check whether the array is empty or not (PHP:S1155)
- Unused local variables should be removed (PHP:S1481)
- PHP keywords and constants "true", "false", "null" should be lower
case (PHP:S1781)
- Method visibility should be explicitly declared (PHP:S1784)
- "elseif" keyword should be used in place of "else if" keywords
(PHP:S1793)
- Unused assignments should be removed (PHP:S1854)
- "require_once" and "include_once" should be used instead of "require"
and "include" (PHP:S2003)

Author: DanProgs

lib/api/rest/v1/tlRestApi.class.php

@@ -9,7 +9,7 @@
   // @20201124 - I do not understand this
   // $app->get('/',World::class . ':hello');
 
-  // using array(), was the way in Slim3 and 
+  // using array(), was the way in Slim3 and
   // still seems valid
   $app->get('/whoAmI',array($app->restApi,'whoAmI'));
 
@@ -20,47 +20,47 @@
 
   $app->get('/testprojects/{id}/testcases',
             array($app->restApi,'getProjectTestCases'));
-  $app->get('/testprojects/{mixedID}/testplans', 
+  $app->get('/testprojects/{mixedID}/testplans',
             array($app->restApi,'getProjectTestPlans'));
 
-  $app->get('/testplans/{tplanApiKey}/builds', 
+  $app->get('/testplans/{tplanApiKey}/builds',
             array($app->restApi,'getPlanBuilds'));
 
   /*
-  $app->get('/builds/{id}', 
+  $app->get('/builds/{id}',
             array($app->restApi,'getBuild'));
   */
 
-  $app->post('/executions', 
+  $app->post('/executions',
              array($app->restApi,'createTestCaseExecution'));
 
   $app->post('/builds',
              array($app->restApi,'createBuild'));
 
-  $app->post('/keywords', 
+  $app->post('/keywords',
              array($app->restApi,'createKeyword'));
 
-  $app->post('/testcases', 
+  $app->post('/testcases',
              array($app->restApi,'createTestCase'));
 
-  $app->post('/testplans', 
+  $app->post('/testplans',
              array($app->restApi,'createTestPlan'));
 
   $app->post('/testprojects',
             array($app->restApi,'createTestProject'));
 
-  $app->post('/testsuites', 
+  $app->post('/testsuites',
              array($app->restApi,'createTestSuite'));
 
 
   // Update Routes
   // Following advice from
   // https://restfulapi.net/rest-put-vs-post/
   //
-  $app->put('/builds/{id}', 
+  $app->put('/builds/{id}',
              array($app->restApi,'updateBuild'));
 
-  $app->put('/testplans/{id}', 
+  $app->put('/testplans/{id}',
              array($app->restApi,'updateTestPlan'));
 
   $app->put('/testplans/{tplan_id}/platforms',

lib/api/rest/v2/tlRestApi.class.php

@@ -1,4 +1,4 @@
-<?php 
+<?php
 /**
  * @filesource  RestApiCustomExample.class.php
  *
@@ -23,28 +23,28 @@
 
 /**
  * @author    Francisco Mancardi <francisco.mancardi@gmail.com>
- * @package   TestLink 
+ * @package   TestLink
  */
 class RestApiCustomExample extends RestApi
 {
   public static $version = "1.0";
 
   /**
    */
-  public function __construct() 
+  public function __construct()
   {
     $this->db = new database(DB_TYPE);
     $this->db->db->SetFetchMode(ADODB_FETCH_ASSOC);
     doDBConnect($this->db,database::ONERROREXIT);
-  }  
+  }
 
 
 
   /**
    *
    */
   public function whoAmI(Request $request, Response $response, $args)
-  {    
+  {
     $msg = json_encode(array('name' => __CLASS__ . ' : You have called Get Route /whoAmI'));
     $response->getBody()->write($msg);
     return $response;

lib/api/rest/v3/RestApi.class.php

@@ -13,4 +13,4 @@
   $app->get('/CustomExample/whoAmI',
             array($app->restApiCustomExample,'whoAmI'));
 
-};
+};

lib/api/rest/v3/core/routes.php

@@ -5,13 +5,13 @@
 use Slim\Factory\AppFactory;
 
 require_once '../../../../config.inc.php';
-require 'autoload.php';
-require 'RestApi.class.php';
+require_once 'autoload.php';
+require_once 'RestApi.class.php';
 
 $app = AppFactory::create();
 
-// CRITIC 
-// This will work if your url to test link 
+// CRITIC
+// This will work if your url to test link
 // is something like
 //
 // https://testlink.antartic.org/
@@ -21,15 +21,15 @@
 // You need to use:
 //   $basePath = "/testlink/lib/api/rest/v3";
 //
-// The standard .htaccess provided with testlink, 
+// The standard .htaccess provided with testlink,
 // that is similar to the .htaccess provided by MantisBT
 // it's ok!!!
 // No need to proceed as detailed in this documentation
-// - https://www.slimframework.com/docs/v4/start/web-servers.html 
+// - https://www.slimframework.com/docs/v4/start/web-servers.html
 //   Section: Running in a sub-directory
 //
 // - https://akrabat.com/running-slim-4-in-a-subdirectory/
-//   BUT this is a good example to understand how to configure 
+//   BUT this is a good example to understand how to configure
 //
 $basePath = config_get('restAPI')->basePath;
 $app->setBasePath($basePath);
@@ -49,7 +49,7 @@
   foreach ($itera as $fileinfo) {
     if ($fileinfo->isFile()) {
       $who = $fileinfo->getFilename();
-      require $where . $who;
+      require_once $where . $who;
 
       // generate class name
       $className = str_replace('.class.php', '', $who);
@@ -72,15 +72,15 @@
   foreach ($itera as $fileinfo) {
     if ($fileinfo->isFile()) {
       $who = $fileinfo->getFilename();
-      $customRoutes = require $where . $who;
+      $customRoutes = require_once $where . $who;
       $customRoutes($app);
     }
   }
 }
 // * Load Custom API  - END
 
 // Register Standard routes
-$routes = require './core/routes.php';
+$routes = require_once './core/routes.php';
 $routes($app);
 
 // Middleware

lib/api/rest/v3/custom/api/RestApiCustomExample.class.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * TestLink Open Source Project - http://testlink.sourceforge.net/ 
- * This script is distributed under the GNU General Public License 2 or later. 
+ * TestLink Open Source Project - http://testlink.sourceforge.net/
+ * This script is distributed under the GNU General Public License 2 or later.
  *
  * @filesource  attachmentdelete.php
  * Deletes an attachment by a given id
@@ -11,7 +11,7 @@
 require_once '../functions/attachments.inc.php';
 testlinkInitPage($db,false,false,"checkRights");
 
-$args = init_args();  
+$args = init_args();
 $deleteDone = false;
 if ($args->id)
 {
@@ -24,7 +24,7 @@
     {
       logAuditEvent(TLS("audit_attachment_deleted",
                     $attachmentInfo['title']),"DELETE",$args->id,"attachments");
-    } 
+    }
   }
 }
 
@@ -50,13 +50,13 @@ function init_args()
 
 
 /**
- * @param $db resource the database connection handle
- * @param $user the current active user
- * 
+ * @param database $db resource the database connection handle
+ * @param tlUser $user the current active user
+ *
  * @return boolean returns true if the page can be accessed
  */
 function checkRights(&$db,&$user)
 {
   return config_get("attachments")->enabled;
 }
-?>
+?>

lib/api/rest/v3/custom/routes/routesCustomExample.php

@@ -160,8 +160,8 @@ function init_args(&$dbHandler)
 }
 
 /**
- * @param $db resource the database connection handle
- * @param $user the current active user
+ * @param database $db resource the database connection handle
+ * @param tlUser $user the current active user
  * @return boolean returns true if the page can be accessed
  */
 function checkRights(&$db,&$user)