supernova-ws / SuperNova

classes/sn_module_payment.php

Doc Comments +7 added lines, -1 removed lines

@@ -702,7 +702,7 @@ 
    * Рассчёт бонуса ММ
    *
    * @param            $dark_matter
-   * @param bool|true  $direct
+   * @param boolean  $direct
    * @param bool|false $return_bonus
    *
    * @return float|int
@@ -738,6 +738,12 @@ 
 
   // Дополнительная ре-трансляция адреса, если в каком-то случае платежная система ожидает нелогичный ответ
   // Пример: иксолла при неправильно заданном пользователе в ордере ожидает НЕПРАВИЛЬНЫЙ_ОРДЕР, а не НЕПРАВИЛЬНЫЙ_ПОЛЬЗОВАТЕЛЬ
+
+  /**
+   * @param integer $error_code
+   *
+   * @return integer|null
+   */
   function retranslate_error($error_code, $options = array()) {
     return isset($options['retranslate_error'][$error_code]) ? $options['retranslate_error'][$error_code] : $error_code;
   }

Spacing +67 added lines, -67 removed lines

@@ -448,7 +448,7 @@ 
   public function compile_request($request) {
     global $user;
 
-    if(!(classSupernova::$auth->account instanceof Account)) {
+    if (!(classSupernova::$auth->account instanceof Account)) {
       // TODO - throw new Exception(lang['pay_msg_mm_request_amount_invalid'], SN_PAYMENT_REQUEST_ERROR_UNIT_AMOUNT);
     }
     $this->account = classSupernova::$auth->account;
@@ -469,15 +469,15 @@ 
     $this->payment_currency = classSupernova::$config->payment_currency_default;
     $this->payment_amount = self::currency_convert($this->payment_dark_matter_paid, 'MM_', $this->payment_currency);
 
-    if(empty($this->payment_external_currency) && !empty($this->config['currency'])) {
+    if (empty($this->payment_external_currency) && !empty($this->config['currency'])) {
       $this->payment_external_currency = $this->config['currency'];
     }
-    if(empty($this->payment_external_currency)) {
+    if (empty($this->payment_external_currency)) {
       throw new Exception(classLocale::$lang['pay_error_internal_no_external_currency_set'], SN_PAYMENT_ERROR_INTERNAL_NO_EXTERNAL_CURRENCY_SET);
     }
 
     $this->payment_external_amount = self::currency_convert($this->payment_dark_matter_paid, 'MM_', $this->payment_external_currency);
-    if($this->payment_external_amount < 0.01) {
+    if ($this->payment_external_amount < 0.01) {
       throw new Exception(classLocale::$lang['pay_msg_mm_request_amount_invalid'], SN_PAYMENT_REQUEST_ERROR_UNIT_AMOUNT);
     }
 
@@ -486,7 +486,7 @@ 
     $this->generate_description();
 
     $this->db_insert();
-    if(!$this->is_exists) {
+    if (!$this->is_exists) {
       throw new Exception(classLocale::$lang['pay_msg_request_error_db_payment_create'], SN_PAYMENT_REQUEST_DB_ERROR_PAYMENT_CREATE);
     }
   }
@@ -498,26 +498,26 @@ 
    * @throws Exception
    */
   protected function payment_request_process($options = array()) {
-    if(!$this->manifest['active']) {
+    if (!$this->manifest['active']) {
       throw new Exception(classLocale::$lang['pay_msg_module_disabled'], SN_MODULE_DISABLED);
     }
 
     // Если есть payment_id - загружаем под него данные
-    if(!empty($this->payment_params['payment_id'])) {
+    if (!empty($this->payment_params['payment_id'])) {
       $this->request_payment_id = sys_get_param_id($this->payment_params['payment_id']);
-      if(!$this->request_payment_id) {
+      if (!$this->request_payment_id) {
         throw new Exception(classLocale::$lang['pay_msg_request_payment_id_invalid'], SN_PAYMENT_REQUEST_INTERNAL_ID_WRONG);
       }
 
-      if(!$this->db_get_by_id($this->request_payment_id)) {
+      if (!$this->db_get_by_id($this->request_payment_id)) {
         throw new Exception(classLocale::$lang['pay_msg_request_payment_id_invalid'], SN_PAYMENT_REQUEST_INTERNAL_ID_WRONG);
       }
 
       // Проверяем - был ли этот платеж обработан?
       // TODO - Статусы бывают разные. Нужен спецфлаг payment_processed
-      if($this->payment_status != PAYMENT_STATUS_NONE) {
+      if ($this->payment_status != PAYMENT_STATUS_NONE) {
         sn_db_transaction_rollback();
-        sys_redirect(SN_ROOT_VIRTUAL . 'metamatter.php?payment_id=' . $this->payment_id);
+        sys_redirect(SN_ROOT_VIRTUAL.'metamatter.php?payment_id='.$this->payment_id);
         die();
       }
     }
@@ -525,89 +525,89 @@ 
     // Пытаемся получить из запроса ИД аккаунта
     $request_account_id = !empty($this->payment_params['account_id']) ? sys_get_param_id($this->payment_params['account_id']) : 0;
     // Если в запросе нет ИД аккаунта - пытаемся использовать payment_account_id
-    if(empty($request_account_id) && !empty($this->payment_account_id)) {
+    if (empty($request_account_id) && !empty($this->payment_account_id)) {
       $request_account_id = $this->payment_account_id;
     }
     // Если теперь у нас нету ИД аккаунта ни в запросе, ни в записи таблицы - можно паниковать
-    if(empty($request_account_id)) {
+    if (empty($request_account_id)) {
       // TODO - аккаунт
       throw new Exception(classLocale::$lang['pay_msg_request_user_invalid'], $this->retranslate_error(SN_PAYMENT_REQUEST_USER_NOT_FOUND, $options));
     }
     // Если нет записи в таблице - тогда берем payment_account_id из запроса
-    if(empty($this->payment_account_id)) {
+    if (empty($this->payment_account_id)) {
       $this->payment_account_id = $request_account_id;
     }
     // Если у нас отличаются ИД аккаунта в запросе и ИД аккаунта в записи - тоже можно паниковать
-    if($this->payment_account_id != $request_account_id) {
+    if ($this->payment_account_id != $request_account_id) {
       // TODO - Поменять сообщение об ошибке
       throw new Exception(classLocale::$lang['pay_msg_request_user_invalid'], $this->retranslate_error(SN_PAYMENT_REQUEST_USER_NOT_FOUND, $options));
     }
     // Проверяем существование аккаунта с данным ИД
-    if(!$this->account->db_get_by_id($this->payment_account_id)) {
-      throw new Exception(classLocale::$lang['pay_msg_request_user_invalid'] . ' ID ' . $this->payment_account_id, $this->retranslate_error(SN_PAYMENT_REQUEST_USER_NOT_FOUND, $options));
+    if (!$this->account->db_get_by_id($this->payment_account_id)) {
+      throw new Exception(classLocale::$lang['pay_msg_request_user_invalid'].' ID '.$this->payment_account_id, $this->retranslate_error(SN_PAYMENT_REQUEST_USER_NOT_FOUND, $options));
     }
 
     // TODO Проверка на сервер_ид - как бы и не нужна, наверное?
-    if(!empty($this->payment_params['server_id'])) {
+    if (!empty($this->payment_params['server_id'])) {
       $this->request_server_id = sys_get_param_str($this->payment_params['server_id']);
-      if(SN_ROOT_VIRTUAL != $this->request_server_id) {
-        throw new Exception(classLocale::$lang['pay_msg_request_server_wrong'] . " {$this->request_server_id} вместо " . SN_ROOT_VIRTUAL, SN_PAYMENT_REQUEST_SERVER_WRONG);
+      if (SN_ROOT_VIRTUAL != $this->request_server_id) {
+        throw new Exception(classLocale::$lang['pay_msg_request_server_wrong']." {$this->request_server_id} вместо ".SN_ROOT_VIRTUAL, SN_PAYMENT_REQUEST_SERVER_WRONG);
       }
     }
 
     // Сверка количества оплаченной ММ с учётом бонусов
-    if(!empty($this->payment_params['payment_dark_matter_gained'])) {
+    if (!empty($this->payment_params['payment_dark_matter_gained'])) {
       $request_mm_amount = sys_get_param_id($this->payment_params['payment_dark_matter_gained']);
-      if($request_mm_amount != $this->payment_dark_matter_gained && $this->is_loaded) {
-        throw new Exception(classLocale::$lang['pay_msg_mm_request_amount_invalid'] . " пришло {$request_mm_amount} ММ вместо {$this->payment_dark_matter_gained} ММ", SN_PAYMENT_REQUEST_MM_AMOUNT_INVALID);
+      if ($request_mm_amount != $this->payment_dark_matter_gained && $this->is_loaded) {
+        throw new Exception(classLocale::$lang['pay_msg_mm_request_amount_invalid']." пришло {$request_mm_amount} ММ вместо {$this->payment_dark_matter_gained} ММ", SN_PAYMENT_REQUEST_MM_AMOUNT_INVALID);
       }
       empty($this->payment_dark_matter_gained) ? $this->payment_dark_matter_gained = $request_mm_amount : false;
     }
-    if(empty($this->payment_dark_matter_paid)) {
+    if (empty($this->payment_dark_matter_paid)) {
       // TODO - обратный расчёт из gained
     }
 
     // Проверка наличия внешнего ИД платежа
-    if(!empty($this->payment_params['payment_external_id'])) {
+    if (!empty($this->payment_params['payment_external_id'])) {
       $request_payment_external_id = sys_get_param_id($this->payment_params['payment_external_id']);
-      if(empty($request_payment_external_id)) {
+      if (empty($request_payment_external_id)) {
         throw new exception(classLocale::$lang['pay_msg_request_payment_id_invalid'], SN_PAYMENT_REQUEST_EXTERNAL_ID_WRONG);
-      } elseif(!empty($this->payment_external_id) && $this->payment_external_id != $request_payment_external_id) {
+      } elseif (!empty($this->payment_external_id) && $this->payment_external_id != $request_payment_external_id) {
         // TODO - Может быть поменять сообщение
         throw new exception(classLocale::$lang['pay_msg_request_payment_id_invalid'], SN_PAYMENT_REQUEST_EXTERNAL_ID_WRONG);
       }
       $this->payment_external_id = $request_payment_external_id;
     }
     // Сверка суммы, запрошенной СН к оплате
-    if(!empty($this->payment_params['payment_external_money'])) {
+    if (!empty($this->payment_params['payment_external_money'])) {
       $request_money_out = sys_get_param_float($this->payment_params['payment_external_money']);
-      if($request_money_out != $this->payment_external_amount && $this->is_loaded) {
-        throw new Exception(classLocale::$lang['pay_msg_request_payment_amount_invalid'] . " пришло {$request_money_out} денег вместо {$this->payment_external_amount} денег", SN_PAYMENT_REQUEST_CURRENCY_AMOUNT_INVALID);
+      if ($request_money_out != $this->payment_external_amount && $this->is_loaded) {
+        throw new Exception(classLocale::$lang['pay_msg_request_payment_amount_invalid']." пришло {$request_money_out} денег вместо {$this->payment_external_amount} денег", SN_PAYMENT_REQUEST_CURRENCY_AMOUNT_INVALID);
       }
       empty($this->payment_external_amount) ? $this->payment_external_amount = $request_money_out : false;
     }
     // Заполняем поле валюты платёжной системы
-    if(!empty($this->payment_params['payment_external_currency'])) {
+    if (!empty($this->payment_params['payment_external_currency'])) {
       $this->payment_external_currency = sys_get_param_str($this->payment_params['payment_external_currency']);
-      if(empty($this->payment_external_currency)) {
+      if (empty($this->payment_external_currency)) {
         // TODO - поменять сообщение
-        throw new Exception(classLocale::$lang['pay_msg_request_payment_amount_invalid'] . " {$this->payment_external_currency}", SN_PAYMENT_REQUEST_CURRENCY_AMOUNT_INVALID);
+        throw new Exception(classLocale::$lang['pay_msg_request_payment_amount_invalid']." {$this->payment_external_currency}", SN_PAYMENT_REQUEST_CURRENCY_AMOUNT_INVALID);
       }
     }
-    if(empty($this->payment_external_currency)) {
+    if (empty($this->payment_external_currency)) {
       $this->payment_external_currency = $this->config['currency'];
     }
 
     // Заполнение внутренней суммы и валюты из внешних данных
-    if(empty($this->payment_currency)) {
+    if (empty($this->payment_currency)) {
       $this->payment_currency = classSupernova::$config->payment_currency_default;
     }
-    if(empty($this->payment_amount) && !empty($this->payment_external_currency)) {
+    if (empty($this->payment_amount) && !empty($this->payment_external_currency)) {
       $this->payment_amount = self::currency_convert($this->payment_external_amount, $this->payment_external_currency, $this->payment_currency);
     }
 
     // TODO - Тестовый режим
-    if(!empty($this->payment_params['test'])) {
+    if (!empty($this->payment_params['test'])) {
       $this->payment_test = $this->config['test'] || sys_get_param_int($this->payment_params['test']);
     }
 
@@ -634,21 +634,21 @@ 
     sn_db_transaction_start();
     try {
       $response = $this->payment_request_process();
-    } catch(Exception $e) {
+    } catch (Exception $e) {
       $response['result'] = $e->getCode();
       $response['message'] = $e->getMessage();
     }
 
-    if($response['result'] == SN_PAYMENT_REQUEST_OK) {
+    if ($response['result'] == SN_PAYMENT_REQUEST_OK) {
       sn_db_transaction_commit();
-      classSupernova::$debug->warning('Результат операции: код ' . $response['result'] . ' сообщение "' . $response['message'] . '"', 'Успешный платёж', LOG_INFO_PAYMENT);
+      classSupernova::$debug->warning('Результат операции: код '.$response['result'].' сообщение "'.$response['message'].'"', 'Успешный платёж', LOG_INFO_PAYMENT);
     } else {
       sn_db_transaction_rollback();
-      classSupernova::$debug->warning('Результат операции: код ' . $response['result'] . ' сообщение "' . $response['message'] . '"', 'Ошибка платежа', LOG_INFO_PAYMENT, true);
+      classSupernova::$debug->warning('Результат операции: код '.$response['result'].' сообщение "'.$response['message'].'"', 'Ошибка платежа', LOG_INFO_PAYMENT, true);
     }
 
     // Переводим код результата из СН в код платежной системы
-    if(is_array($this->result_translations) && !empty($this->result_translations)) {
+    if (is_array($this->result_translations) && !empty($this->result_translations)) {
       $response['result'] = isset($this->result_translations[$response['result']]) ? $this->result_translations[$response['result']] : $this->result_translations[SN_PAYMENT_REQUEST_UNDEFINED_ERROR];
     }
 
@@ -671,7 +671,7 @@ 
     $currency_from = strtolower($currency_from);
     $currency_to = strtolower($currency_to);
 
-    if($currency_from != $currency_to) {
+    if ($currency_from != $currency_to) {
       $exchange_from = get_exchange_rate($currency_from);
       $exchange_to = get_exchange_rate($currency_to);
 
@@ -695,10 +695,10 @@ 
   public static function bonus_calculate($dark_matter, $direct = true, $return_bonus = false) {
     $bonus = 0;
     $dark_matter_new = $dark_matter;
-    if(!empty(self::$bonus_table) && $dark_matter >= self::$bonus_table[0]) {
-      if($direct) {
-        foreach(self::$bonus_table as $dm_for_bonus => $multiplier) {
-          if($dm_for_bonus <= $dark_matter) {
+    if (!empty(self::$bonus_table) && $dark_matter >= self::$bonus_table[0]) {
+      if ($direct) {
+        foreach (self::$bonus_table as $dm_for_bonus => $multiplier) {
+          if ($dm_for_bonus <= $dark_matter) {
             $dark_matter_new = $dark_matter * (1 + $multiplier);
             $bonus = $multiplier;
           } else {
@@ -706,9 +706,9 @@ 
           }
         }
       } else {
-        foreach(self::$bonus_table as $dm_for_bonus => $multiplier) {
+        foreach (self::$bonus_table as $dm_for_bonus => $multiplier) {
           $temp = $dm_for_bonus * (1 + $multiplier);
-          if($dark_matter >= $temp) {
+          if ($dark_matter >= $temp) {
             $dark_matter_new = round($dark_matter / (1 + $multiplier));
             $bonus = $multiplier;
           } else {
@@ -761,7 +761,7 @@ 
       'payment_external_lots' => $this->payment_dark_matter_paid / get_mm_cost(),
     );
 
-    if($this->payment_id) {
+    if ($this->payment_id) {
       $payment['payment_id'] = $this->payment_id;
       classSupernova::$gc->db->doReplaceSet('payment', $payment);
     } else {
@@ -773,12 +773,12 @@ 
 
 
   public function payment_adjust_mm_new() {
-    if(!$this->payment_test) {
+    if (!$this->payment_test) {
       // Not a test payment. Adding DM to account
       $this->account = new Account($this->db);
       $this->account->db_get_by_id($this->payment_account_id);
       $result = $this->account->metamatter_change(RPG_PURCHASE, $this->payment_dark_matter_gained, $this->payment_comment);
-      if(!$result) {
+      if (!$result) {
         throw new Exception('Ошибка начисления ММ', SN_METAMATTER_ERROR_ADJUST);
       }
     }
@@ -787,25 +787,25 @@ 
   public function payment_cancel(&$payment) {
     die('{НЕ РАБОТАЕТ! СООБЩИТЕ АДМИНИСТРАЦИИ!}');
 
-    if(!isset($payment['payment_status'])) {
+    if (!isset($payment['payment_status'])) {
       throw new exception(classLocale::$lang['pay_msg_request_payment_not_found'], SN_PAYMENT_REQUEST_ORDER_NOT_FOUND);
     }
 
-    if($payment['payment_status'] == PAYMENT_STATUS_COMPLETE) {
-      $comment_unsafe = $payment['payment_comment'] = classLocale::$lang['pay_msg_request_payment_cancelled'] .' ' . $payment['payment_comment'];
+    if ($payment['payment_status'] == PAYMENT_STATUS_COMPLETE) {
+      $comment_unsafe = $payment['payment_comment'] = classLocale::$lang['pay_msg_request_payment_cancelled'].' '.$payment['payment_comment'];
 
-      if(!$payment['payment_test']) {
+      if (!$payment['payment_test']) {
         $result = $this->account->metamatter_change(RPG_PURCHASE_CANCEL, -$payment['payment_dark_matter_gained'], $payment['payment_comment']);
-        if(!$result) {
+        if (!$result) {
           throw new exception('Ошибка начисления ММ', SN_METAMATTER_ERROR_ADJUST);
         }
       }
       $payment['payment_status'] = PAYMENT_STATUS_CANCELED;
       db_payment_update($payment['payment_id'], $payment['payment_status'], $comment_unsafe);
       throw new exception(classLocale::$lang['pay_msg_request_payment_cancel_complete'], SN_PAYMENT_REQUEST_OK);
-    } elseif($payment['payment_status'] == PAYMENT_STATUS_CANCELED) {
+    } elseif ($payment['payment_status'] == PAYMENT_STATUS_CANCELED) {
       throw new exception(classLocale::$lang['pay_msg_request_payment_cancelled_already'], SN_PAYMENT_REQUEST_OK);
-    } elseif($payment['payment_status'] == PAYMENT_STATUS_NONE) {
+    } elseif ($payment['payment_status'] == PAYMENT_STATUS_NONE) {
       throw new exception(classLocale::$lang['pay_msg_request_payment_cancel_not_complete'], SN_PAYMENT_REQUEST_PAYMENT_NOT_COMPLETE);
     }
   }
@@ -828,8 +828,8 @@ 
 
   protected function db_complete_payment() {
     // TODO - поле payment_processed
-    if($this->payment_status == PAYMENT_STATUS_NONE) {
-      if(!defined('PAYMENT_EXPIRE_TIME') || PAYMENT_EXPIRE_TIME == 0 || empty($this->payment_date) || strtotime($this->payment_date) + PAYMENT_EXPIRE_TIME <= SN_TIME_NOW) {
+    if ($this->payment_status == PAYMENT_STATUS_NONE) {
+      if (!defined('PAYMENT_EXPIRE_TIME') || PAYMENT_EXPIRE_TIME == 0 || empty($this->payment_date) || strtotime($this->payment_date) + PAYMENT_EXPIRE_TIME <= SN_TIME_NOW) {
         $this->payment_adjust_mm_new();
         $this->payment_status = PAYMENT_STATUS_COMPLETE;
       } else {
@@ -876,7 +876,7 @@ 
   protected function db_assign_payment($payment = null) {
     $this->payment_reset();
 
-    if(is_array($payment) && isset($payment['payment_id'])) {
+    if (is_array($payment) && isset($payment['payment_id'])) {
       $this->payment_id = $payment['payment_id'];
       $this->payment_status = $payment['payment_status'];
       $this->payment_date = $payment['payment_date'];
@@ -918,11 +918,11 @@ 
   protected function generate_description() {
     // TODO - системная локализация
     $this->description_generated = array(
-      PAYMENT_DESCRIPTION_100 => substr("{$this->payment_dark_matter_gained} ММ аккаунт [{$this->account->account_name}] ID {$this->account->account_id} на " . SN_ROOT_VIRTUAL, 0, 100),
-      PAYMENT_DESCRIPTION_250 => substr("Оплата {$this->payment_dark_matter_gained} ММ для аккаунта [{$this->payment_user_name}] ID {$this->payment_user_id} на сервере " . SN_ROOT_VIRTUAL, 0, 250),
-      PAYMENT_DESCRIPTION_MAX => ($this->payment_test ? "ТЕСТОВЫЙ ПЛАТЕЖ! " : '') .
-        "Платеж от аккаунта '{$this->payment_account_name}' ID {$this->payment_account_id} игрока '{$this->payment_user_name}' ID {$this->payment_user_id} на сервере " . SN_ROOT_VIRTUAL .
-        " сумма {$this->payment_amount} {$this->payment_currency} за {$this->payment_dark_matter_paid} ММ (начислено {$this->payment_dark_matter_gained} ММ)" .
+      PAYMENT_DESCRIPTION_100 => substr("{$this->payment_dark_matter_gained} ММ аккаунт [{$this->account->account_name}] ID {$this->account->account_id} на ".SN_ROOT_VIRTUAL, 0, 100),
+      PAYMENT_DESCRIPTION_250 => substr("Оплата {$this->payment_dark_matter_gained} ММ для аккаунта [{$this->payment_user_name}] ID {$this->payment_user_id} на сервере ".SN_ROOT_VIRTUAL, 0, 250),
+      PAYMENT_DESCRIPTION_MAX => ($this->payment_test ? "ТЕСТОВЫЙ ПЛАТЕЖ! " : '').
+        "Платеж от аккаунта '{$this->payment_account_name}' ID {$this->payment_account_id} игрока '{$this->payment_user_name}' ID {$this->payment_user_id} на сервере ".SN_ROOT_VIRTUAL.
+        " сумма {$this->payment_amount} {$this->payment_currency} за {$this->payment_dark_matter_paid} ММ (начислено {$this->payment_dark_matter_gained} ММ)".
         " через '{$this->manifest['name']}' сумма {$this->payment_external_amount} {$this->payment_external_currency}",
     );
   }

classes/SnCache.php

Doc Comments +24 added lines

@@ -121,6 +121,9 @@ 
     }
   }
 
+  /**
+   * @param string $filter
+   */
   public static function queryCacheSetByFilter($location_type, $filter, $record_id) {
     SnCache::$queries[$location_type][$filter][$record_id] = &SnCache::getDataRefByLocationAndId($location_type, $record_id);
   }
@@ -160,14 +163,23 @@ 
     return true; // Не всегда - от результата
   }
 
+  /**
+   * @param integer $locationType
+   */
   public static function getData($locationType = LOC_NONE) {
     return $locationType == LOC_NONE ? static::$data : static::$data[$locationType];
   }
 
+  /**
+   * @param integer $locationType
+   */
   public static function cacheUnsetElement($locationType, $recordId) {
     static::$data[$locationType][$recordId] = null;
   }
 
+  /**
+   * @param integer $locationType
+   */
   public static function isArrayLocation($locationType) {
     return is_array(static::$data[$locationType]);
   }
@@ -190,6 +202,9 @@ 
     }
   }
 
+  /**
+   * @param integer $unit_snid
+   */
   public static function getUnitLocator($location_type, $location_id, $unit_snid) {
     return $unit_snid ? static::$locator[LOC_UNIT][$location_type][$location_id][$unit_snid] : static::$locator[LOC_UNIT][$location_type][$location_id];
   }
@@ -222,14 +237,23 @@ 
     return static::$locks;
   }
 
+  /**
+   * @param string $filter
+   */
   public static function getQueriesByLocationAndFilter($locationType, $filter) {
     return !empty(static::$queries[$locationType][$filter]) && is_array(static::$queries[$locationType][$filter]) ? static::$queries[$locationType][$filter] : array();
   }
 
+  /**
+   * @param string $filter
+   */
   public static function isQueryCacheByLocationAndFilterEmpty($locationType, $filter) {
     return !isset(SnCache::$queries[$locationType][$filter]) || SnCache::$queries[$locationType][$filter] === null;
   }
 
+  /**
+   * @param string $filter
+   */
   public static function queryCacheResetByLocationAndFilter($locationType, $filter) {
     SnCache::$queries[$locationType][$filter] = array();
   }

classes/SnDbCachedOperator.php

Doc Comments +4 added lines, -1 removed lines

@@ -314,6 +314,9 @@ 
     return $result;
   }
 
+  /**
+   * @param integer $location_type
+   */
   public static function db_ins_field_set($location_type, $field_set, $serialize = false) {
     // TODO multiinsert
     !sn_db_field_set_is_safe($field_set) ? $field_set = sn_db_field_set_make_safe($field_set, $serialize) : false;
@@ -350,7 +353,7 @@ 
   /**
    * Блокирует указанные таблицу/список таблиц
    *
-   * @param string|array $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
+   * @param string $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов
    * <p>string - название таблицы для блокировки</p>
    * <p>array - массив, где ключ - имя таблицы, а значение - условия блокировки элементов</p>
    */

Indentation +1 added lines, -1 removed lines

@@ -230,7 +230,7 @@
               array("distinct({{{$location_info[P_TABLE_NAME]}}}.{$owner_data[P_OWNER_FIELD]}) AS parent_id"),
               $filter,
               // Always selecting all records for correctly perform FILTER locks
-               $fetch ? DB_RECORD_ONE : DB_RECORDS_ALL,
+                $fetch ? DB_RECORD_ONE : DB_RECORDS_ALL,
 //              DB_RECORDS_ALL,
               DB_SELECT_PLAIN
             );

Spacing +10 added lines, -10 removed lines

@@ -193,13 +193,13 @@ 
    */
   // TODO - Change $filter to only array class
   public function db_get_record_list($location_type, $filter = '', $fetch = false, $no_return = false) {
-    if(is_array($filter)) {
+    if (is_array($filter)) {
       // TODO - TEMPORARY
       $filterString = array();
-      if(!empty($filter)) {
+      if (!empty($filter)) {
         foreach ($filter as $key => $value) {
-          if(!is_int($key)) {
-            $value = "`$key` = '" . $this->db->db_escape($value). "'";
+          if (!is_int($key)) {
+            $value = "`$key` = '".$this->db->db_escape($value)."'";
           }
           $filterString[$key] = $value;
         }
@@ -207,7 +207,7 @@ 
 
       $filterString = implode(',', $filterString);
     } else {
-      $filterString =  $filter;
+      $filterString = $filter;
     }
 
 
@@ -238,8 +238,8 @@ 
             $query = $this->db->doSelect(
               "SELECT
               distinct({{{$location_info[P_TABLE_NAME]}}}.{$owner_data[P_OWNER_FIELD]}) AS parent_id
-            FROM {{{$location_info[P_TABLE_NAME]}}}" .
-              ($filter ? ' WHERE ' . $filter : '') .
+            FROM {{{$location_info[P_TABLE_NAME]}}}".
+              ($filter ? ' WHERE '.$filter : '').
               ($fetch ? ' LIMIT 1' : ''));
           }
           while ($row = db_fetch($query)) {
@@ -254,7 +254,7 @@ 
             $indexes_str = implode(',', $parent_id_list);
             $parent_id_field = static::$location_info[$owner_location_type][P_ID];
             $this->db_get_record_list($owner_location_type,
-              $parent_id_field . (
+              $parent_id_field.(
                 count($parent_id_list) > 1
                 ? " IN ({$indexes_str})"
                 : " = {$indexes_str}"
@@ -277,7 +277,7 @@ 
         );
       } else {
         $query = $this->db->doSelect(
-          "SELECT * FROM {{{$location_info[P_TABLE_NAME]}}}" .
+          "SELECT * FROM {{{$location_info[P_TABLE_NAME]}}}".
           (($filter = trim($filter)) ? " WHERE {$filter}" : '')
           . " FOR UPDATE"
         );
@@ -455,7 +455,7 @@ 
   public function db_lock_tables($tables) {
     $tables = is_array($tables) ? $tables : array($tables => '');
     foreach ($tables as $table_name => $condition) {
-      $this->db->doSelect("SELECT 1 FROM {{{$table_name}}}" . ($condition ? ' WHERE ' . $condition : ''));
+      $this->db->doSelect("SELECT 1 FROM {{{$table_name}}}".($condition ? ' WHERE '.$condition : ''));
     }
   }
 }

Braces +3 added lines, -1 removed lines

@@ -298,9 +298,11 @@
     $set = trim($set);
     $table_name = static::$location_info[$location_type][P_TABLE_NAME];
     if ($result = $this->db->doInsert("INSERT INTO `{{{$table_name}}}` SET {$set}")) {
-      if ($this->db->db_affected_rows()) // Обновляем данные только если ряд был затронут
+      if ($this->db->db_affected_rows()) {
+        // Обновляем данные только если ряд был затронут
       {
         $record_id = $this->db->db_insert_id();
+      }
         // Вытаскиваем запись целиком, потому что в $set могли быть "данные по умолчанию"
         $result = $this->db_get_record_by_id($location_type, $record_id);
         // Очищаем второстепенные кэши - потому что вставленная запись могла повлиять на результаты запросов или локация или еще чего

classes/template.php

Doc Comments +1 added lines

@@ -103,6 +103,7 @@
   /**
   * Set custom template location (able to use directory outside of phpBB)
   * @access public
+  * @param string $template_path
   */
   function set_custom_template($template_path, $template_name, $fallback_template_path = false)
   {

Indentation +75 added lines, -75 removed lines

@@ -25,11 +25,11 @@ 
 class template
 {
   /** variable that holds all the data we'll be substituting into
-  * the compiled templates. Takes form:
-  * --> $this->_tpldata[block][iteration#][child][iteration#][child2][iteration#][variablename] == value
-  * if it's a root-level variable, it'll be like this:
-  * --> $this->_tpldata[.][0][varname] == value
-  */
+   * the compiled templates. Takes form:
+   * --> $this->_tpldata[block][iteration#][child][iteration#][child2][iteration#][variablename] == value
+   * if it's a root-level variable, it'll be like this:
+   * --> $this->_tpldata[.][0][varname] == value
+   */
   var $_tpldata = array('.' => array(0 => array()));
   var $_rootref;
 //  var $_block_counter = array();
@@ -60,9 +60,9 @@ 
   var $parsed = false;
 
   /**
-  * Set template location
-  * @access public
-  */
+   * Set template location
+   * @access public
+   */
   function set_template()
   {
     global $phpbb_root_path, $user;
@@ -101,9 +101,9 @@ 
   }
 
   /**
-  * Set custom template location (able to use directory outside of phpBB)
-  * @access public
-  */
+   * Set custom template location (able to use directory outside of phpBB)
+   * @access public
+   */
   function set_custom_template($template_path, $template_name, $fallback_template_path = false)
   {
     global $phpbb_root_path, $user;
@@ -142,10 +142,10 @@ 
   }
 
   /**
-  * Sets the template filenames for handles. $filename_array
-  * should be a hash of handle => filename pairs.
-  * @access public
-  */
+   * Sets the template filenames for handles. $filename_array
+   * should be a hash of handle => filename pairs.
+   * @access public
+   */
   function set_filenames($filename_array)
   {
     if (!is_array($filename_array))
@@ -172,9 +172,9 @@ 
   }
 
   /**
-  * Destroy template data set
-  * @access public
-  */
+   * Destroy template data set
+   * @access public
+   */
   function destroy()
   {
     $this->_tpldata = array('.' => array(0 => array()));
@@ -182,9 +182,9 @@ 
   }
 
   /**
-  * Reset/empty complete block
-  * @access public
-  */
+   * Reset/empty complete block
+   * @access public
+   */
   function destroy_block_vars($blockname)
   {
     if (strpos($blockname, '.') !== false)
@@ -212,9 +212,9 @@ 
   }
 
   /**
-  * Display handle
-  * @access public
-  */
+   * Display handle
+   * @access public
+   */
   function display($handle, $include_once = true)
   {
     global $user, $phpbb_hook, $lang, $config;
@@ -248,9 +248,9 @@ 
   }
 
   /**
-  * Display the handle and assign the output to a template variable or return the compiled result.
-  * @access public
-  */
+   * Display the handle and assign the output to a template variable or return the compiled result.
+   * @access public
+   */
   function assign_display($handle, $template_var = '', $return_content = true, $include_once = false)
   {
     ob_start();
@@ -268,9 +268,9 @@ 
   }
 
   /**
-  * Load a compiled template if possible, if not, recompile it
-  * @access private
-  */
+   * Load a compiled template if possible, if not, recompile it
+   * @access private
+   */
   function _tpl_load(&$handle)
   {
     global $user, $config;
@@ -453,9 +453,9 @@ 
   }
 
   /**
-  * Assign key variable pairs from an array
-  * @access public
-  */
+   * Assign key variable pairs from an array
+   * @access public
+   */
   function assign_vars($vararray)
   {
     foreach ($vararray as $key => $val)
@@ -467,9 +467,9 @@ 
   }
 
   /**
-  * Assign a single variable to a single key
-  * @access public
-  */
+   * Assign a single variable to a single key
+   * @access public
+   */
   function assign_var($varname, $varval)
   {
     $this->_rootref[$varname] = $varval;
@@ -478,9 +478,9 @@ 
   }
 
   /**
-  * Assign key variable pairs from an array to a specified block
-  * @access public
-  */
+   * Assign key variable pairs from an array to a specified block
+   * @access public
+   */
   function assign_block_vars($blockname, $vararray)
   {
     if (strpos($blockname, '.') !== false)
@@ -545,33 +545,33 @@ 
   }
 
   /**
-  * Change already assigned key variable pair (one-dimensional - single loop entry)
-  *
-  * An example of how to use this function:
-  * {@example alter_block_array.php}
-  *
-  * @param  string  $blockname  the blockname, for example 'loop'
-  * @param  array $vararray the var array to insert/add or merge
-  * @param  mixed $key    Key to search for
-  *
-  * array: KEY => VALUE [the key/value pair to search for within the loop to determine the correct position]
-  *
-  * int: Position [the position to change or insert at directly given]
-  *
-  * If key is false the position is set to 0
-  * If key is true the position is set to the last entry
-  *
-  * @param  string  $mode   Mode to execute (valid modes are 'insert' and 'change')
-  *
-  * If insert, the vararray is inserted at the given position (position counting from zero).
-  * If change, the current block gets merged with the vararray (resulting in new key/value pairs be added and existing keys be replaced by the new value).
-  *
-  * Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array)
-  * and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)
-  *
-  * @return bool false on error, true on success
-  * @access public
-  */
+   * Change already assigned key variable pair (one-dimensional - single loop entry)
+   *
+   * An example of how to use this function:
+   * {@example alter_block_array.php}
+   *
+   * @param  string  $blockname  the blockname, for example 'loop'
+   * @param  array $vararray the var array to insert/add or merge
+   * @param  mixed $key    Key to search for
+   *
+   * array: KEY => VALUE [the key/value pair to search for within the loop to determine the correct position]
+   *
+   * int: Position [the position to change or insert at directly given]
+   *
+   * If key is false the position is set to 0
+   * If key is true the position is set to the last entry
+   *
+   * @param  string  $mode   Mode to execute (valid modes are 'insert' and 'change')
+   *
+   * If insert, the vararray is inserted at the given position (position counting from zero).
+   * If change, the current block gets merged with the vararray (resulting in new key/value pairs be added and existing keys be replaced by the new value).
+   *
+   * Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array)
+   * and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)
+   *
+   * @return bool false on error, true on success
+   * @access public
+   */
   function alter_block_array($blockname, $vararray, $key = false, $mode = 'insert')
   {
     if (strpos($blockname, '.') !== false)
@@ -655,9 +655,9 @@ 
   }
 
   /**
-  * Include a separate template
-  * @access private
-  */
+   * Include a separate template
+   * @access private
+   */
   function _tpl_include($filename, $include = true)
   {
     global $lang, $config;
@@ -686,9 +686,9 @@ 
   }
 
   /**
-  * Include a php-file
-  * @access private
-  */
+   * Include a php-file
+   * @access private
+   */
   function _php_include($filename)
   {
     global $phpbb_root_path;
@@ -705,9 +705,9 @@ 
   }
 
   /**
-  * Assign key variable pairs from an array with block support
-  * @access public
-  */
+   * Assign key variable pairs from an array with block support
+   * @access public
+   */
   function assign_recursive($values, $name = '')
   {
     if(isset($values['.']))

Spacing +32 added lines, -32 removed lines

@@ -61,10 +61,10 @@ 
   {
     global $phpbb_root_path, $user;
 
-    if (file_exists($phpbb_root_path . 'styles/' . $user->theme['template_path'] . '/template'))
+    if (file_exists($phpbb_root_path.'styles/'.$user->theme['template_path'].'/template'))
     {
-      $this->root = $phpbb_root_path . 'styles/' . $user->theme['template_path'] . '/template';
-      $this->cachepath = $phpbb_root_path . 'cache/tpl_' . str_replace('_', '-', $user->theme['template_path']) . '_';
+      $this->root = $phpbb_root_path.'styles/'.$user->theme['template_path'].'/template';
+      $this->cachepath = $phpbb_root_path.'cache/tpl_'.str_replace('_', '-', $user->theme['template_path']).'_';
 
       if ($this->orig_tpl_storedb === null)
       {
@@ -81,12 +81,12 @@ 
 
       if ($user->theme['template_inherits_id'])
       {
-        $this->inherit_root = $phpbb_root_path . 'styles/' . $user->theme['template_inherit_path'] . '/template';
+        $this->inherit_root = $phpbb_root_path.'styles/'.$user->theme['template_inherit_path'].'/template';
       }
     }
     else
     {
-      trigger_error('Template path could not be found: styles/' . $user->theme['template_path'] . '/template', E_USER_ERROR);
+      trigger_error('Template path could not be found: styles/'.$user->theme['template_path'].'/template', E_USER_ERROR);
     }
 
     $this->_rootref = &$this->_tpldata['.'][0];
@@ -109,7 +109,7 @@ 
     }
 
     $this->root = $template_path;
-    $this->cachepath = $phpbb_root_path . 'cache/ctpl_' . str_replace('_', '-', $template_name) . '_';
+    $this->cachepath = $phpbb_root_path.'cache/ctpl_'.str_replace('_', '-', $template_name).'_';
 
     if ($fallback_template_path !== false)
     {
@@ -154,11 +154,11 @@ 
       }
 
       $this->filename[$handle] = $filename;
-      $this->files[$handle] = $this->root . '/' . $filename;
+      $this->files[$handle] = $this->root.'/'.$filename;
 
       if ($this->inherit_root)
       {
-        $this->files_inherit[$handle] = $this->inherit_root . '/' . $filename;
+        $this->files_inherit[$handle] = $this->inherit_root.'/'.$filename;
       }
     }
 
@@ -235,7 +235,7 @@ 
     }
     else
     {
-      eval(' ?>' . $this->compiled_code[$handle] . '<?php ');
+      eval(' ?>'.$this->compiled_code[$handle].'<?php ');
     }
 
     return true;
@@ -280,7 +280,7 @@ 
     //$user->theme['template_storedb'] = $this->orig_tpl_storedb;
     //$user->theme['template_inherits_id'] = $this->orig_tpl_inherits_id;
 
-    $filename = $this->cachepath . str_replace('/', '.', $this->filename[$handle]) . DOT_PHP_EX;
+    $filename = $this->cachepath.str_replace('/', '.', $this->filename[$handle]).DOT_PHP_EX;
     //$this->files_template[$handle] = (isset($user->theme['template_id'])) ? $user->theme['template_id'] : 0;
 
     $recompile = false;
@@ -309,7 +309,7 @@ 
 
     if (!class_exists('template_compile'))
     {
-      include($phpbb_root_path . 'includes/functions_template' . DOT_PHP_EX);
+      include($phpbb_root_path.'includes/functions_template'.DOT_PHP_EX);
     }
 
     // Inheritance - we point to another template file for this one. Equality is also used for store_db
@@ -348,10 +348,10 @@ 
       foreach ($ids as $id)
       {
         $sql = 'SELECT *
-        FROM ' . STYLES_TEMPLATE_DATA_TABLE . '
-        WHERE template_id = ' . $id . "
-          AND (template_filename = '" . $db->sql_escape($this->filename[$handle]) . "'
-            OR template_included " . $db->sql_like_expression($db->any_char . $this->filename[$handle] . ':' . $db->any_char) . ')';
+        FROM ' . STYLES_TEMPLATE_DATA_TABLE.'
+        WHERE template_id = ' . $id."
+          AND (template_filename = '" . $db->sql_escape($this->filename[$handle])."'
+            OR template_included " . $db->sql_like_expression($db->any_char.$this->filename[$handle].':'.$db->any_char).')';
 
         $result = $db->sql_query($sql);
         while ($row = $db->sql_fetchrow($result))
@@ -365,14 +365,14 @@ 
       {
         foreach ($rows as $row)
         {
-          $file = $this->root . '/' . $row['template_filename'];
+          $file = $this->root.'/'.$row['template_filename'];
           $force_reload = false;
           if ($row['template_id'] != $user->theme['template_id'])
           {
             // make sure that we are not overlooking a file not in the db yet
             if (isset($user->theme['template_inherits_id']) && $user->theme['template_inherits_id'] && !file_exists($file))
             {
-              $file = $this->inherit_root . '/' . $row['template_filename'];
+              $file = $this->inherit_root.'/'.$row['template_filename'];
               $this->files[$row['template_filename']] = $file;
               $this->files_inherit[$row['template_filename']] = $file;
               $this->files_template[$row['template_filename']] = $user->theme['template_inherits_id'];
@@ -414,7 +414,7 @@ 
           else
           {
             // Only bother compiling if it doesn't already exist
-            if (!file_exists($this->cachepath . str_replace('/', '.', $row['template_filename']) . DOT_PHP_EX))
+            if (!file_exists($this->cachepath.str_replace('/', '.', $row['template_filename']).DOT_PHP_EX))
             {
               $this->filename[$row['template_filename']] = $row['template_filename'];
               $compile->compile_write($row['template_filename'], $compile->compile(trim($row['template_data'])));
@@ -425,11 +425,11 @@ 
       }
       else
       {
-        $file = $this->root . '/' . $row['template_filename'];
+        $file = $this->root.'/'.$row['template_filename'];
 
         if (isset($user->theme['template_inherits_id']) && $user->theme['template_inherits_id'] && !file_exists($file))
         {
-          $file = $this->inherit_root . '/' . $row['template_filename'];
+          $file = $this->inherit_root.'/'.$row['template_filename'];
           $this->files[$row['template_filename']] = $file;
           $this->files_inherit[$row['template_filename']] = $file;
           $this->files_template[$row['template_filename']] = $user->theme['template_inherits_id'];
@@ -622,7 +622,7 @@ 
       // Re-position template blocks
       for ($i = sizeof($this->_tpldata[$blockname]); $i > $key; $i--)
       {
-        $this->_tpldata[$blockname][$i] = $this->_tpldata[$blockname][$i-1];
+        $this->_tpldata[$blockname][$i] = $this->_tpldata[$blockname][$i - 1];
         $this->_tpldata[$blockname][$i]['S_ROW_COUNT'] = $i;
       }
 
@@ -656,10 +656,10 @@ 
   {
     $handle = $filename;
     $this->filename[$handle] = $filename;
-    $this->files[$handle] = $this->root . '/' . $filename;
+    $this->files[$handle] = $this->root.'/'.$filename;
     if ($this->inherit_root)
     {
-      $this->files_inherit[$handle] = $this->inherit_root . '/' . $filename;
+      $this->files_inherit[$handle] = $this->inherit_root.'/'.$filename;
     }
 
     $filename = $this->_tpl_load($handle);
@@ -673,7 +673,7 @@ 
         include($filename);
         return;
       }
-      eval(' ?>' . $this->compiled_code[$handle] . '<?php ');
+      eval(' ?>'.$this->compiled_code[$handle].'<?php ');
     }
   }
 
@@ -685,12 +685,12 @@ 
   {
     global $phpbb_root_path;
 
-    $file = $phpbb_root_path . $filename;
+    $file = $phpbb_root_path.$filename;
 
     if (!file_exists($file))
     {
       // trigger_error cannot be used here, as the output already started
-      echo 'template->_php_include(): File ' . htmlspecialchars($file) . ' does not exist or is empty';
+      echo 'template->_php_include(): File '.htmlspecialchars($file).' does not exist or is empty';
       return;
     }
     include($file);
@@ -702,13 +702,13 @@ 
   */
   function assign_recursive($values, $name = '')
   {
-    if(isset($values['.']))
+    if (isset($values['.']))
     {
       $values_extra = $values['.'];
       unset($values['.']);
     }
 
-    if(!$name)
+    if (!$name)
     {
       $this->assign_vars($values);
     }
@@ -717,12 +717,12 @@ 
       $this->assign_block_vars($name, $values);
     }
 
-    if(isset($values_extra))
+    if (isset($values_extra))
     {
-      foreach($values_extra as $sub_array_name => $sub_array)
+      foreach ($values_extra as $sub_array_name => $sub_array)
       {
-        $new_name = $name . ($name ? '.' : '') . $sub_array_name;
-        foreach($sub_array as $sub_element)
+        $new_name = $name.($name ? '.' : '').$sub_array_name;
+        foreach ($sub_array as $sub_element)
         {
           $this->assign_recursive($sub_element, $new_name);
         }

Braces +13 added lines, -26 removed lines

@@ -83,8 +83,7 @@ 
       {
         $this->inherit_root = $phpbb_root_path . 'styles/' . $user->theme['template_inherit_path'] . '/template';
       }
-    }
-    else
+    } else
     {
       trigger_error('Template path could not be found: styles/' . $user->theme['template_path'] . '/template', E_USER_ERROR);
     }
@@ -120,8 +119,7 @@ 
 
       $this->inherit_root = $fallback_template_path;
       $this->orig_tpl_inherits_id = true;
-    }
-    else
+    } else
     {
       $this->orig_tpl_inherits_id = false;
     }
@@ -195,8 +193,7 @@ 
       }
 
       unset($str[$blocks[$blockcount]]);
-    }
-    else
+    } else
     {
       // Top-level block.
       unset($this->_tpldata[$blockname]);
@@ -232,8 +229,7 @@ 
     if ($filename = $this->_tpl_load($handle))
     {
       ($include_once) ? include_once($filename) : include($filename);
-    }
-    else
+    } else
     {
       eval(' ?>' . $this->compiled_code[$handle] . '<?php ');
     }
@@ -287,8 +283,7 @@ 
     if (!file_exists($filename) || @filesize($filename) === 0)
     {
       $recompile = true;
-    }
-    else if (classSupernova::$config->load_tplcompile)
+    } else if (classSupernova::$config->load_tplcompile)
     {
       // No way around it: we need to check inheritance here
       if ($user->theme['template_inherits_id'] && !file_exists($this->files[$handle]))
@@ -376,15 +371,13 @@ 
               $this->files[$row['template_filename']] = $file;
               $this->files_inherit[$row['template_filename']] = $file;
               $this->files_template[$row['template_filename']] = $user->theme['template_inherits_id'];
-            }
-            else if (isset($user->theme['template_inherits_id']) && $user->theme['template_inherits_id'])
+            } else if (isset($user->theme['template_inherits_id']) && $user->theme['template_inherits_id'])
             {
               // Ok, we have a situation. There is a file in the subtemplate, but nothing in the DB. We have to fix that.
               $force_reload = true;
               $this->files_template[$row['template_filename']] = $user->theme['template_inherits_id'];
             }
-          }
-          else
+          } else
           {
             $this->files_template[$row['template_filename']] = $user->theme['template_id'];
           }
@@ -394,8 +387,7 @@ 
             if ($row['template_filename'] == $this->filename[$handle])
             {
               $compile->_tpl_load_file($handle, true);
-            }
-            else
+            } else
             {
               $this->files[$row['template_filename']] = $file;
               $this->filename[$row['template_filename']] = $row['template_filename'];
@@ -410,8 +402,7 @@ 
           {
             $this->compiled_code[$handle] = $compile->compile(trim($row['template_data']));
             $compile->compile_write($handle, $this->compiled_code[$handle]);
-          }
-          else
+          } else
           {
             // Only bother compiling if it doesn't already exist
             if (!file_exists($this->cachepath . str_replace('/', '.', $row['template_filename']) . DOT_PHP_EX))
@@ -422,8 +413,7 @@ 
             }
           }
         }
-      }
-      else
+      } else
       {
         $file = $this->root . '/' . $row['template_filename'];
 
@@ -511,8 +501,7 @@ 
       // We're adding a new iteration to this block with the given
       // variable assignments.
       $str[$blocks[$blockcount]][] = $vararray;
-    }
-    else
+    } else
     {
       // Top-level block.
       $s_row_count = (isset($this->_tpldata[$blockname])) ? sizeof($this->_tpldata[$blockname]) : 0;
@@ -612,8 +601,7 @@ 
         $key = sizeof($this->_tpldata[$blockname]);
         unset($this->_tpldata[$blockname][($key - 1)]['S_LAST_ROW']);
         $vararray['S_LAST_ROW'] = true;
-      }
-      else if ($key === 0)
+      } else if ($key === 0)
       {
         unset($this->_tpldata[$blockname][0]['S_FIRST_ROW']);
         $vararray['S_FIRST_ROW'] = true;
@@ -711,8 +699,7 @@ 
     if(!$name)
     {
       $this->assign_vars($values);
-    }
-    else
+    } else
     {
       $this->assign_block_vars($name, $values);
     }

classes/template_compile.php

Doc Comments +8 added lines

@@ -47,6 +47,7 @@ 
 
   /**
   * constuctor
+  * @param template $template
   */
   function template_compile(&$template)
   {
@@ -463,6 +464,7 @@ 
   * Compile IF tags - much of this is from Smarty with
   * some adaptions for our block level methods
   * @access private
+  * @param boolean $elseif
   */
   function compile_tag_if($tag_args, $elseif)
   {
@@ -620,6 +622,7 @@ 
   /**
   * Compile DEFINE tags
   * @access private
+  * @param boolean $op
   */
   function compile_tag_define($tag_args, $op)
   {
@@ -698,6 +701,7 @@ 
   * parse expression
   * This is from Smarty
   * @access private
+  * @param string $is_arg
   */
   function _parse_is_expr($is_arg, $tokens)
   {
@@ -794,6 +798,8 @@ 
   * If $include_last_iterator is true, then [$_childN_i] will be appended to the form shown above.
   * NOTE: does not expect a trailing "." on the blockname.
   * @access private
+  * @param string $blockname
+  * @param boolean $include_last_iterator
   */
   function generate_block_data_ref($blockname, $include_last_iterator, $defop = false)
   {
@@ -832,6 +838,7 @@ 
   /**
   * Write compiled file to cache directory
   * @access private
+  * @param string $data
   */
   function compile_write($handle, $data)
   {
@@ -857,6 +864,7 @@ 
   /**
   * Minifies template w/i PHP code by removing extra spaces
   * @access private
+  * @return string
   */
   function minify($html)
   {

Indentation +63 added lines, -63 removed lines

@@ -44,17 +44,17 @@ 
   var $block_else_level = array();
 
   /**
-  * constuctor
-  */
+   * constuctor
+   */
   function template_compile(&$template)
   {
     $this->template = &$template;
   }
 
   /**
-  * Load template source from file
-  * @access private
-  */
+   * Load template source from file
+   * @access private
+   */
   function _tpl_load_file($handle, $store_in_db = false)
   {
     // Try and open template for read
@@ -97,10 +97,10 @@ 
   }
 
   /**
-  * Remove any PHP tags that do not belong, these regular expressions are derived from
-  * the ones that exist in zend_language_scanner.l
-  * @access private
-  */
+   * Remove any PHP tags that do not belong, these regular expressions are derived from
+   * the ones that exist in zend_language_scanner.l
+   * @access private
+   */
   function remove_php_tags(&$code)
   {
     // This matches the information gathered from the internal PHP lexer
@@ -114,9 +114,9 @@ 
   }
 
   /**
-  * The all seeing all doing compile method. Parts are inspired by or directly from Smarty
-  * @access private
-  */
+   * The all seeing all doing compile method. Parts are inspired by or directly from Smarty
+   * @access private
+   */
   function compile($code, $no_echo = false, $echo_var = '')
   {
     if ($echo_var)
@@ -285,9 +285,9 @@ 
   }
 
   /**
-  * Compile variables
-  * @access private
-  */
+   * Compile variables
+   * @access private
+   */
   function compile_var_tags(&$text_blocks)
   {
     // change template varrefs into PHP varrefs
@@ -347,9 +347,9 @@ 
   }
 
   /**
-  * Compile blocks
-  * @access private
-  */
+   * Compile blocks
+   * @access private
+   */
   function compile_tag_block($tag_args)
   {
     $no_nesting = false;
@@ -435,14 +435,14 @@ 
     $tag_template_php .= 'if ($_' . $tag_args . '_count) {';
 
     /**
-    * The following uses foreach for iteration instead of a for loop, foreach is faster but requires PHP to make a copy of the contents of the array which uses more memory
-    * <code>
-    * if (!$offset)
-    * {
-    *   $tag_template_php .= 'foreach (' . $varref . ' as $_' . $tag_args . '_i => $_' . $tag_args . '_val){';
-    * }
-    * </code>
-    */
+     * The following uses foreach for iteration instead of a for loop, foreach is faster but requires PHP to make a copy of the contents of the array which uses more memory
+     * <code>
+     * if (!$offset)
+     * {
+     *   $tag_template_php .= 'foreach (' . $varref . ' as $_' . $tag_args . '_i => $_' . $tag_args . '_val){';
+     * }
+     * </code>
+     */
 
     $tag_template_php .= 'for ($_' . $tag_args . '_i = ' . $loop_start . '; $_' . $tag_args . '_i < ' . $loop_end . '; ++$_' . $tag_args . '_i){';
 //    $tag_template_php .= '$this->_block_counter["'. $tag_args . '"] = $_' . $tag_args . '_i;';
@@ -453,10 +453,10 @@ 
   }
 
   /**
-  * Compile IF tags - much of this is from Smarty with
-  * some adaptions for our block level methods
-  * @access private
-  */
+   * Compile IF tags - much of this is from Smarty with
+   * some adaptions for our block level methods
+   * @access private
+   */
   function compile_tag_if($tag_args, $elseif)
   {
     // Tokenize args for 'if' tag.
@@ -611,9 +611,9 @@ 
   }
 
   /**
-  * Compile DEFINE tags
-  * @access private
-  */
+   * Compile DEFINE tags
+   * @access private
+   */
   function compile_tag_define($tag_args, $op)
   {
     preg_match('#^((?:[a-z0-9\-_]+\.)+)?\$(?=[A-Z])([A-Z0-9_\-]*)(?: = (\'?)([^\']*)(\'?))?$#', $tag_args, $match);
@@ -664,9 +664,9 @@ 
   }
 
   /**
-  * Compile INCLUDE tag
-  * @access private
-  */
+   * Compile INCLUDE tag
+   * @access private
+   */
   function compile_tag_include($tag_args)
   {
     // Process dynamic includes
@@ -679,19 +679,19 @@ 
   }
 
   /**
-  * Compile INCLUDE_PHP tag
-  * @access private
-  */
+   * Compile INCLUDE_PHP tag
+   * @access private
+   */
   function compile_tag_include_php($tag_args)
   {
     return "\$this->_php_include('$tag_args');";
   }
 
   /**
-  * parse expression
-  * This is from Smarty
-  * @access private
-  */
+   * parse expression
+   * This is from Smarty
+   * @access private
+   */
   function _parse_is_expr($is_arg, $tokens)
   {
     $expr_end = 0;
@@ -756,13 +756,13 @@ 
   }
 
   /**
-  * Generates a reference to the given variable inside the given (possibly nested)
-  * block namespace. This is a string of the form:
-  * ' . $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['varname'] . '
-  * It's ready to be inserted into an "echo" line in one of the templates.
-  * NOTE: expects a trailing "." on the namespace.
-  * @access private
-  */
+   * Generates a reference to the given variable inside the given (possibly nested)
+   * block namespace. This is a string of the form:
+   * ' . $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['varname'] . '
+   * It's ready to be inserted into an "echo" line in one of the templates.
+   * NOTE: expects a trailing "." on the namespace.
+   * @access private
+   */
   function generate_block_varref($namespace, $varname, $echo = true, $defop = false)
   {
     // Strip the trailing period.
@@ -780,14 +780,14 @@ 
   }
 
   /**
-  * Generates a reference to the array of data values for the given
-  * (possibly nested) block namespace. This is a string of the form:
-  * $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['$childN']
-  *
-  * If $include_last_iterator is true, then [$_childN_i] will be appended to the form shown above.
-  * NOTE: does not expect a trailing "." on the blockname.
-  * @access private
-  */
+   * Generates a reference to the array of data values for the given
+   * (possibly nested) block namespace. This is a string of the form:
+   * $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['$childN']
+   *
+   * If $include_last_iterator is true, then [$_childN_i] will be appended to the form shown above.
+   * NOTE: does not expect a trailing "." on the blockname.
+   * @access private
+   */
   function generate_block_data_ref($blockname, $include_last_iterator, $defop = false)
   {
     // Get an array of the blocks involved.
@@ -823,9 +823,9 @@ 
   }
 
   /**
-  * Write compiled file to cache directory
-  * @access private
-  */
+   * Write compiled file to cache directory
+   * @access private
+   */
   function compile_write($handle, $data)
   {
     $filename = $this->template->cachepath . str_replace('/', '.', $this->template->filename[$handle]) . DOT_PHP_EX;
@@ -848,8 +848,8 @@ 
 
   // Gorlum's minifier BOF
   /**
-  * Minifies template w/i PHP code by removing extra spaces
-  */
+   * Minifies template w/i PHP code by removing extra spaces
+   */
   private function minify($html)
   {
     if(!classSupernova::$config->tpl_minifier)

Spacing +48 added lines, -48 removed lines

@@ -91,7 +91,7 @@ 
         'template_data'     => trim(@file_get_contents($this->template->files[$handle])),
       );
 
-      $sql = 'INSERT INTO ' . STYLES_TEMPLATE_DATA_TABLE . ' ' . $db->sql_build_array('INSERT', $sql_ary);
+      $sql = 'INSERT INTO '.STYLES_TEMPLATE_DATA_TABLE.' '.$db->sql_build_array('INSERT', $sql_ary);
       $db->sql_query($sql);
     }
   }
@@ -138,9 +138,9 @@ 
 
     preg_match_all('#<!-- INCLUDE (\{\$?[A-Z0-9\-_]+\}|[a-zA-Z0-9\_\-\+\./]+) -->#', $code, $matches);
     $include_blocks = $matches[1];
-    if($include_blocks)
+    if ($include_blocks)
     {
-      foreach($include_blocks as &$included_file)
+      foreach ($include_blocks as &$included_file)
       {
         $included_file .= '.tpl.html';
       }
@@ -169,7 +169,7 @@ 
       {
         case 'BEGIN':
           $this->block_else_level[] = false;
-          $compile_blocks[] = '<?php ' . $this->compile_tag_block($block_val[2]) . ' ?>';
+          $compile_blocks[] = '<?php '.$this->compile_tag_block($block_val[2]).' ?>';
         break;
 
         case 'BEGINELSE':
@@ -179,11 +179,11 @@ 
 
         case 'END':
           array_pop($this->block_names);
-          $compile_blocks[] = '<?php ' . ((array_pop($this->block_else_level)) ? '}' : '}}') . ' ?>';
+          $compile_blocks[] = '<?php '.((array_pop($this->block_else_level)) ? '}' : '}}').' ?>';
         break;
 
         case 'IF':
-          $compile_blocks[] = '<?php ' . $this->compile_tag_if($block_val[2], false) . ' ?>';
+          $compile_blocks[] = '<?php '.$this->compile_tag_if($block_val[2], false).' ?>';
         break;
 
         case 'ELSE':
@@ -191,7 +191,7 @@ 
         break;
 
         case 'ELSEIF':
-          $compile_blocks[] = '<?php ' . $this->compile_tag_if($block_val[2], true) . ' ?>';
+          $compile_blocks[] = '<?php '.$this->compile_tag_if($block_val[2], true).' ?>';
         break;
 
         case 'ENDIF':
@@ -199,11 +199,11 @@ 
         break;
 
         case 'DEFINE':
-          $compile_blocks[] = '<?php ' . $this->compile_tag_define($block_val[2], true) . ' ?>';
+          $compile_blocks[] = '<?php '.$this->compile_tag_define($block_val[2], true).' ?>';
         break;
 
         case 'UNDEFINE':
-          $compile_blocks[] = '<?php ' . $this->compile_tag_define($block_val[2], false) . ' ?>';
+          $compile_blocks[] = '<?php '.$this->compile_tag_define($block_val[2], false).' ?>';
         break;
 
         case 'INCLUDE':
@@ -234,7 +234,7 @@ 
             $file = $temp;
           }
 
-          $compile_blocks[] = '<?php ' . $this->compile_tag_include($temp) . ' ?>';
+          $compile_blocks[] = '<?php '.$this->compile_tag_include($temp).' ?>';
 
           // No point in checking variable includes
           if ($file)
@@ -244,11 +244,11 @@ 
         break;
 
         case 'INCLUDEPHP':
-          $compile_blocks[] = (classSupernova::$config->tpl_allow_php) ? '<?php ' . $this->compile_tag_include_php(array_shift($includephp_blocks)) . ' ?>' : '';
+          $compile_blocks[] = (classSupernova::$config->tpl_allow_php) ? '<?php '.$this->compile_tag_include_php(array_shift($includephp_blocks)).' ?>' : '';
         break;
 
         case 'PHP':
-          $compile_blocks[] = (classSupernova::$config->tpl_allow_php) ? '<?php ' . array_shift($php_blocks) . ' ?>' : '';
+          $compile_blocks[] = (classSupernova::$config->tpl_allow_php) ? '<?php '.array_shift($php_blocks).' ?>' : '';
         break;
 
         default:
@@ -263,7 +263,7 @@ 
     for ($i = 0, $size = sizeof($text_blocks); $i < $size; $i++)
     {
       $trim_check_text = trim($text_blocks[$i]);
-      $template_php .= (!$no_echo) ? (($trim_check_text != '') ? $text_blocks[$i] : '') . ((isset($compile_blocks[$i])) ? $compile_blocks[$i] : '') : (($trim_check_text != '') ? $text_blocks[$i] : '') . ((isset($compile_blocks[$i])) ? $compile_blocks[$i] : '');
+      $template_php .= (!$no_echo) ? (($trim_check_text != '') ? $text_blocks[$i] : '').((isset($compile_blocks[$i])) ? $compile_blocks[$i] : '') : (($trim_check_text != '') ? $text_blocks[$i] : '').((isset($compile_blocks[$i])) ? $compile_blocks[$i] : '');
     }
 
     // Remove unused opening/closing tags
@@ -278,7 +278,7 @@ 
     // we'll strip out such occurences, minimising such switching
     if ($no_echo)
     {
-      return "\$$echo_var .= '" . $template_php . "'";
+      return "\$$echo_var .= '".$template_php."'";
     }
 
     return $template_php;
@@ -373,30 +373,30 @@ 
 
       if ($match[2] < 0)
       {
-        $loop_start = '($_' . $tag_args . '_count ' . $match[2] . ' < 0 ? 0 : $_' . $tag_args . '_count ' . $match[2] . ')';
+        $loop_start = '($_'.$tag_args.'_count '.$match[2].' < 0 ? 0 : $_'.$tag_args.'_count '.$match[2].')';
       }
       else
       {
-        $loop_start = '($_' . $tag_args . '_count < ' . $match[2] . ' ? $_' . $tag_args . '_count : ' . $match[2] . ')';
+        $loop_start = '($_'.$tag_args.'_count < '.$match[2].' ? $_'.$tag_args.'_count : '.$match[2].')';
       }
 
       if (strlen($match[3]) < 1 || $match[3] == -1)
       {
-        $loop_end = '$_' . $tag_args . '_count';
+        $loop_end = '$_'.$tag_args.'_count';
       }
       else if ($match[3] >= 0)
       {
-        $loop_end = '(' . ($match[3] + 1) . ' > $_' . $tag_args . '_count ? $_' . $tag_args . '_count : ' . ($match[3] + 1) . ')';
+        $loop_end = '('.($match[3] + 1).' > $_'.$tag_args.'_count ? $_'.$tag_args.'_count : '.($match[3] + 1).')';
       }
       else //if ($match[3] < -1)
       {
-        $loop_end = '$_' . $tag_args . '_count' . ($match[3] + 1);
+        $loop_end = '$_'.$tag_args.'_count'.($match[3] + 1);
       }
     }
     else
     {
       $loop_start = 0;
-      $loop_end = '$_' . $tag_args . '_count';
+      $loop_end = '$_'.$tag_args.'_count';
     }
 
     $tag_template_php = '';
@@ -415,7 +415,7 @@ 
     if (sizeof($block) < 2)
     {
       // Block is not nested.
-      $tag_template_php = '$_' . $tag_args . "_count = (isset(\$this->_tpldata['$tag_args'])) ? sizeof(\$this->_tpldata['$tag_args']) : 0;";
+      $tag_template_php = '$_'.$tag_args."_count = (isset(\$this->_tpldata['$tag_args'])) ? sizeof(\$this->_tpldata['$tag_args']) : 0;";
       $varref = "\$this->_tpldata['$tag_args']";
     }
     else
@@ -429,10 +429,10 @@ 
       $varref = $this->generate_block_data_ref($namespace, false);
 
       // Create the for loop code to iterate over this block.
-      $tag_template_php = '$_' . $tag_args . '_count = (isset(' . $varref . ')) ? sizeof(' . $varref . ') : 0;';
+      $tag_template_php = '$_'.$tag_args.'_count = (isset('.$varref.')) ? sizeof('.$varref.') : 0;';
     }
 
-    $tag_template_php .= 'if ($_' . $tag_args . '_count) {';
+    $tag_template_php .= 'if ($_'.$tag_args.'_count) {';
 
     /**
     * The following uses foreach for iteration instead of a for loop, foreach is faster but requires PHP to make a copy of the contents of the array which uses more memory
@@ -444,10 +444,10 @@ 
     * </code>
     */
 
-    $tag_template_php .= 'for ($_' . $tag_args . '_i = ' . $loop_start . '; $_' . $tag_args . '_i < ' . $loop_end . '; ++$_' . $tag_args . '_i){';
+    $tag_template_php .= 'for ($_'.$tag_args.'_i = '.$loop_start.'; $_'.$tag_args.'_i < '.$loop_end.'; ++$_'.$tag_args.'_i){';
 //    $tag_template_php .= '$this->_block_counter["'. $tag_args . '"] = $_' . $tag_args . '_i;';
-    $tag_template_php .= '$_'. $tag_args . '_val = &' . $varref . '[$_'. $tag_args. '_i];';
-    $tag_template_php .= '$this->_block_value["'. $tag_args . '"] = &' . $varref . '[$_'. $tag_args. '_i];';
+    $tag_template_php .= '$_'.$tag_args.'_val = &'.$varref.'[$_'.$tag_args.'_i];';
+    $tag_template_php .= '$this->_block_value["'.$tag_args.'"] = &'.$varref.'[$_'.$tag_args.'_i];';
 
     return $tag_template_php;
   }
@@ -551,10 +551,10 @@ 
         break;
 
         case 'is':
-          $is_arg_start = ($tokens[$i-1] == ')') ? array_pop($is_arg_stack) : $i-1;
+          $is_arg_start = ($tokens[$i - 1] == ')') ? array_pop($is_arg_stack) : $i - 1;
           $is_arg = implode(' ', array_slice($tokens, $is_arg_start, $i - $is_arg_start));
 
-          $new_tokens = $this->_parse_is_expr($is_arg, array_slice($tokens, $i+1));
+          $new_tokens = $this->_parse_is_expr($is_arg, array_slice($tokens, $i + 1));
 
           array_splice($tokens, $is_arg_start, sizeof($tokens), $new_tokens);
 
@@ -565,7 +565,7 @@ 
         default:
           if (preg_match('#^((?:[a-z0-9\-_]+\.)+)?(\$)?(?=[A-Za-z])([A-Za-z0-9\-_]+)#s', $token, $varrefs))
           {
-            $token = (!empty($varrefs[1])) ? $this->generate_block_data_ref(substr($varrefs[1], 0, -1), true, $varrefs[2]) . '[\'' . $varrefs[3] . '\']' : (($varrefs[2]) ? '$this->_tpldata[\'DEFINE\'][\'.\'][\'' . $varrefs[3] . '\']' : '$this->_rootref[\'' . $varrefs[3] . '\']');
+            $token = (!empty($varrefs[1])) ? $this->generate_block_data_ref(substr($varrefs[1], 0, -1), true, $varrefs[2]).'[\''.$varrefs[3].'\']' : (($varrefs[2]) ? '$this->_tpldata[\'DEFINE\'][\'.\'][\''.$varrefs[3].'\']' : '$this->_rootref[\''.$varrefs[3].'\']');
           }
           else if (preg_match('#^\.((?:[a-z0-9\-_]+\.?)+)$#s', $token, $varrefs))
           {
@@ -582,20 +582,20 @@ 
               $varref = $this->generate_block_data_ref($namespace, true);
 
               // Add the block reference for the last child.
-              $varref .= "['" . $block . "']";
+              $varref .= "['".$block."']";
             }
             else
             {
               $varref = '$this->_tpldata';
 
               // Add the block reference for the last child.
-              $varref .= "['" . $blocks[0] . "']";
+              $varref .= "['".$blocks[0]."']";
             }
             $token = "sizeof($varref)";
           }
           else if (!empty($token))
           {
-            $token = '(' . $token . ')';
+            $token = '('.$token.')';
           }
 
         break;
@@ -607,7 +607,7 @@ 
     {
       $tokens = array('false');
     }
-    return (($elseif) ? '} else if (' : 'if (') . (implode(' ', $tokens) . ') { ');
+    return (($elseif) ? '} else if (' : 'if (').(implode(' ', $tokens).') { ');
   }
 
   /**
@@ -625,7 +625,7 @@ 
 
     if (!$op)
     {
-      return 'unset(' . (($match[1]) ? $this->generate_block_data_ref(substr($match[1], 0, -1), true, true) . '[\'' . $match[2] . '\']' : '$this->_tpldata[\'DEFINE\'][\'.\'][\'' . $match[2] . '\']') . ');';
+      return 'unset('.(($match[1]) ? $this->generate_block_data_ref(substr($match[1], 0, -1), true, true).'[\''.$match[2].'\']' : '$this->_tpldata[\'DEFINE\'][\'.\'][\''.$match[2].'\']').');';
     }
 
     // Are we a string?
@@ -637,7 +637,7 @@ 
       $match[4] = $this->compile($match[4]);
 
       // Now replace the php code
-      $match[4] = "'" . str_replace(array('<?php echo ', '; ?>'), array("' . ", " . '"), $match[4]) . "'";
+      $match[4] = "'".str_replace(array('<?php echo ', '; ?>'), array("' . ", " . '"), $match[4])."'";
     }
     else
     {
@@ -660,7 +660,7 @@ 
       }
     }
 
-    return (($match[1]) ? $this->generate_block_data_ref(substr($match[1], 0, -1), true, true) . '[\'' . $match[2] . '\']' : '$this->_tpldata[\'DEFINE\'][\'.\'][\'' . $match[2] . '\']') . ' = ' . $match[4] . ';';
+    return (($match[1]) ? $this->generate_block_data_ref(substr($match[1], 0, -1), true, true).'[\''.$match[2].'\']' : '$this->_tpldata[\'DEFINE\'][\'.\'][\''.$match[2].'\']').' = '.$match[4].';';
   }
 
   /**
@@ -801,24 +801,24 @@ 
       // Build up the string with everything but the last child.
       for ($i = 0; $i < $blockcount; $i++)
       {
-        $varref .= "['" . $blocks[$i] . "'][\$_" . $blocks[$i] . '_i]';
+        $varref .= "['".$blocks[$i]."'][\$_".$blocks[$i].'_i]';
       }
       // Add the block reference for the last child.
-      $varref .= "['" . $blocks[$blockcount] . "']";
+      $varref .= "['".$blocks[$blockcount]."']";
       // Add the iterator for the last child if requried.
       if ($include_last_iterator)
       {
-        $varref .= '[$_' . $blocks[$blockcount] . '_i]';
+        $varref .= '[$_'.$blocks[$blockcount].'_i]';
       }
       return $varref;
     }
     else if ($include_last_iterator)
     {
-      return '$_'. $blocks[$blockcount] . '_val';
+      return '$_'.$blocks[$blockcount].'_val';
     }
     else
     {
-      return '$_'. $blocks[$blockcount - 1] . '_val[\''. $blocks[$blockcount]. '\']';
+      return '$_'.$blocks[$blockcount - 1].'_val[\''.$blocks[$blockcount].'\']';
     }
   }
 
@@ -828,14 +828,14 @@ 
   */
   function compile_write($handle, $data)
   {
-    $filename = $this->template->cachepath . str_replace('/', '.', $this->template->filename[$handle]) . DOT_PHP_EX;
+    $filename = $this->template->cachepath.str_replace('/', '.', $this->template->filename[$handle]).DOT_PHP_EX;
 
-    $data = "<?php if (!defined('INSIDE')) exit;" . ((strpos($data, '<?php') === 0) ? substr($data, 5) : ' ?>' . $data);
+    $data = "<?php if (!defined('INSIDE')) exit;".((strpos($data, '<?php') === 0) ? substr($data, 5) : ' ?>'.$data);
 
     if ($fp = @fopen($filename, 'wb'))
     {
       @flock($fp, LOCK_EX);
-      @fwrite ($fp, $data);
+      @fwrite($fp, $data);
       @flock($fp, LOCK_UN);
       @fclose($fp);
 
@@ -852,7 +852,7 @@ 
   */
   private function minify($html)
   {
-    if(!classSupernova::$config->tpl_minifier)
+    if (!classSupernova::$config->tpl_minifier)
     {
       return $html;
     }
@@ -862,14 +862,14 @@ 
     $html = preg_replace('/(<script[^>]*?>.*?<\/script>)/si', '#pre#', $html);
     $html = preg_replace('/>[\s]*</', '><', $html); // Strip spacechars between tags
     $html = preg_replace('/[\s]+/', ' ', $html); // Replace several spacechars with one space
-    if(!empty($pre[0]))
+    if (!empty($pre[0]))
     {
-      foreach($pre[0] as $tag)
+      foreach ($pre[0] as $tag)
       {
         $tag = preg_replace('/^\ *\/\/[^\<]*?$/m', ' ', $tag); // Strips comments - except those that contains HTML comment inside
         $tag = preg_replace('/[\ \t]{2,}/', ' ', $tag); // Replace several spaces by one
         $tag = preg_replace('/\s{2,}/', "\r\n", $tag); // Replace several linefeeds by one
-        $html = preg_replace('/#pre#/', $tag, $html,1);
+        $html = preg_replace('/#pre#/', $tag, $html, 1);
       }
     }
 

Braces +18 added lines, -36 removed lines

@@ -66,8 +66,7 @@ 
       {
         return;
         trigger_error("template->_tpl_load_file(): File {$this->template->files[$handle]} does not exist or is empty", E_USER_ERROR);
-      }
-      else
+      } else
       {
         $this->template->files[$handle] = $this->template->files_inherit[$handle];
       }
@@ -225,15 +224,13 @@ 
               $var = substr($temp, 2, -1);
               //$file = $this->template->_tpldata['DEFINE']['.'][$var];
               $temp = "\$this->_tpldata['DEFINE']['.']['$var']";
-            }
-            else
+            } else
             {
               $var = substr($temp, 1, -1);
               //$file = $this->template->_rootref[$var];
               $temp = "\$this->_rootref['$var']";
             }
-          }
-          else
+          } else
           {
             $file = $temp;
           }
@@ -381,8 +378,7 @@ 
       if ($match[2] < 0)
       {
         $loop_start = '($_' . $tag_args . '_count ' . $match[2] . ' < 0 ? 0 : $_' . $tag_args . '_count ' . $match[2] . ')';
-      }
-      else
+      } else
       {
         $loop_start = '($_' . $tag_args . '_count < ' . $match[2] . ' ? $_' . $tag_args . '_count : ' . $match[2] . ')';
       }
@@ -390,17 +386,14 @@ 
       if (strlen($match[3]) < 1 || $match[3] == -1)
       {
         $loop_end = '$_' . $tag_args . '_count';
-      }
-      else if ($match[3] >= 0)
+      } else if ($match[3] >= 0)
       {
         $loop_end = '(' . ($match[3] + 1) . ' > $_' . $tag_args . '_count ? $_' . $tag_args . '_count : ' . ($match[3] + 1) . ')';
-      }
-      else //if ($match[3] < -1)
+      } else //if ($match[3] < -1)
       {
         $loop_end = '$_' . $tag_args . '_count' . ($match[3] + 1);
       }
-    }
-    else
+    } else
     {
       $loop_start = 0;
       $loop_end = '$_' . $tag_args . '_count';
@@ -413,8 +406,7 @@ 
     {
       // We need to implode $no_nesting times from the end...
       $block = array_slice($this->block_names, -$no_nesting);
-    }
-    else
+    } else
     {
       $block = $this->block_names;
     }
@@ -424,8 +416,7 @@ 
       // Block is not nested.
       $tag_template_php = '$_' . $tag_args . "_count = (isset(\$this->_tpldata['$tag_args'])) ? sizeof(\$this->_tpldata['$tag_args']) : 0;";
       $varref = "\$this->_tpldata['$tag_args']";
-    }
-    else
+    } else
     {
       // This block is nested.
       // Generate a namespace string for this block.
@@ -573,8 +564,7 @@ 
           if (preg_match('#^((?:[a-z0-9\-_]+\.)+)?(\$)?(?=[A-Za-z])([A-Za-z0-9\-_]+)#s', $token, $varrefs))
           {
             $token = (!empty($varrefs[1])) ? $this->generate_block_data_ref(substr($varrefs[1], 0, -1), true, $varrefs[2]) . '[\'' . $varrefs[3] . '\']' : (($varrefs[2]) ? '$this->_tpldata[\'DEFINE\'][\'.\'][\'' . $varrefs[3] . '\']' : '$this->_rootref[\'' . $varrefs[3] . '\']');
-          }
-          else if (preg_match('#^\.((?:[a-z0-9\-_]+\.?)+)$#s', $token, $varrefs))
+          } else if (preg_match('#^\.((?:[a-z0-9\-_]+\.?)+)$#s', $token, $varrefs))
           {
             // Allow checking if loops are set with .loopname
             // It is also possible to check the loop count by doing <!-- IF .loopname > 1 --> for example
@@ -590,8 +580,7 @@ 
 
               // Add the block reference for the last child.
               $varref .= "['" . $block . "']";
-            }
-            else
+            } else
             {
               $varref = '$this->_tpldata';
 
@@ -599,8 +588,7 @@ 
               $varref .= "['" . $blocks[0] . "']";
             }
             $token = "sizeof($varref)";
-          }
-          else if (!empty($token))
+          } else if (!empty($token))
           {
             $token = '(' . $token . ')';
           }
@@ -645,8 +633,7 @@ 
 
       // Now replace the php code
       $match[4] = "'" . str_replace(array('<?php echo ', '; ?>'), array("' . ", " . '"), $match[4]) . "'";
-    }
-    else
+    } else
     {
       preg_match('#true|false|\.#i', $match[4], $type);
 
@@ -708,8 +695,7 @@ 
     {
       $negate_expr = true;
       $expr_type = array_shift($tokens);
-    }
-    else
+    } else
     {
       $expr_type = $first_token;
     }
@@ -722,8 +708,7 @@ 
           $expr_end++;
           $expr_arg = $tokens[$expr_end++];
           $expr = "!(($is_arg / $expr_arg) % $expr_arg)";
-        }
-        else
+        } else
         {
           $expr = "!($is_arg & 1)";
         }
@@ -735,8 +720,7 @@ 
           $expr_end++;
           $expr_arg = $tokens[$expr_end++];
           $expr = "(($is_arg / $expr_arg) % $expr_arg)";
-        }
-        else
+        } else
         {
           $expr = "($is_arg & 1)";
         }
@@ -818,12 +802,10 @@ 
         $varref .= '[$_' . $blocks[$blockcount] . '_i]';
       }
       return $varref;
-    }
-    else if ($include_last_iterator)
+    } else if ($include_last_iterator)
     {
       return '$_'. $blocks[$blockcount] . '_val';
-    }
-    else
+    } else
     {
       return '$_'. $blocks[$blockcount - 1] . '_val[\''. $blocks[$blockcount]. '\']';
     }

classes/UBE/ArrayAccessV2.php

Doc Comments +1 added lines, -1 removed lines

@@ -118,7 +118,7 @@
    * @param mixed $offset <p>
    * The offset to assign the value to.
    * </p>
-   * @param mixed $value <p>
+   * @param Unit $value <p>
    * The value to set.
    * </p>
    *

classes/UBE/UBE.php

Doc Comments +3 added lines, -3 removed lines

@@ -459,7 +459,7 @@ 
    * Преобразовывает данные симулятора в данные для расчета боя
    *
    * @param     $side_info
-   * @param     $attacker
+   * @param     boolean $attacker
    * @param int $player_id
    *
    */
@@ -521,7 +521,7 @@ 
   }
 
   /**
-   * @return int
+   * @return double
    */
   public function get_time_spent() {
     return $this->time_spent;
@@ -564,7 +564,7 @@ 
   }
 
   /**
-   * @param $template
+   * @param null|template $template
    *
    * @return template
    */

Spacing +47 added lines, -48 removed lines

@@ -147,7 +147,7 @@ 
     $this->players->db_load_player_by_id($player_id, UBE_PLAYER_IS_DEFENDER);
 
     $player_db_row = $this->players[$player_id]->getDbRow();
-    if($fortifier_level = mrc_get_level($player_db_row, $this->combatMission->dst_planet, MRC_FORTIFIER)) {
+    if ($fortifier_level = mrc_get_level($player_db_row, $this->combatMission->dst_planet, MRC_FORTIFIER)) {
       $this->planet_bonus->add_unit_by_snid(MRC_FORTIFIER, $fortifier_level);
     }
 
@@ -178,7 +178,7 @@ 
     $this->rounds[0] = new UBERound(0);
     $this->rounds[0]->make_snapshot($this->fleet_list);
 
-    for($round = 1; $round <= 10; $round++) {
+    for ($round = 1; $round <= 10; $round++) {
       // Проводим раунд
       defined('DEBUG_UBE') ? print("Round {$round}<br>") : false;
 
@@ -191,7 +191,7 @@ 
 
       // Анализируем итоги текущего раунда и готовим данные для следующего
       $this->combat_result = $this->fleet_list->ubeAnalyzeFleetOutcome($round);
-      if($this->combat_result != UBE_COMBAT_RESULT_DRAW) {
+      if ($this->combat_result != UBE_COMBAT_RESULT_DRAW) {
         break;
       }
 
@@ -220,11 +220,11 @@ 
     // Генерируем результат боя
     $this->fleet_list->ube_analyze_fleets($this->is_simulator, $this->debris, $this->resource_exchange_rates);
 
-    if(!$this->is_ube_loaded) {
+    if (!$this->is_ube_loaded) {
       $this->moon_calculator->calculate_moon($this);
 
       // Лутаем ресурсы - если аттакер выиграл
-      if($this->combat_result == UBE_COMBAT_RESULT_WIN) {
+      if ($this->combat_result == UBE_COMBAT_RESULT_WIN) {
         $this->sn_ube_combat_analyze_loot();
       }
     }
@@ -244,7 +244,7 @@ 
       RES_DEUTERIUM => 0,
     );
 
-    if(
+    if (
       (($planet_resource_total = $this->fleet_list[0]->get_resources_amount()) > 0)
       &&
       (($total_capacity = $this->fleet_list->ube_get_capacity_attackers()) > 0)
@@ -256,9 +256,9 @@ 
       $planet_lootable_percent = $planet_lootable / $planet_resource_total;
 
       // Вычисляем сколько ресурсов вывезено
-      foreach($this->fleet_list->_container as $fleet_id => $fleet) {
+      foreach ($this->fleet_list->_container as $fleet_id => $fleet) {
         $looted_in_metal = 0;
-        foreach($this->fleet_list[0]->resource_list as $resource_id => $resource_amount) {
+        foreach ($this->fleet_list[0]->resource_list as $resource_id => $resource_amount) {
           // Вычисляем какой процент общей емкости трюмов атакующих будет задействован
           $fleet_lootable_percent = $fleet->fleet_capacity / $total_capacity;
           $looted = floor($resource_amount * $planet_lootable_percent * $fleet_lootable_percent);
@@ -323,7 +323,7 @@ 
     $destination_user_id = $this->fleet_list[0]->owner_id;
 
     // Обновляем поле обломков на планете
-    if(!$this->is_admin_in_combat && $this->debris->debris_total() > 0) {
+    if (!$this->is_admin_in_combat && $this->debris->debris_total() > 0) {
       DBStaticPlanet::db_planet_update_by_gspt(
         $this->ube_planet_info[PLANET_GALAXY], $this->ube_planet_info[PLANET_SYSTEM], $this->ube_planet_info[PLANET_PLANET], PT_PLANET,
         array(),
@@ -334,10 +334,10 @@ 
       );
     }
 
-    foreach($this->fleet_list->_container as $fleet_id => $UBEFleet) {
+    foreach ($this->fleet_list->_container as $fleet_id => $UBEFleet) {
       $ship_count_lost = $UBEFleet->unit_list->unitCountLost();
 
-      if($fleet_id) {
+      if ($fleet_id) {
         // Флот
         $UBEFleet->db_save_combat_result_fleet($this->is_small_fleet_recce, $this->moon_calculator->get_reapers_status());
       } else {
@@ -345,18 +345,18 @@ 
 
         // Сохраняем изменения ресурсов - если они есть
         $resource_delta = $UBEFleet->ube_combat_result_calculate_resources();
-        if(!empty($resource_delta)) {
+        if (!empty($resource_delta)) {
           $temp = array();
-          foreach($resource_delta as $resource_id => $resource_amount) {
+          foreach ($resource_delta as $resource_id => $resource_amount) {
             $resource_db_name = pname_resource_name($resource_id);
             $temp[] = "`{$resource_db_name}` = `{$resource_db_name}` + ({$resource_amount})";
           }
           DBStaticPlanet::db_planet_update_set_by_id_DEPRECATED($this->ube_planet_info[PLANET_ID], implode(',', $temp));
         }
 
-        if($ship_count_lost) {
+        if ($ship_count_lost) {
           $planet_row_cache = $this->players[$destination_user_id]->getDbRow();
-          foreach($UBEFleet->unit_list->_container as $UBEUnit) {
+          foreach ($UBEFleet->unit_list->_container as $UBEUnit) {
             DBStaticUnit::dbUpdateOrInsertUnit($UBEUnit->unitId, -$UBEUnit->units_lost, $planet_row_cache, $this->ube_planet_info[PLANET_ID]);
           }
         }
@@ -366,7 +366,7 @@ 
     // TODO: Связать сабы с флотами констраинтами ON DELETE SET NULL
     // Для САБов
     $fleet_group_id_list = $this->fleet_list->ube_get_groups();
-    if(!empty($fleet_group_id_list)) {
+    if (!empty($fleet_group_id_list)) {
       $fleet_group_id_list = implode(',', $fleet_group_id_list);
       DBStaticFleetACS::db_acs_delete_by_list($fleet_group_id_list);
     }
@@ -375,19 +375,19 @@ 
 
     $bashing_list = array();
     $players_sides = $this->players->get_player_sides();
-    foreach($players_sides as $player_id => $player_side) {
-      if($player_side != UBE_PLAYER_IS_ATTACKER) {
+    foreach ($players_sides as $player_id => $player_side) {
+      if ($player_side != UBE_PLAYER_IS_ATTACKER) {
         continue;
       }
-      if($this->moon_calculator->get_status() != UBE_MOON_DESTROY_SUCCESS) {
+      if ($this->moon_calculator->get_status() != UBE_MOON_DESTROY_SUCCESS) {
         $bashing_list[] = "({$player_id}, {$this->ube_planet_info[PLANET_ID]}, {$this->combat_timestamp})";
       }
-      if($this->mission_type_id == MT_ATTACK && $this->is_defender_active_player) {
+      if ($this->mission_type_id == MT_ATTACK && $this->is_defender_active_player) {
         $str_loose_or_win = $this->combat_result == UBE_COMBAT_RESULT_WIN ? 'raidswin' : 'raidsloose';
         DBStaticUser::db_user_set_by_id_DEPRECATED($player_id, "`xpraid` = `xpraid` + 1, `raids` = `raids` + 1, `{$str_loose_or_win}` = `{$str_loose_or_win}` + 1");
       }
     }
-    if(!empty($bashing_list)) {
+    if (!empty($bashing_list)) {
       DBStaticFleetBashing::db_bashing_insert($bashing_list);
     }
 
@@ -413,20 +413,19 @@ 
       $planet_info[PLANET_SYSTEM],
       $planet_info[PLANET_PLANET],
       htmlentities($planet_info[PLANET_NAME], ENT_COMPAT, 'UTF-8'),
-      classLocale::$lang[$this->combat_result == UBE_COMBAT_RESULT_WIN ? 'ube_report_info_outcome_win' :
-        ($this->combat_result == UBE_COMBAT_RESULT_DRAW ? 'ube_report_info_outcome_draw' : 'ube_report_info_outcome_loss')]
+      classLocale::$lang[$this->combat_result == UBE_COMBAT_RESULT_WIN ? 'ube_report_info_outcome_win' : ($this->combat_result == UBE_COMBAT_RESULT_DRAW ? 'ube_report_info_outcome_draw' : 'ube_report_info_outcome_loss')]
     );
 
     $text_defender = '';
     $debris = $this->debris->get_debris();
-    foreach($debris as $resource_id => $resource_amount) {
-      if($resource_id == RES_DEUTERIUM) {
+    foreach ($debris as $resource_id => $resource_amount) {
+      if ($resource_id == RES_DEUTERIUM) {
         continue;
       }
 
-      $text_defender .= "{$classLocale['tech'][$resource_id]}: " . pretty_number($resource_amount) . '<br />';
+      $text_defender .= "{$classLocale['tech'][$resource_id]}: ".pretty_number($resource_amount).'<br />';
     }
-    if($text_defender) {
+    if ($text_defender) {
       $text_defender = "{$classLocale['ube_report_msg_body_debris']}{$text_defender}<br />";
     }
 
@@ -436,8 +435,8 @@ 
 
     // TODO: Оптимизировать отсылку сообщений - отсылать пакетами
     $player_sides = $this->players->get_player_sides();
-    foreach($player_sides as $player_id => $player_side) {
-      $message = $text_common . ($this->is_small_fleet_recce && ($player_side == UBE_PLAYER_IS_ATTACKER) ? classLocale::$lang['ube_report_msg_body_sfr'] : $text_defender);
+    foreach ($player_sides as $player_id => $player_side) {
+      $message = $text_common.($this->is_small_fleet_recce && ($player_side == UBE_PLAYER_IS_ATTACKER) ? classLocale::$lang['ube_report_msg_body_sfr'] : $text_defender);
       DBStaticMessages::msg_send_simple_message($player_id, '', $this->combat_timestamp, MSG_TYPE_COMBAT, classLocale::$lang['sys_mess_tower'], classLocale::$lang['sys_mess_attack_report'], $message);
     }
 
@@ -472,11 +471,11 @@ 
     $player_id = $player_id == -1 ? $this->players->count() : $player_id;
     $fleet_id = $player_id; // FOR SIMULATOR!
 
-    if(empty($this->players[$player_id])) {
+    if (empty($this->players[$player_id])) {
       $this->players[$player_id] = new UBEPlayer();
     }
 
-    foreach($side_info as $fleet_data) {
+    foreach ($side_info as $fleet_data) {
       $this->players[$player_id]->name = $player_id;
       $this->players[$player_id]->setSide($attacker);
 
@@ -484,32 +483,32 @@ 
       $this->fleet_list[$fleet_id] = $objFleet;
 
       $this->fleet_list[$fleet_id]->owner_id = $player_id;
-      foreach($fleet_data as $unit_id => $unit_count) {
-        if(!$unit_count) {
+      foreach ($fleet_data as $unit_id => $unit_count) {
+        if (!$unit_count) {
           continue;
         }
 
         $unit_type = get_unit_param($unit_id, P_UNIT_TYPE);
 
-        if($unit_type == UNIT_SHIPS || $unit_type == UNIT_DEFENCE) {
+        if ($unit_type == UNIT_SHIPS || $unit_type == UNIT_DEFENCE) {
           $this->fleet_list[$fleet_id]->unit_list->unitAdjustCount($unit_id, $unit_count);
-        } elseif($unit_type == UNIT_RESOURCES) {
+        } elseif ($unit_type == UNIT_RESOURCES) {
           $this->fleet_list[$fleet_id]->resource_list[$unit_id] = $unit_count;
-        } elseif($unit_type == UNIT_TECHNOLOGIES) {
-          if($unit_id == TECH_WEAPON) {
+        } elseif ($unit_type == UNIT_TECHNOLOGIES) {
+          if ($unit_id == TECH_WEAPON) {
             $this->players[$player_id]->player_bonus->add_unit_by_snid(TECH_WEAPON, $unit_count);
-          } elseif($unit_id == TECH_SHIELD) {
+          } elseif ($unit_id == TECH_SHIELD) {
             $this->players[$player_id]->player_bonus->add_unit_by_snid(TECH_SHIELD, $unit_count);
-          } elseif($unit_id == TECH_ARMOR) {
+          } elseif ($unit_id == TECH_ARMOR) {
             $this->players[$player_id]->player_bonus->add_unit_by_snid(TECH_ARMOR, $unit_count);
           }
-        } elseif($unit_type == UNIT_GOVERNORS) {
-          if($unit_id == MRC_FORTIFIER) {
+        } elseif ($unit_type == UNIT_GOVERNORS) {
+          if ($unit_id == MRC_FORTIFIER) {
             // Фортифаер даёт бонус ко всему
             $this->planet_bonus->add_unit_by_snid(MRC_FORTIFIER, $unit_count);
           }
-        } elseif($unit_type == UNIT_MERCENARIES) {
-          if($unit_id == MRC_ADMIRAL) {
+        } elseif ($unit_type == UNIT_MERCENARIES) {
+          if ($unit_id == MRC_ADMIRAL) {
             $this->players[$player_id]->player_bonus->add_unit_by_snid(MRC_ADMIRAL, $unit_count);
           }
         }
@@ -563,7 +562,7 @@ 
 
     $ube->sn_ube_message_send();
 
-    defined('DEBUG_UBE') ? die('DIE at ' . __FILE__ . ' ' . __LINE__) : false;
+    defined('DEBUG_UBE') ? die('DIE at '.__FILE__.' '.__LINE__) : false;
 
     return false;
   }
@@ -578,7 +577,7 @@ 
 
     $ube_report = new UBEReport();
     $ube = $ube_report->sn_ube_report_load(sys_get_param_str('cypher'));
-    if($ube != UBE_REPORT_NOT_FOUND) {
+    if ($ube != UBE_REPORT_NOT_FOUND) {
       $ube_report->sn_ube_report_generate($ube, $template_result);
 
       $template = gettemplate('ube_combat_report', $template);
@@ -606,9 +605,9 @@ 
     $ube->sn_ube_combat();
     $ube_report = new UBEReport();
 
-    if(sys_get_param_str('reload')) {
+    if (sys_get_param_str('reload')) {
       $ube_new = $ube_report->sn_ube_report_load($ube->get_cypher()); // $combat_data = sn_ube_report_load($combat_data[UBE_REPORT_CYPHER]);
-      if($ube_new != UBE_REPORT_NOT_FOUND && is_object($ube_new)) {
+      if ($ube_new != UBE_REPORT_NOT_FOUND && is_object($ube_new)) {
         $ube = $ube_new;
       }
     }
@@ -656,7 +655,7 @@ 
     $this->debris->load_from_report_row($report_row);
 
     $query = classSupernova::$db->doSelect("SELECT * FROM {{ube_report_player}} WHERE `ube_report_id` = {$report_row['ube_report_id']}");
-    while($player_row = db_fetch($query)) {
+    while ($player_row = db_fetch($query)) {
       $this->players->init_player_from_report_info($player_row);
     }
 

classes/UBE/UBEFleet.php

Doc Comments +11 added lines, -4 removed lines

@@ -150,7 +150,7 @@ 
   }
 
   /**
-   * @param $ube_report_id
+   * @param integer $ube_report_id
    *
    * @return array
    *
@@ -288,7 +288,7 @@ 
 
 
   /**
-   * @param $ube_report_id
+   * @param integer $ube_report_id
    *
    * @return array
    */
@@ -336,7 +336,7 @@ 
   // Рендерит таблицу общего результата боя
   /**
    * @param $array
-   * @param $lang_header_index
+   * @param string $lang_header_index
    *
    * @return array
    */
@@ -362,6 +362,9 @@ 
   }
 
 
+  /**
+   * @param integer $ube_report_id
+   */
   public function sql_generate_outcome_unit_array(&$sql_perform_report_unit, $ube_report_id) {
     $fleet_id = $this->db_id;
 
@@ -468,6 +471,10 @@ 
     $this->fleet_capacity -= $fleet_total_resources;
   }
 
+  /**
+   * @param integer $is_small_fleet_recce
+   * @param integer $reapers_status
+   */
   public function db_save_combat_result_fleet($is_small_fleet_recce, $reapers_status) {
     $ship_count_initial = $this->unit_list->unitsCount();
     $ship_count_lost = $this->unit_list->unitCountLost();
@@ -535,7 +542,7 @@ 
 
   /**
    * @param UBEFleetList $fleet_list
-   * @param              $is_simulator
+   * @param              boolean $is_simulator
    *
    * @version 2016-02-25 23:42:45 41a4.68
    */

Spacing +64 added lines, -64 removed lines

@@ -162,20 +162,20 @@ 
       $this->owner_id,
       $this->db_id,
 
-      (float)$this->UBE_PLANET[PLANET_ID],
-      "'" . db_escape($this->UBE_PLANET[PLANET_NAME]) . "'",
-      (int)$this->UBE_PLANET[PLANET_GALAXY],
-      (int)$this->UBE_PLANET[PLANET_SYSTEM],
-      (int)$this->UBE_PLANET[PLANET_PLANET],
-      (int)$this->UBE_PLANET[PLANET_TYPE],
-
-      (float)$this->resource_list[RES_METAL],
-      (float)$this->resource_list[RES_CRYSTAL],
-      (float)$this->resource_list[RES_DEUTERIUM],
-
-      (float)$this->fleet_bonus->calcBonus(P_ATTACK),
-      (float)$this->fleet_bonus->calcBonus(P_SHIELD),
-      (float)$this->fleet_bonus->calcBonus(P_ARMOR),
+      (float) $this->UBE_PLANET[PLANET_ID],
+      "'".db_escape($this->UBE_PLANET[PLANET_NAME])."'",
+      (int) $this->UBE_PLANET[PLANET_GALAXY],
+      (int) $this->UBE_PLANET[PLANET_SYSTEM],
+      (int) $this->UBE_PLANET[PLANET_PLANET],
+      (int) $this->UBE_PLANET[PLANET_TYPE],
+
+      (float) $this->resource_list[RES_METAL],
+      (float) $this->resource_list[RES_CRYSTAL],
+      (float) $this->resource_list[RES_DEUTERIUM],
+
+      (float) $this->fleet_bonus->calcBonus(P_ATTACK),
+      (float) $this->fleet_bonus->calcBonus(P_SHIELD),
+      (float) $this->fleet_bonus->calcBonus(P_ARMOR),
     );
   }
 
@@ -189,13 +189,13 @@ 
     $this->owner_id = $objFleet->playerOwnerId;
     $this->group_id = $objFleet->group_id;
 
-    foreach($objFleet->shipsIterator() as $unit_id => $unit) {
-      if(!$unit->count) {
+    foreach ($objFleet->shipsIterator() as $unit_id => $unit) {
+      if (!$unit->count) {
         continue;
       }
 
       $unit_type = get_unit_param($unit_id, P_UNIT_TYPE);
-      if($unit_type == UNIT_SHIPS || $unit_type == UNIT_DEFENCE) {
+      if ($unit_type == UNIT_SHIPS || $unit_type == UNIT_DEFENCE) {
         $this->unit_list->unitAdjustCount($unit_id, $unit->count);
       }
     }
@@ -231,13 +231,13 @@ 
 //      }
 //    }
 
-    foreach($sn_group_combat as $unit_id) {
-      if($unit_count = mrc_get_level($player_db_row, $planet_row, $unit_id)) {
+    foreach ($sn_group_combat as $unit_id) {
+      if ($unit_count = mrc_get_level($player_db_row, $planet_row, $unit_id)) {
         $this->unit_list->unitAdjustCount($unit_id, $unit_count);
       }
     }
 
-    foreach(sn_get_groups('resources_loot') as $resource_id) {
+    foreach (sn_get_groups('resources_loot') as $resource_id) {
       $this->resource_list[$resource_id] = floor(mrc_get_level($player_db_row, $planet_row, $resource_id));
     }
 
@@ -296,27 +296,27 @@ 
       $ube_report_id,
       $this->db_id,
 
-      (float)$this->resources_lost_on_units[RES_METAL],
-      (float)$this->resources_lost_on_units[RES_CRYSTAL],
-      (float)$this->resources_lost_on_units[RES_DEUTERIUM],
-      (float)$this->cargo_dropped[RES_METAL],
-      (float)$this->cargo_dropped[RES_CRYSTAL],
-      (float)$this->cargo_dropped[RES_DEUTERIUM],
-      (float)$this->resources_looted[RES_METAL],
-      (float)$this->resources_looted[RES_CRYSTAL],
-      (float)$this->resources_looted[RES_DEUTERIUM],
-      (float)$this->resources_lost_in_metal[RES_METAL],
+      (float) $this->resources_lost_on_units[RES_METAL],
+      (float) $this->resources_lost_on_units[RES_CRYSTAL],
+      (float) $this->resources_lost_on_units[RES_DEUTERIUM],
+      (float) $this->cargo_dropped[RES_METAL],
+      (float) $this->cargo_dropped[RES_CRYSTAL],
+      (float) $this->cargo_dropped[RES_DEUTERIUM],
+      (float) $this->resources_looted[RES_METAL],
+      (float) $this->resources_looted[RES_CRYSTAL],
+      (float) $this->resources_looted[RES_DEUTERIUM],
+      (float) $this->resources_lost_in_metal[RES_METAL],
     );
   }
 
   public function report_render_outcome_side_fleet() {
     $UBE_DEFENCE_RESTORE = array();
     $UBE_UNITS_LOST = array();
-    foreach($this->unit_list->_container as $UBEUnit) {
-      if($UBEUnit->units_restored) {
+    foreach ($this->unit_list->_container as $UBEUnit) {
+      if ($UBEUnit->units_restored) {
         $UBE_DEFENCE_RESTORE[$UBEUnit->unitId] = $UBEUnit->units_restored;
       }
-      if($UBEUnit->units_lost) {
+      if ($UBEUnit->units_lost) {
         $UBE_UNITS_LOST[$UBEUnit->unitId] = $UBEUnit->units_lost;
       }
     }
@@ -341,16 +341,16 @@ 
    */
   protected function report_render_outcome_side_fleet_line(&$array, $lang_header_index) {
     $result = array();
-    if(!empty($array)) {
-      foreach($array as $unit_id => $unit_count) {
-        if($unit_count) {
+    if (!empty($array)) {
+      foreach ($array as $unit_id => $unit_count) {
+        if ($unit_count) {
           $result[] = array(
             'NAME' => classLocale::$lang['tech'][$unit_id],
             'LOSS' => pretty_number($unit_count),
           );
         }
       }
-      if($lang_header_index && count($result)) {
+      if ($lang_header_index && count($result)) {
         array_unshift($result, array('NAME' => classLocale::$lang[$lang_header_index]));
       }
     }
@@ -363,16 +363,16 @@ 
     $fleet_id = $this->db_id;
 
     $unit_sort_order = 0;
-    foreach($this->unit_list->_container as $UBEUnit) {
-      if($UBEUnit->units_lost || $UBEUnit->units_restored) {
+    foreach ($this->unit_list->_container as $UBEUnit) {
+      if ($UBEUnit->units_lost || $UBEUnit->units_restored) {
         $unit_sort_order++;
         $sql_perform_report_unit[] = array(
           $ube_report_id,
           $fleet_id,
 
           $UBEUnit->unitId,
-          (float)$UBEUnit->units_restored,
-          (float)$UBEUnit->units_lost,
+          (float) $UBEUnit->units_restored,
+          (float) $UBEUnit->units_lost,
 
           $unit_sort_order,
         );
@@ -388,9 +388,9 @@ 
   function ube_combat_result_calculate_resources() {
     $resource_delta_fleet = array();
     // Если во флоте остались юниты или это планета - генерируем изменение ресурсов
-    foreach(sn_get_groups('resources_loot') as $resource_id) {
-      $resource_change = (float)$this->resources_looted[$resource_id] + (float)$this->cargo_dropped[$resource_id];
-      if($resource_change) {
+    foreach (sn_get_groups('resources_loot') as $resource_id) {
+      $resource_change = (float) $this->resources_looted[$resource_id] + (float) $this->cargo_dropped[$resource_id];
+      if ($resource_change) {
         $resource_delta_fleet[$resource_id] = -($resource_change);
       }
     }
@@ -423,12 +423,12 @@ 
     );
 
     $this->fleet_capacity = 0;
-    foreach($this->unit_list->_container as $UBEUnit) {
+    foreach ($this->unit_list->_container as $UBEUnit) {
       $this->fleet_capacity += $UBEUnit->capacity * $UBEUnit->getCount();
 
-      if($UBEUnit->units_lost) {
-        foreach($UBEUnit->price as $resource_id => $unit_resource_price) {
-          if(!$unit_resource_price) {
+      if ($UBEUnit->units_lost) {
+        foreach ($UBEUnit->price as $resource_id => $unit_resource_price) {
+          if (!$unit_resource_price) {
             continue;
           }
 
@@ -436,7 +436,7 @@ 
           $this->resources_lost_on_units[$resource_id] += $resources_lost;
           // Если это корабль - прибавляем потери к обломкам на орбите
           // TODO - опция выбрасывания обороны в обломки
-          if($UBEUnit->getType() == UNIT_SHIPS) {
+          if ($UBEUnit->getType() == UNIT_SHIPS) {
             $this->resources_lost_on_ships[$resource_id] += $resources_lost;
           }
         }
@@ -448,11 +448,11 @@ 
 
     // Если емкость трюмов меньше количество ресурсов - часть ресов выбрасываем нахуй
     // На планете ($fleet_id = 0) ресурсы в космос не выбрасываются
-    if($this->db_id != 0 && $this->fleet_capacity < $fleet_total_resources) {
+    if ($this->db_id != 0 && $this->fleet_capacity < $fleet_total_resources) {
       $drop_share = 1 - $this->fleet_capacity / $fleet_total_resources; // Какая часть ресурсов выброшена
-      foreach($this->resource_list as $resource_id => &$resource_amount) {
+      foreach ($this->resource_list as $resource_id => &$resource_amount) {
         // Не просчитываем ресурсы, которых нет на борту кораблей флота
-        if(!$resource_amount) {
+        if (!$resource_amount) {
           continue;
         }
 
@@ -473,19 +473,19 @@ 
     $objFleet2->setDbId($this->db_id);
 
     // Если это была миссия Уничтожения И звезда смерти взорвалась И мы работаем с аттакерами - значит все аттакеры умерли
-    if($this->is_attacker == UBE_PLAYER_IS_ATTACKER && $reapers_status == UBE_MOON_REAPERS_DIED) {
+    if ($this->is_attacker == UBE_PLAYER_IS_ATTACKER && $reapers_status == UBE_MOON_REAPERS_DIED) {
       $objFleet2->dbDelete();
-    } elseif($ship_count_initial == 0) { // $ship_count_lost == $ship_count_initial ||
+    } elseif ($ship_count_initial == 0) { // $ship_count_lost == $ship_count_initial ||
       $objFleet2->dbDelete();
     } else {
-      if($ship_count_lost) {
+      if ($ship_count_lost) {
         // Просматриваем результаты изменения флотов
-        foreach($this->unit_list->_container as $UBEUnit) {
+        foreach ($this->unit_list->_container as $UBEUnit) {
           // Перебираем аутком на случай восстановления юнитов
 //          if(($units_left = $UBEUnit->getCount() - (float)$UBEUnit->units_lost) > 0) {
 //            $fleet_real_array[$UBEUnit->unitId] = $units_left;
 //          };
-          if(floatval($UBEUnit->units_lost) != 0) {
+          if (floatval($UBEUnit->units_lost) != 0) {
             $objFleet2->shipAdjustCount($UBEUnit->unitId, floatval($UBEUnit->units_lost));
           };
         }
@@ -495,7 +495,7 @@ 
       $objFleet2->resourcesAdjust($resource_delta_fleet);
 
       // Если защитник и не РМФ - отправляем флот назад
-      if($this->is_attacker == UBE_PLAYER_IS_ATTACKER || ($this->is_attacker == UBE_PLAYER_IS_DEFENDER && !$is_small_fleet_recce)) {
+      if ($this->is_attacker == UBE_PLAYER_IS_ATTACKER || ($this->is_attacker == UBE_PLAYER_IS_DEFENDER && !$is_small_fleet_recce)) {
         $objFleet2->markReturned();
       }
       $objFleet2->dbSave();
@@ -525,7 +525,7 @@ 
   public function calculate_unit_partial_data(UBEASA $side_ASA) {
     $this->fleet_share_of_side_armor = $this->total_stats[P_ARMOR] / $side_ASA->getArmor();
 
-    foreach($this->unit_list->_container as $UBEUnit) {
+    foreach ($this->unit_list->_container as $UBEUnit) {
       $UBEUnit->share_of_side_armor = $UBEUnit->pool_armor / $side_ASA->getArmor();
     }
   }
@@ -537,9 +537,9 @@ 
    * @version 2016-02-25 23:42:45 41a4.68
    */
   public function attack_fleets(UBEFleetList $fleet_list, $is_simulator) {
-    foreach($fleet_list->_container as $defending_fleet) {
+    foreach ($fleet_list->_container as $defending_fleet) {
       // Не атакуются флоты на своей стороне
-      if($this->is_attacker == $defending_fleet->is_attacker) {
+      if ($this->is_attacker == $defending_fleet->is_attacker) {
         continue;
       }
       $this->attack_fleet($defending_fleet, $is_simulator);
@@ -555,12 +555,12 @@ 
   public function attack_fleet(UBEFleet $defending_fleet, $is_simulator) {
     UBEDebug::unit_dump_header();
 
-    foreach($this->unit_list->_container as $attacking_unit_pool) {
+    foreach ($this->unit_list->_container as $attacking_unit_pool) {
       UBEDebug::unit_dump($attacking_unit_pool, 'attacker');
 
       // if($attack_unit_count <= 0) continue; // TODO: Это пока нельзя включать - вот если будут "боевые порядки юнитов..."
-      foreach($defending_fleet->unit_list->_container as $defending_unit_pool) {
-        if($defending_unit_pool->isEmpty()) {
+      foreach ($defending_fleet->unit_list->_container as $defending_unit_pool) {
+        if ($defending_unit_pool->isEmpty()) {
           continue;
         }
 

classes/UBE/UBEFleetList.php

Doc Comments +3 added lines

@@ -278,6 +278,9 @@
     return count($this->ube_side_present_at_round_start);
   }
 
+  /**
+   * @param integer $round
+   */
   public function ubeAnalyzeFleetOutcome($round) {
     $this->ube_actualize_sides();
 

Spacing +23 added lines, -23 removed lines

@@ -82,13 +82,13 @@ 
    */
   public function ube_db_load_fleets_outcome($report_row) {
     $query = doquery("SELECT * FROM {{ube_report_outcome_fleet}} WHERE `ube_report_id` = {$report_row['ube_report_id']}");
-    while($row = db_fetch($query)) {
+    while ($row = db_fetch($query)) {
       $fleet_id = $row['ube_report_outcome_fleet_fleet_id'];
       $this[$fleet_id]->load_outcome_from_report_row($row);
     }
 
     $query = doquery("SELECT * FROM {{ube_report_outcome_unit}} WHERE `ube_report_id` = {$report_row['ube_report_id']} ORDER BY `ube_report_outcome_unit_sort_order`");
-    while($row = db_fetch($query)) {
+    while ($row = db_fetch($query)) {
       $fleet_id = $row['ube_report_outcome_unit_fleet_id'];
       $this[$fleet_id]->load_unit_outcome_from_row($row);
     }
@@ -108,7 +108,7 @@ 
       UBE_PLAYER_IS_DEFENDER => array(),
     );
 
-    foreach($this->_container as $fleet_id => $UBEFleet) {
+    foreach ($this->_container as $fleet_id => $UBEFleet) {
       $result[$UBEFleet->is_attacker][] = array(
         'ID'          => $fleet_id,
         'NAME'        => $ube->players[$UBEFleet->owner_id]->name,
@@ -131,11 +131,11 @@ 
    */
   public function ube_analyze_fleets($is_simulator, UBEDebris $debris, array $resource_exchange_rates) {
     // Генерируем результат боя
-    foreach($this->_container as $fleet_id => $UBEFleet) {
+    foreach ($this->_container as $fleet_id => $UBEFleet) {
       // Инициализируем массив результатов для флота
 //      $this->init_fleet_outcome_and_link_to_side($UBEFleet);
 
-      foreach($UBEFleet->unit_list->_container as $UBEUnit) {
+      foreach ($UBEFleet->unit_list->_container as $UBEUnit) {
         $UBEUnit->ube_analyze_unit($is_simulator);
       }
 
@@ -152,10 +152,10 @@ 
       $this->resources_lost_in_metal = array(
         RES_METAL => 0,
       );
-      foreach($UBEFleet->resources_lost_on_units as $resource_id => $resource_amount) {
+      foreach ($UBEFleet->resources_lost_on_units as $resource_id => $resource_amount) {
         $UBEFleet->resources_lost_in_metal[RES_METAL] += $resource_amount * $resource_exchange_rates[$resource_id];
       }
-      foreach($UBEFleet->cargo_dropped as $resource_id => $resource_amount) {
+      foreach ($UBEFleet->cargo_dropped as $resource_id => $resource_amount) {
         $UBEFleet->resources_lost_in_metal[RES_METAL] += $resource_amount * $resource_exchange_rates[$resource_id];
       }
     }
@@ -166,8 +166,8 @@ 
    */
   public function ube_get_groups() {
     $result = array();
-    foreach($this->_container as $UBEFleet) {
-      if($UBEFleet->group_id) {
+    foreach ($this->_container as $UBEFleet) {
+      if ($UBEFleet->group_id) {
         $result[$UBEFleet->group_id] = $UBEFleet->group_id;
       }
     }
@@ -180,8 +180,8 @@ 
    */
   public function ube_get_capacity_attackers() {
     $result = 0;
-    foreach($this->_container as $UBEFleet) {
-      if($UBEFleet->is_attacker) {
+    foreach ($this->_container as $UBEFleet) {
+      if ($UBEFleet->is_attacker) {
         $result += $UBEFleet->fleet_capacity;
       }
     }
@@ -195,7 +195,7 @@ 
    */
   public function ube_db_load_from_report_row(array $report_row, UBE $ube) {
     $query = doquery("SELECT * FROM {{ube_report_fleet}} WHERE `ube_report_id` = {$report_row['ube_report_id']}");
-    while($fleet_row = db_fetch($query)) {
+    while ($fleet_row = db_fetch($query)) {
       $objFleet = new UBEFleet();
       $objFleet->load_from_report($fleet_row, $ube);
       $this[$objFleet->db_id] = $objFleet;
@@ -209,20 +209,20 @@ 
    * @version 2016-02-25 23:42:45 41a4.68
    */
   public function ube_prepare_for_next_round($is_simulator) {
-    foreach($this->_container as $fleet_id => $UBEFleet) {
+    foreach ($this->_container as $fleet_id => $UBEFleet) {
       $UBEFleet->prepare_for_next_round($is_simulator);
     }
 
     // Суммируем данные по атакующим и защитникам
     $this->ube_total[UBE_PLAYER_IS_ATTACKER]->_reset();
     $this->ube_total[UBE_PLAYER_IS_DEFENDER]->_reset();
-    foreach($this->_container as $fleet_id => $UBEFleet) {
+    foreach ($this->_container as $fleet_id => $UBEFleet) {
       $this->ube_total[$UBEFleet->is_attacker]->add_unit_stats_array($UBEFleet->total_stats);
     }
 //pvar_dump($this->ube_total);
 
     // Высчитываем долю атаки, приходящейся на юнит равную отношению брони юнита к общей броне - крупные цели атакуют чаще
-    foreach($this->_container as $fleet_id => $UBEFleet) {
+    foreach ($this->_container as $fleet_id => $UBEFleet) {
       $UBEFleet->calculate_unit_partial_data($this->ube_total[$UBEFleet->is_attacker]);
     }
   }
@@ -236,7 +236,7 @@ 
    */
   public function ube_calculate_attack_results(UBE $ube) {
     // Каждый флот атакует все
-    foreach($this->_container as $attack_fleet_data) {
+    foreach ($this->_container as $attack_fleet_data) {
       defined('DEBUG_UBE') ? print("Fleet {$attack_fleet_data->db_id} attacks<br /><div style='margin-left: 30px;'>") : false;
 
       $attack_fleet_data->attack_fleets($this, $ube->is_simulator);
@@ -251,8 +251,8 @@ 
    * @version 2016-02-25 23:42:45 41a4.68
    */
   public function ube_actualize_sides() {
-    foreach($this->_container as $UBEFleet) {
-      if($UBEFleet->get_unit_count() > 0) {
+    foreach ($this->_container as $UBEFleet) {
+      if ($UBEFleet->get_unit_count() > 0) {
         $this->ube_side_present_at_round_start[$UBEFleet->is_attacker] = 1;
       }
     }
@@ -265,8 +265,8 @@ 
    */
   public function ube_calculate_attack_reapers() {
     $reapers = 0;
-    foreach($this->_container as $fleet_id => $UBERoundFleetCombat) {
-      if($UBERoundFleetCombat->is_attacker == UBE_PLAYER_IS_ATTACKER) {
+    foreach ($this->_container as $fleet_id => $UBERoundFleetCombat) {
+      if ($UBERoundFleetCombat->is_attacker == UBE_PLAYER_IS_ATTACKER) {
         $reapers += $UBERoundFleetCombat->unit_list->unitCountReapers();
       }
     }
@@ -283,10 +283,10 @@ 
 
     $result = UBE_COMBAT_RESULT_DRAW;
     // Проверяем результат боя
-    if($this->ube_get_sides_count() == 0 || $round >= 10) {
+    if ($this->ube_get_sides_count() == 0 || $round >= 10) {
       // Если кого-то не осталось или не осталось обоих - заканчиваем цикл
       $result = UBE_COMBAT_RESULT_DRAW_END;
-    } elseif($this->ube_get_sides_count() == 1) {
+    } elseif ($this->ube_get_sides_count() == 1) {
       // Если осталась одна сторона - она и выиграла
       $result = isset($this->ube_side_present_at_round_start[UBE_PLAYER_IS_ATTACKER]) ? UBE_COMBAT_RESULT_WIN : UBE_COMBAT_RESULT_LOSS;
     }
@@ -303,7 +303,7 @@ 
    * @version 41a6.16
    */
   public function ubeInitGetAttackers(Fleet $objFleet, UBEPlayerList $players) {
-    if($objFleet->group_id) {
+    if ($objFleet->group_id) {
       $fleets_added = $this->dbLoadWhere("`fleet_group` = {$objFleet->group_id}");
     } else {
       $this->ube_insert_from_Fleet($objFleet);