supernova-ws / SuperNova

includes/template.php

Doc Comments +7 added lines, -8 removed lines

@@ -36,7 +36,7 @@ 
  * @param string    $title
  * @param string    $dest
  * @param int       $time
- * @param bool|true $show_header
+ * @param boolean $show_header
  */
 function message($mes, $title = 'Error', $dest = '', $time = 5, $show_header = true) {
   $template = gettemplate('message_body', true);
@@ -195,7 +195,7 @@ 
  * @param bool|true       $isDisplayTopNav
  * @param string          $metatags
  * @param bool|false      $AdminPage
- * @param bool|true       $isDisplayMenu
+ * @param boolean       $isDisplayMenu
  *
  * @return mixed
  */
@@ -208,7 +208,6 @@ 
  * @param string          $title
  * @param bool|true       $isDisplayTopNav
  * @param string          $metatags
- * @param bool|false      $AdminPage
  * @param bool|true       $isDisplayMenu
  * @param bool|int|string $exitStatus - Код или сообщение выхода
  */
@@ -359,7 +358,7 @@ 
 
 /**
  * @param $fileList
- * @param $extension
+ * @param string $extension
  * @param $sn_page_name
  * @param $template_result
  *
@@ -387,7 +386,7 @@ 
 }
 
 /**
- * @return mixed|string
+ * @return string
  */
 function calculateFontSize() {
   $font_size = !empty($_COOKIE[SN_COOKIE_F]) ? $_COOKIE[SN_COOKIE_F] : classSupernova::$user_options[PLAYER_OPTION_BASE_FONT_SIZE];
@@ -406,10 +405,10 @@ 
 
 /**
  * @param       $time
- * @param       $event
+ * @param       integer $event
  * @param       $msg
  * @param       $coordinates
- * @param       $is_decrease
+ * @param       boolean $is_decrease
  * @param Fleet $objFleet
  * @param       $fleet_flying_sorter
  * @param       $fleet_flying_events
@@ -733,7 +732,7 @@ 
 }
 
 /**
- * @param array|string  $files
+ * @param string  $files
  * @param template|bool $template
  * @param string|bool   $template_path
  *

Spacing +61 added lines, -61 removed lines

@@ -12,7 +12,7 @@ 
 function gettemplatename($u_dpath) {
   static $template_names = array();
 
-  if(!isset($template_names[$u_dpath])) {
+  if (!isset($template_names[$u_dpath])) {
     $template_names[$u_dpath] = file_exists(SN_ROOT_PHYSICAL . $u_dpath . 'tmpl.ini') ? sys_file_read(SN_ROOT_PHYSICAL . $u_dpath . 'tmpl.ini') : TEMPLATE_NAME;
   }
 
@@ -54,12 +54,12 @@ 
  * @param $sn_menu_extra
  */
 function tpl_menu_merge_extra(&$sn_menu, &$sn_menu_extra) {
-  if(empty($sn_menu) || empty($sn_menu_extra)) {
+  if (empty($sn_menu) || empty($sn_menu_extra)) {
     return;
   }
 
-  foreach($sn_menu_extra as $menu_item_id => $menu_item) {
-    if(empty($menu_item['LOCATION'])) {
+  foreach ($sn_menu_extra as $menu_item_id => $menu_item) {
+    if (empty($menu_item['LOCATION'])) {
       $sn_menu[$menu_item_id] = $menu_item;
       continue;
     }
@@ -68,16 +68,16 @@ 
     unset($menu_item['LOCATION']);
 
     $is_positioned = $item_location[0];
-    if($is_positioned == '+' || $is_positioned == '-') {
+    if ($is_positioned == '+' || $is_positioned == '-') {
       $item_location = substr($item_location, 1);
     } else {
       $is_positioned = '';
     }
 
-    if($item_location) {
+    if ($item_location) {
       $menu_keys = array_keys($sn_menu);
       $insert_position = array_search($item_location, $menu_keys);
-      if($insert_position === false) {
+      if ($insert_position === false) {
         $insert_position = count($sn_menu) - 1;
         $is_positioned = '+';
         $item_location = '';
@@ -90,7 +90,7 @@ 
     $spliced = array_splice($sn_menu, $insert_position, count($sn_menu) - $insert_position);
     $sn_menu[$menu_item_id] = $menu_item;
 
-    if(!$is_positioned && $item_location) {
+    if (!$is_positioned && $item_location) {
       unset($spliced[$item_location]);
     }
     $sn_menu = array_merge($sn_menu, $spliced);
@@ -104,24 +104,24 @@ 
  * @param template $template
  */
 function tpl_menu_assign_to_template(&$sn_menu, &$template) {
-  if(empty($sn_menu) || !is_array($sn_menu)) {
+  if (empty($sn_menu) || !is_array($sn_menu)) {
     return;
   }
 
-  foreach($sn_menu as $menu_item_id => $menu_item) {
-    if(!$menu_item) {
+  foreach ($sn_menu as $menu_item_id => $menu_item) {
+    if (!$menu_item) {
       continue;
     }
 
-    if(is_string($menu_item_id)) {
+    if (is_string($menu_item_id)) {
       $menu_item['ID'] = $menu_item_id;
     }
 
-    if($menu_item['TYPE'] == 'lang') {
+    if ($menu_item['TYPE'] == 'lang') {
       $lang_string = &classLocale::$lang;
-      if(preg_match('#(\w+)(?:\[(\w+)\])?(?:\[(\w+)\])?(?:\[(\w+)\])?(?:\[(\w+)\])?#', $menu_item['ITEM'], $matches) && count($matches) > 1) {
-        for($i = 1; $i < count($matches); $i++) {
-          if(defined($matches[$i])) {
+      if (preg_match('#(\w+)(?:\[(\w+)\])?(?:\[(\w+)\])?(?:\[(\w+)\])?(?:\[(\w+)\])?#', $menu_item['ITEM'], $matches) && count($matches) > 1) {
+        for ($i = 1; $i < count($matches); $i++) {
+          if (defined($matches[$i])) {
             $matches[$i] = constant($matches[$i]);
           }
           $lang_string = &$lang_string[$matches[$i]];
@@ -133,8 +133,8 @@ 
     $menu_item['ALT'] = htmlentities($menu_item['ALT']);
     $menu_item['TITLE'] = htmlentities($menu_item['TITLE']);
 
-    if(!empty($menu_item['ICON'])) {
-      if(is_string($menu_item['ICON'])) {
+    if (!empty($menu_item['ICON'])) {
+      if (is_string($menu_item['ICON'])) {
         $menu_item['ICON_PATH'] = $menu_item['ICON'];
       } else {
         $menu_item['ICON'] = $menu_item_id;
@@ -164,7 +164,7 @@ 
     'MENU_START_HIDE'     => !empty($_COOKIE[SN_COOKIE . '_menu_hidden']) || defined('SN_GOOGLE'),
   ));
 
-  if(isset($template_result['MENU_CUSTOMIZE'])) {
+  if (isset($template_result['MENU_CUSTOMIZE'])) {
     $template->assign_vars(array(
       'PLAYER_OPTION_MENU_SHOW_ON_BUTTON'   => classSupernova::$user_options[PLAYER_OPTION_MENU_SHOW_ON_BUTTON],
       'PLAYER_OPTION_MENU_HIDE_ON_BUTTON'   => classSupernova::$user_options[PLAYER_OPTION_MENU_HIDE_ON_BUTTON],
@@ -178,7 +178,7 @@ 
     ));
   }
 
-  if(defined('IN_ADMIN') && IN_ADMIN === true && !empty($user['authlevel']) && $user['authlevel'] > 0) {
+  if (defined('IN_ADMIN') && IN_ADMIN === true && !empty($user['authlevel']) && $user['authlevel'] > 0) {
     tpl_menu_merge_extra($sn_menu_admin, $sn_menu_admin_extra);
     tpl_menu_assign_to_template($sn_menu_admin, $template);
   } else {
@@ -218,7 +218,7 @@ 
   $in_admin = defined('IN_ADMIN') && IN_ADMIN === true;
   $is_login = defined('LOGIN_LOGOUT') && LOGIN_LOGOUT === true;
 
-  if(is_object($page)) {
+  if (is_object($page)) {
     isset($page->_rootref['MENU']) ? $isDisplayMenu = $page->_rootref['MENU'] : false;
     isset($page->_rootref['NAVBAR']) ? $isDisplayTopNav = $page->_rootref['NAVBAR'] : false;
 
@@ -226,7 +226,7 @@ 
     !isset($page->_rootref['PAGE_HEADER']) && $title ? $page->assign_var('PAGE_HEADER', $title) : false;
   }
 
-  if(empty($user['id']) || !is_numeric($user['id'])) {
+  if (empty($user['id']) || !is_numeric($user['id'])) {
     $isDisplayMenu = false;
     $isDisplayTopNav = false;
   }
@@ -313,12 +313,12 @@ 
   $template->assign_recursive($template_result);
   displayP(parsetemplate($template));
 
-  if(($isDisplayMenu || $in_admin) && !isset($_COOKIE['menu_disable'])) {
+  if (($isDisplayMenu || $in_admin) && !isset($_COOKIE['menu_disable'])) {
     // $AdminPage = $AdminPage ? $user['authlevel'] : 0;
     displayP(parsetemplate(tpl_render_menu()));
   }
 
-  if($isDisplayTopNav && !$in_admin) {
+  if ($isDisplayTopNav && !$in_admin) {
     displayP(parsetemplate(tpl_render_topnav($user, $planetrow)));
   }
 
@@ -326,8 +326,8 @@ 
 
   !is_array($page) ? $page = array($page) : false;
   $result_added = false;
-  foreach($page as $page_item) {
-    if(!$result_added && is_object($page_item) && isset($page_item->_tpldata['result'])) {
+  foreach ($page as $page_item) {
+    if (!$result_added && is_object($page_item) && isset($page_item->_tpldata['result'])) {
       $page_item = gettemplate('_result_message', $page_item);
       $temp = $page_item->files['_result_message'];
       unset($page_item->files['_result_message']);
@@ -350,7 +350,7 @@ 
   ));
   displayP(parsetemplate($template));
 
-  $user['authlevel'] >= 3 && classSupernova::$config->debug ? classSupernova::$debug->echo_log() : false;;
+  $user['authlevel'] >= 3 && classSupernova::$config->debug ? classSupernova::$debug->echo_log() : false; ;
 
   classSupernova::$db->db_disconnect();
 
@@ -435,7 +435,7 @@ 
  * @param string         $type
  */
 function tpl_topnav_event_build(&$template, $FleetList, $type = 'fleet') {
-  if(empty($FleetList)) {
+  if (empty($FleetList)) {
     return;
   }
 
@@ -444,19 +444,19 @@ 
   $fleet_event_count = 0;
   $fleet_flying_sorter = array();
   $fleet_flying_events = array();
-  foreach($FleetList->_container as $objFleet) {
+  foreach ($FleetList->_container as $objFleet) {
     $will_return = true;
-    if(!$objFleet->isReturning()) {
+    if (!$objFleet->isReturning()) {
       // cut fleets on Hold and Expedition
-      if($objFleet->time_arrive_to_target >= SN_TIME_NOW) {
+      if ($objFleet->time_arrive_to_target >= SN_TIME_NOW) {
         $objFleet->mission_type == MT_RELOCATE ? $will_return = false : false;
         tpl_topnav_event_build_helper($objFleet->time_arrive_to_target, EVENT_FLEET_ARRIVE, classLocale::$lang['sys_event_arrive'], $objFleet->target_coordinates_typed(), !$will_return, $objFleet, $fleet_flying_sorter, $fleet_flying_events, $fleet_event_count);
       }
-      if($objFleet->time_mission_job_complete) {
+      if ($objFleet->time_mission_job_complete) {
         tpl_topnav_event_build_helper($objFleet->time_mission_job_complete, EVENT_FLEET_STAY, classLocale::$lang['sys_event_stay'], $objFleet->target_coordinates_typed(), false, $objFleet, $fleet_flying_sorter, $fleet_flying_events, $fleet_event_count);
       }
     }
-    if($will_return) {
+    if ($will_return) {
       tpl_topnav_event_build_helper($objFleet->time_return_to_source, EVENT_FLEET_RETURN, classLocale::$lang['sys_event_return'], $objFleet->launch_coordinates_typed(), true, $objFleet, $fleet_flying_sorter, $fleet_flying_events, $fleet_event_count);
     }
   }
@@ -464,7 +464,7 @@ 
   asort($fleet_flying_sorter);
 
   $fleet_flying_count = $FleetList->count();
-  foreach($fleet_flying_sorter as $fleet_event_id => $fleet_time) {
+  foreach ($fleet_flying_sorter as $fleet_event_id => $fleet_time) {
     $fleet_event = &$fleet_flying_events[$fleet_event_id];
     $template->assign_block_vars("flying_{$type}s", array(
       'TIME' => max(0, $fleet_time - SN_TIME_NOW),
@@ -493,7 +493,7 @@ 
   global $template_result;
   $classLocale = classLocale::$lang;
 
-  if(!is_array($user)) {
+  if (!is_array($user)) {
     return '';
   }
 
@@ -514,8 +514,8 @@ 
 
   $ThisUsersPlanets = DBStaticPlanet::db_planet_list_sorted($user);
   // while ($CurPlanet = db_fetch($ThisUsersPlanets))
-  foreach($ThisUsersPlanets as $CurPlanet) {
-    if($CurPlanet['destruyed']) {
+  foreach ($ThisUsersPlanets as $CurPlanet) {
+    if ($CurPlanet['destruyed']) {
       continue;
     }
 
@@ -539,8 +539,8 @@ 
    */
   $fleet_flying_list = array();
   $fleet_flying_list[0] = FleetList::dbGetFleetListByOwnerId($user['id']);
-  foreach($fleet_flying_list[0]->_container as $fleet_id => $objFleet) {
-    if(empty($fleet_flying_list[$objFleet->mission_type])) {
+  foreach ($fleet_flying_list[0]->_container as $fleet_id => $objFleet) {
+    if (empty($fleet_flying_list[$objFleet->mission_type])) {
       $fleet_flying_list[$objFleet->mission_type] = new FleetList();
     }
     $fleet_flying_list[$objFleet->mission_type][$fleet_id] = $objFleet;
@@ -552,8 +552,8 @@ 
   que_tpl_parse($template, QUE_RESEARCH, $user, array(), null, !classSupernova::$user_options[PLAYER_OPTION_NAVBAR_RESEARCH_WIDE]);
   que_tpl_parse($template, SUBQUE_FLEET, $user, $planetrow, null, true);
 
-  if(!empty(classSupernova::$sn_mvc['navbar_prefix_button']) && is_array(classSupernova::$sn_mvc['navbar_prefix_button'])) {
-    foreach(classSupernova::$sn_mvc['navbar_prefix_button'] as $navbar_button_image => $navbar_button_url) {
+  if (!empty(classSupernova::$sn_mvc['navbar_prefix_button']) && is_array(classSupernova::$sn_mvc['navbar_prefix_button'])) {
+    foreach (classSupernova::$sn_mvc['navbar_prefix_button'] as $navbar_button_image => $navbar_button_url) {
       $template->assign_block_vars('navbar_prefix_button', array(
         'IMAGE'        => $navbar_button_image,
         'URL_RELATIVE' => $navbar_button_url,
@@ -567,13 +567,13 @@ 
   $time_now_parsed = getdate(SN_TIME_NOW);
   $time_local_parsed = getdate(defined('SN_CLIENT_TIME_LOCAL') ? SN_CLIENT_TIME_LOCAL : SN_TIME_NOW);
 
-  if(classSupernova::$config->game_news_overview) {
+  if (classSupernova::$config->game_news_overview) {
     $user_last_read_safe = intval($user['news_lastread']);
     nws_render($template, "WHERE UNIX_TIMESTAMP(`tsTimeStamp`) >= {$user_last_read_safe}", classSupernova::$config->game_news_overview);
   }
 
   $notes_query = DBStaticNote::db_note_list_by_owner($user['id'], true);
-  while($note_row = db_fetch($notes_query)) {
+  while ($note_row = db_fetch($notes_query)) {
     note_assign($template, $note_row);
   }
 
@@ -587,7 +587,7 @@ 
     'QUE_ID'   => QUE_RESEARCH,
     'QUE_HTML' => 'topnav',
 
-    'RESEARCH_ONGOING' => (boolean)$user['que'],
+    'RESEARCH_ONGOING' => (boolean) $user['que'],
 
     'TIME_TEXT'       => sprintf($str_date_format, $time_now_parsed['year'], classLocale::$lang['months'][$time_now_parsed['mon']], $time_now_parsed['mday'],
       $time_now_parsed['hours'], $time_now_parsed['minutes'], $time_now_parsed['seconds']
@@ -664,7 +664,7 @@ 
     'QUE_STRUCTURES' => QUE_STRUCTURES,
   ));
 
-  if((defined('SN_RENDER_NAVBAR_PLANET') && SN_RENDER_NAVBAR_PLANET === true) || ($user['option_list'][OPT_INTERFACE]['opt_int_navbar_resource_force'] && SN_RENDER_NAVBAR_PLANET !== false)) {
+  if ((defined('SN_RENDER_NAVBAR_PLANET') && SN_RENDER_NAVBAR_PLANET === true) || ($user['option_list'][OPT_INTERFACE]['opt_int_navbar_resource_force'] && SN_RENDER_NAVBAR_PLANET !== false)) {
     tpl_set_resource_info($template, $planetrow);
     $template->assign_vars(array(
       'SN_RENDER_NAVBAR_PLANET' => true,
@@ -679,12 +679,12 @@ 
  * @param template|string $template
  */
 function displayP($template) {
-  if(is_object($template)) {
-    if(empty($template->parsed)) {
+  if (is_object($template)) {
+    if (empty($template->parsed)) {
       parsetemplate($template);
     }
 
-    foreach($template->files as $section => $filename) {
+    foreach ($template->files as $section => $filename) {
       $template->display($section);
     }
   } else {
@@ -699,11 +699,11 @@ 
  * @return mixed
  */
 function parsetemplate($template, $array = false) {
-  if(is_object($template)) {
+  if (is_object($template)) {
     global $user;
 
-    if(!empty($array) && is_array($array)) {
-      foreach($array as $key => $data) {
+    if (!empty($array) && is_array($array)) {
+      foreach ($array as $key => $data) {
         $template->assign_var($key, $data);
       }
     }
@@ -744,7 +744,7 @@ 
 
   $template_ex = '.tpl.html';
 
-  if($template === false) {
+  if ($template === false) {
     return sys_file_read(TEMPLATE_DIR . '/' . $files . $template_ex);
   }
 
@@ -764,7 +764,7 @@ 
   !empty(classSupernova::$sn_mvc['i18n']['']) ? lng_load_i18n(classSupernova::$sn_mvc['i18n']['']) : false;
   $sn_page_name ? lng_load_i18n(classSupernova::$sn_mvc['i18n'][$sn_page_name]) : false;
 
-  foreach($files as &$filename) {
+  foreach ($files as &$filename) {
     $filename = $filename . $template_ex;
   }
 
@@ -789,13 +789,13 @@ 
     'LANG'     => $language ? $language : '',
     'referral' => $id_ref ? '&id_ref=' . $id_ref : '',
 
-    'REQUEST_PARAMS' => !empty($url_params) ? '?' . implode('&', $url_params) : '',// "?lang={$language}" . ($id_ref ? "&id_ref={$id_ref}" : ''),
+    'REQUEST_PARAMS' => !empty($url_params) ? '?' . implode('&', $url_params) : '', // "?lang={$language}" . ($id_ref ? "&id_ref={$id_ref}" : ''),
     'FILENAME'       => basename($_SERVER['PHP_SELF']),
   ));
 
-  foreach(lng_get_list() as $lng_id => $lng_data) {
-    if(isset($lng_data['LANG_VARIANTS']) && is_array($lng_data['LANG_VARIANTS'])) {
-      foreach($lng_data['LANG_VARIANTS'] as $lang_variant) {
+  foreach (lng_get_list() as $lng_id => $lng_data) {
+    if (isset($lng_data['LANG_VARIANTS']) && is_array($lng_data['LANG_VARIANTS'])) {
+      foreach ($lng_data['LANG_VARIANTS'] as $lang_variant) {
         $lng_data1 = $lng_data;
         $lng_data1 = array_merge($lng_data1, $lang_variant);
         $template->assign_block_vars('language', $lng_data1);
@@ -818,8 +818,8 @@ 
   $que = $que['ques'][$que_type][$planet['id_owner']][$planet['id']];
 
   $que_length = 0;
-  if(!empty($que)) {
-    foreach($que as $que_item) {
+  if (!empty($que)) {
+    foreach ($que as $que_item) {
       $template->assign_block_vars('que', que_tpl_parse_element($que_item));
     }
     $que_length = count($que);
@@ -834,7 +834,7 @@ 
  * @param int      $user_dark_matter
  */
 function tpl_planet_density_info(&$template, &$density_price_chart, $user_dark_matter) {
-  foreach($density_price_chart as $density_price_index => &$density_price_data) {
+  foreach ($density_price_chart as $density_price_index => &$density_price_data) {
     $density_cost = $density_price_data;
     $density_number_style = pretty_number($density_cost, true, $user_dark_matter, false, false);
 
@@ -858,7 +858,7 @@ 
 function tpl_assign_select(&$template, $name, $values) {
   !is_array($values) ? $values = array($values => $values) : false;
 
-  foreach($values as $key => $value) {
+  foreach ($values as $key => $value) {
     $template->assign_block_vars($name, array(
       'KEY'   => htmlentities($key, ENT_COMPAT, 'UTF-8'),
       'VALUE' => htmlentities($value, ENT_COMPAT, 'UTF-8'),