Cleaned up code - some adjustments to selected files

The following adjustments were made:
- Files should end with a newline (PHP:S113)
- Field names should comply with a naming convention (PHP_S116)
- Sections of code should not be commented out (PHP:S125)
- Mergeable "if" statements should be combined (PHP:S1066)
- Boolean literals should not be redundant (PHP:S1125)
- Use empty() to check whether the array is empty or not (PHP:S1155)
- Unused function parameters should be removed (PHP:S1172)
- Unused local variables should be removed (PHP:S1481)
- "elseif" keyword should be used in place of "else if" keywords
(PHP:S1793)
- Unused assignments should be removed (PHP:S1854)

Author: DanProgs

lib/execute/editExecution.php

@@ -1,12 +1,12 @@
 <?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	editExecution.php
  *
  * Edit an execution notes and custom fields
- * 
+ *
 **/
 require_once '../../config.inc.php';
 require_once 'common.php';
@@ -29,15 +29,15 @@
 
   case 'doUpdate':
     doUpdate($db,$args,$tcase_mgr,$_REQUEST);
-  break;  
+  break;
 }
 $map = get_execution($db,$args->exec_id);
 $owebeditor->Value = $map[0]['notes'];
 
-// order on script is critic 
+// order on script is critic
 $gui = initializeGui($args,$tcase_mgr);
 $cols = intval(isset($editorCfg['cols']) ? $editorCfg['cols'] : 60);
-$rows = intval(isset($editorCfg['rows']) ? $editorCfg['rows'] : 10); 
+$rows = intval(isset($editorCfg['rows']) ? $editorCfg['rows'] : 10);
 $gui->notes = $owebeditor->CreateHTML($rows,$cols);
 $gui->editorType = $editorCfg['type'];
 
@@ -77,7 +77,7 @@ function init_args()
   $args->basehref = $_SESSION['basehref'];
   $args->user = $_SESSION['currentUser'];
 
-  return $args; 
+  return $args;
 }
 
 /**
@@ -103,7 +103,7 @@ function initializeGui(&$argsObj,&$tcaseMgr)
 
 /**
  * Checks the user rights for viewing the page
- * 
+ *
  * @param $db resource the database connection handle
  * @param $user tlUser the object of the current user
  *
@@ -112,4 +112,4 @@ function initializeGui(&$argsObj,&$tcaseMgr)
 function checkRights(&$db,&$user)
 {
 	return $user->hasRight($db,"testplan_execute") && $user->hasRight($db,"exec_edit_notes");
-}
+}

lib/execute/execDashboard.php

@@ -1,9 +1,9 @@
 <?php
 /**
- * TestLink Open Source Project - http://testlink.sourceforge.net/ 
+ * TestLink Open Source Project - http://testlink.sourceforge.net/
  *
  * @filesource  execDashboard.php
- * 
+ *
  *
 **/
 require_once '../../config.inc.php';
@@ -21,28 +21,28 @@
 $tree_mgr = new tree($db);
 $attachmentRepository = tlAttachmentRepository::create($db);
 
-list($args,$tplan_mgr) = init_args($db,$cfg);
+list($args,$tplan_mgr) = init_args($db);
 $gui = initializeGui($db,$args,$cfg,$tplan_mgr);
 
 $smarty->assign('gui',$gui);
 $smarty->display($templateCfg->template_dir . $templateCfg->default_template);
 
 
 /*
-  function: 
+  function:
 
   args:
   
-  returns: 
+  returns:
 */
-function init_args(&$dbHandler,$cfgObj) {
+function init_args(&$dbHandler) {
 
   $args = new stdClass();
   $_REQUEST = strings_stripSlashes($_REQUEST);
   $tplan_mgr = new testplan($dbHandler);
 
 
-  // Settings we put on session to create some sort of persistent scope, 
+  // Settings we put on session to create some sort of persistent scope,
   // because we have had issues when passing this info using GET mode (size limits)
   //
   // we get info about build_id, platform_id, etc ...
@@ -58,26 +58,26 @@ function init_args(&$dbHandler,$cfgObj) {
   if($args->tproject_id <= 0) {
     $tree_mgr = new tree($dbHandler);
     $dm = $tree_mgr->get_node_hierarchy_info($args->tplan_id);
-    $args->tproject_id = $dm['parent_id']; 
+    $args->tproject_id = $dm['parent_id'];
   }
 
   if(is_null($args->build_id) || ($args->build_id == 0) ) {
     // Go for the build
     // this info can be present in session, then we will try different ways
-    // ATTENTION: 
+    // ATTENTION:
     // give a look to tlTestCaseFilterControl.class.php method init_setting_build()
     //
     $key = $args->tplan_id . '_stored_setting_build';
     $args->build_id = isset($_SESSION[$key]) ? intval($_SESSION[$key]) : null;
     if( is_null($args->build_id) ) {
       $args->build_id = $tplan_mgr->get_max_build_id($args->tplan_id,1,1);
-    }  
-  }  
+    }
+  }
 
   if(is_null($args->platform_id) || ($args->platform_id <= 0) ) {
     // Go for the platform (if any exists)
     // this info can be present in session, then we will try different ways
-    // ATTENTION: 
+    // ATTENTION:
     // give a look to tlTestCaseFilterControl.class.php method init_setting_platform()
     //
     $itemSet = $tplan_mgr->getPlatforms($args->tplan_id);
@@ -86,17 +86,17 @@ function init_args(&$dbHandler,$cfgObj) {
       $args->platform_id = isset($_SESSION[$key]) ? intval($_SESSION[$key]) : null;
       if( is_null($args->platform_id) || ($args->platform_id <= 0) ) {
         $args->platform_id = $itemSet[0]['id'];
-      }  
-    }  
-  }  
+      }
+    }
+  }
   return array($args,$tplan_mgr);
 }
 
 
 
 /*
-  function: initializeRights 
-            create object with rights useful for this feature 
+  function: initializeRights
+            create object with rights useful for this feature
   
   args:
        dbHandler: reference to db object
@@ -108,12 +108,11 @@ function: initializeRights
                 has_rights() can works in a mode (that i consider a dirty one)
                 using SESSION to achieve global coupling.
                  
-  returns: 
+  returns:
 
 */
 function initializeRights(&$dbHandler,&$userObj,$tproject_id,$tplan_id)
 {
-    $exec_cfg = config_get('exec_cfg');
     $grants = new stdClass();
 
     $grants->execute = $userObj->hasRight($dbHandler,"testplan_execute",$tproject_id,$tplan_id);
@@ -123,7 +122,7 @@ function initializeRights(&$dbHandler,&$userObj,$tproject_id,$tplan_id)
     // If is TRUE we will need also to analize, test case by test case
     // these settings:
     //           $tlCfg->exec_cfg->exec_mode->tester
-    //          $tlCfg->exec_cfg->simple_tester_roles       
+    //          $tlCfg->exec_cfg->simple_tester_roles
     //
     // Why ?
     // Because if a tester can execute ONLY test cases assigned to him, this also
@@ -141,8 +140,7 @@ function initializeRights(&$dbHandler,&$userObj,$tproject_id,$tplan_id)
     // Important:
     // Execution right must be present to consider this configuration option.
     // $grants->edit_exec_notes = $grants->execute && $exec_cfg->edit_notes;
-    $grants->edit_exec_notes = $grants->execute && 
-                               $userObj->hasRight($dbHandler,"exec_edit_notes",$tproject_id,$tplan_id);
+    $grants->edit_exec_notes = $grants->execute && $userObj->hasRight($dbHandler,"exec_edit_notes",$tproject_id,$tplan_id);
 
 
     $grants->edit_testcase = $userObj->hasRight($dbHandler,"mgt_modify_tc",$tproject_id,$tplan_id);
@@ -156,7 +154,7 @@ function: initializeGui
 
   args :
   
-  returns: 
+  returns:
 
 */
 function initializeGui(&$dbHandler,&$argsObj,&$cfgObj,&$tplanMgr) {
@@ -182,10 +180,10 @@ function initializeGui(&$dbHandler,&$argsObj,&$cfgObj,&$tplanMgr) {
   $cfgBuild = getWebEditorCfg('build');
   $gui->buildEditorType = $cfgBuild['type'];
 
-  // Just for the records:  
+  // Just for the records:
   // doing this here, we avoid to do on processTestSuite() and processTestCase(),
   // but absolutely this will not improve in ANY WAY perfomance, because we do not loop
-  // over these two functions.   
+  // over these two functions.
   $tprojectMgr = new testproject($dbHandler);
   $gui->tcasePrefix = $tprojectMgr->getTestCasePrefix($argsObj->tproject_id);
   $build_info = $buildMgr->get_by_id($argsObj->build_id);
@@ -198,8 +196,8 @@ function initializeGui(&$dbHandler,&$argsObj,&$cfgObj,&$tplanMgr) {
   $gui->testplan_notes = $rs['notes'];
   $gui->testplan_name = $rs['name'];
 
-  // Important note: 
-  // custom fields for test plan can be edited ONLY on design, that's reason why we are using 
+  // Important note:
+  // custom fields for test plan can be edited ONLY on design, that's reason why we are using
   // scope = 'design' instead of 'execution'
   $gui->testplan_cfields = $tplanMgr->html_table_of_custom_field_values($argsObj->tplan_id,'design',
                                                                         array('show_on_execution' => 1));
@@ -213,7 +211,7 @@ function initializeGui(&$dbHandler,&$argsObj,&$cfgObj,&$tplanMgr) {
 
   $gui->platform_info['id']=0;
   $gui->platform_info['name']='';
-  if(!is_null($argsObj->platform_id) && $argsObj->platform_id > 0 ) { 
+  if(!is_null($argsObj->platform_id) && $argsObj->platform_id > 0 ) {
     $gui->platform_info = $platformMgr->getByID($argsObj->platform_id);
   }
 
@@ -233,41 +231,41 @@ function initializeGui(&$dbHandler,&$argsObj,&$cfgObj,&$tplanMgr) {
 
 
 /**
- *  get info from ... 
+ *  get info from ...
  *
  */
 function getContextFromGlobalScope(&$argsObj)
 {
-  $mode = 'execution_mode';
+  //$mode = 'execution_mode';
   $settings = array('build_id' => 'setting_build', 'platform_id' => 'setting_platform');
   $isNumeric = array('build_id' => 0, 'platform_id' => 0);
 
   $argsObj->form_token = isset($_REQUEST['form_token']) ? $_REQUEST['form_token'] : 0;
-  $sf = isset($_SESSION['execution_mode']) && isset($_SESSION['execution_mode'][$argsObj->form_token]) ? 
+  $sf = isset($_SESSION['execution_mode']) && isset($_SESSION['execution_mode'][$argsObj->form_token]) ?
         $_SESSION['execution_mode'][$argsObj->form_token] : null;
 
   if(is_null($sf))
   {
     foreach($settings as $key => $sfKey)
     {
       $argsObj->$key = null;
-    }  
+    }
     return;
-  } 
+  }
 
   foreach($settings as $key => $sfKey)
   {
     $argsObj->$key = isset($sf[$sfKey]) ? $sf[$sfKey] : null;
-    if (is_null($argsObj->$key)) 
+    if (is_null($argsObj->$key))
     {
-      // let's this page be functional withouth a form token too 
+      // let's this page be functional withouth a form token too
       // (when called from testcases assigned to me)
       $argsObj->$key = isset($_REQUEST[$sfKey]) ? $_REQUEST[$sfKey] : null;
     }
     if(isset($isNumeric[$key]))
     {
-      $argsObj->$key = intval($argsObj->$key);              
-    }  
+      $argsObj->$key = intval($argsObj->$key);
+    }
   }
 
 }

lib/execute/execNavigator.php

@@ -50,30 +50,28 @@
 
 
 /**
- * 
+ *
  *
  */
 function initializeGui(&$dbH,&$control) {
   $gui = new stdClass();
 
   // This logic is managed from execSetResults.php
   $gui->loadExecDashboard = true;
-  if( isset($_SESSION['loadExecDashboard'][$control->form_token]) || 
-      $control->args->loadExecDashboard == 0 
-    ) {
-    $gui->loadExecDashboard = false;  
-    unset($_SESSION['loadExecDashboard'][$control->form_token]);      
-  }  
+  if( isset($_SESSION['loadExecDashboard'][$control->form_token]) || $control->args->loadExecDashboard == 0 ) {
+    $gui->loadExecDashboard = false;
+    unset($_SESSION['loadExecDashboard'][$control->form_token]);
+  }
 
   $gui->menuUrl = 'lib/execute/execSetResults.php';
   $gui->args = $control->get_argument_string();
-  if($control->args->loadExecDashboard == false) {
+  if(!$control->args->loadExecDashboard) {
     $gui->src_workframe = '';
   } else {
     $gui->src_workframe = $control->args->basehref . $gui->menuUrl .
-                          "?edit=testproject&id={$control->args->testproject_id}" . 
+                          "?edit=testproject&id={$control->args->testproject_id}" .
                           $gui->args;
-  } 
+  }
 
   $control->draw_export_testplan_button = true;
   $control->draw_import_xml_results_button = true;
@@ -95,11 +93,11 @@ function initializeGui(&$dbH,&$control) {
     $gui->features['export'] = true;
     $gui->features['import'] = true;
     $gui->execAccess = true;
-  }  
+  }
 
   if($grants['exec_ro_access']) {
     $gui->execAccess = true;
-  }  
+  }
 
 
   $control->draw_export_testplan_button = $gui->features['export'];
@@ -122,7 +120,7 @@ function checkAccessToExec(&$dbH,&$ct) {
   {
     throw new Exception("Can not find Test Project For Test Plan - ABORT", 1);
 
-  }  
+  }
   $rs = current($rs);
   $tproject_id = $rs['testproject_id'];
 
@@ -135,8 +133,8 @@ function checkAccessToExec(&$dbH,&$ct) {
     if( $user->hasRight($dbH,$r2c,$tproject_id,$tplan_id,true) || $user->globalRoleID == TL_ROLES_ADMIN )
     {
       $grants[$r2c] = true;
-    }    
-  }  
+    }
+  }
 
   return $grants;
-} 
+}