Changeset 887 for trunk/Modules/Finance/Finance.php

Timestamp:

Nov 20, 2020, 12:08:12 AM (3 years ago)

Author:

chronos

Message:

• Added: Static types added to almost all classes, methods and function. Supported by PHP 7.4.
• Fixed: Various found code issues.

File:

• trunk/Modules/Finance/Finance.php (modified) (20 diffs)

trunk/Modules/Finance/Finance.php

@@ -41 +41 @@
   var $Rounding;
 
-  function LoadMonthParameters($Period = 1) // 0 - now, 1 - next month
+  function LoadMonthParameters(int $Period = 1) // 0 - now, 1 - next month
   {
     $DbResult = $this->Database->query('SELECT * FROM `FinanceBillingPeriod`');
@@ -78 +78 @@
   }
 
-  function W2Kc($Spotreba)
+  function W2Kc($Spotreba): string
   {
     return round($Spotreba * 0.72 * $this->kWh);
@@ -88 +88 @@
     $EndTime = mktime(0, 0, 0, 12, 31, $Year);
     $this->Database->insert('FinanceYear', array('Year' => $Year,
-          'DateStart' => TimeToMysqlDate($StartTime), 'DateEnd' => TimeToMysqlDate($EndTime), 'Closed' => 0));
-        $YearId = $this->Database->insert_id;
+            'DateStart' => TimeToMysqlDate($StartTime), 'DateEnd' => TimeToMysqlDate($EndTime), 'Closed' => 0));
+          $YearId = $this->Database->insert_id;
 
     // Create DocumentLineSequence from previous
@@ -95 +95 @@
     while ($DbRow = $DbResult->fetch_assoc())
     {
-          $this->Database->insert('DocumentLineSequence', array('FinanceYear' => $YearId,
-            'NextNumber' => 1, 'YearPrefix' => 1, 'DocumentLine' => $DbRow['Id']));
-        }
-  }
-
-  function GetFinanceYear($Year)
+            $this->Database->insert('DocumentLineSequence', array('FinanceYear' => $YearId,
+              'NextNumber' => 1, 'YearPrefix' => 1, 'DocumentLine' => $DbRow['Id']));
+          }
+  }
+
+  function GetFinanceYear(int $Year)
   {
     if ($Year == 0)
@@ -107 +107 @@
       $DbResult = $this->Database->select('FinanceYear', '*', '1 ORDER BY `Year` DESC LIMIT 1');
     } else $DbResult = $this->Database->select('FinanceYear', '*', '`Year`='.$Year);
-    if ($DbResult->num_rows == 0) {
-          if ($Year == date('Y'))
-          {
-                $this->CreateFinanceYear($Year);
+    if ($DbResult->num_rows == 0)
+    {
+            if ($Year == date('Y'))
+            {
+                    $this->CreateFinanceYear($Year);
         $DbResult = $this->Database->select('FinanceYear', '*', '`Year`='.$Year);
-          } else throw new Exception('Rok '.$Year.' nenalezen');
-        }
+            } else throw new Exception('Rok '.$Year.' nenalezen');
+          }
     $FinanceYear = $DbResult->fetch_assoc();
     if ($FinanceYear['Closed'] == 1)
@@ -120 +121 @@
   }
 
-  function GetNextDocumentLineNumber($Id, $FinanceYear = 0)
-  {
-        $FinanceYear = $this->GetFinanceYear($FinanceYear);
+  function GetNextDocumentLineNumber(string $Id, int $FinanceYear = 0)
+  {
+          $FinanceYear = $this->GetFinanceYear($FinanceYear);
 
     $DbResult = $this->Database->query('SELECT `Shortcut`, `Id` FROM `DocumentLine` WHERE `Id`='.$Id);
@@ -141 +142 @@
   }
 
-  function GetNextDocumentLineNumberId($Id, $FinanceYear = 0)
+  function GetNextDocumentLineNumberId(string $Id, int $FinanceYear = 0): int
   {
     $Code = $this->GetNextDocumentLineNumber($Id, $FinanceYear);
@@ -148 +149 @@
   }
 
-  function GetFinanceGroupById($Id, $Table)
+  function GetFinanceGroupById(string $Id, string $Table): ?array
   {
     $DbResult = $this->Database->query('SELECT * FROM `'.$Table.'` WHERE `Id`= '.$Id);
@@ -154 +155 @@
       $Group = $DbResult->fetch_assoc();
       return $Group;
-    } else die('Finance group id '.$Id.' not found in table '.$Table);
-  }
-
-  function RecalculateMemberPayment()
+    }
+    echo('Finance group id '.$Id.' not found in table '.$Table);
+    return null;
+  }
+
+  function RecalculateMemberPayment(): string
   {
     $Output = 'Aktualizuji finance členů...<br />';
@@ -199 +202 @@
       $Consumption = 0;
       $this->Database->insert('MemberPayment', array('Member' => $Member['Id'],
-          'MonthlyInternet' => $MonthlyInet,
-          'MonthlyTotal' => $Monthly, 'MonthlyConsumption' => $this->W2Kc($Consumption),
-          'Cash' => $Cash, 'MonthlyPlus' => $this->W2Kc($ConsumptionPlus)));
+        'MonthlyInternet' => $MonthlyInet,
+        'MonthlyTotal' => $Monthly, 'MonthlyConsumption' => $this->W2Kc($Consumption),
+        'Cash' => $Cash, 'MonthlyPlus' => $this->W2Kc($ConsumptionPlus)));
     }
-    $this->System->ModuleManager->Modules['Log']->NewRecord('Finance', 'RecalculateMemberPayment');
+    ModuleLog::Cast($this->System->GetModule('Log'))->NewRecord('Finance', 'RecalculateMemberPayment');
     return $Output;
   }
 
-  function GetVATByType($TypeId)
+  function GetVATByType(string $TypeId): string
   {
     $Time = time();
@@ -220 +223 @@
 class ModuleFinance extends AppModule
 {
-  function __construct($System)
+  public Finance $Finance;
+  public Bill $Bill;
+
+  function __construct(System $System)
   {
     parent::__construct($System);
@@ -229 +235 @@
     $this->Description = 'Base module for finance management';
     $this->Dependencies = array('File', 'EmailQueue');
-  }
-
-  function DoInstall()
-  {
-  }
-
-  function DoUninstall()
-  {
-  }
-
-  function DoStart()
+
+    $this->Bill = new Bill($this->System);
+    $this->Finance = new Finance($this->System);
+  }
+
+  function DoInstall(): void
+  {
+  }
+
+  function DoUninstall(): void
+  {
+  }
+
+  function DoStart(): void
   {
     global $Config;
 
-    $this->System->RegisterPage(array('finance', 'sprava'), 'PageFinanceManage');
-    $this->System->RegisterPage(array('finance', 'platby'), 'PageFinanceUserState');
-    $this->System->RegisterPage(array('finance', 'import'), 'PageFinanceImportPayment');
-    $this->System->RegisterPage(array('finance', 'zivnost'), 'PageFinanceTaxFiling');
+    $this->System->RegisterPage(['finance', 'sprava'], 'PageFinanceManage');
+    $this->System->RegisterPage(['finance', 'platby'], 'PageFinanceUserState');
+    $this->System->RegisterPage(['finance', 'import'], 'PageFinanceImportPayment');
+    $this->System->RegisterPage(['finance', 'zivnost'], 'PageFinanceTaxFiling');
 
     $this->System->FormManager->RegisterClass('FinanceOperation', array(
@@ -644 +653 @@
     ));
 
-
-    $this->System->AddModule(new Bill($this->System));
-    $this->System->AddModule(new Finance($this->System));
-    $this->System->Modules['Finance']->MainSubject = $Config['Finance']['MainSubjectId'];
-    $this->System->Modules['Finance']->DirectoryId = $Config['Finance']['DirectoryId'];
-
-    $this->System->ModuleManager->Modules['IS']->RegisterDashboardItem('Finance',
-      array('ModuleFinance', 'ShowDashboardItem'));
-  }
-
-  function ShowDashboardItem()
+    $this->Finance->MainSubject = $Config['Finance']['MainSubjectId'];
+    $this->Finance->DirectoryId = $Config['Finance']['DirectoryId'];
+
+    ModuleIS::Cast($this->System->GetModule('IS'))->RegisterDashboardItem('Finance', array($this, 'ShowDashboardItem'));
+  }
+
+  function ShowDashboardItem(): string
   {
     $DbResult = $this->Database->select('FinanceOperation', 'ROUND(SUM(`Value`))', '1');
@@ -662 +667 @@
   }
 
-  function DoStop()
-  {
-  }
-
-  function BeforeInsertFinanceOperation($Form)
+  function DoStop(): void
+  {
+  }
+
+  function BeforeInsertFinanceOperation(Form $Form): array
   {
     if (array_key_exists('Time', $Form->Values)) $Year = date("Y", $Form->Values['Time']);
       else $Year = date("Y", $Form->Values['ValidFrom']);
-    $FinanceGroup = $this->System->Modules['Finance']->GetFinanceGroupById($Form->Values['Group'], 'FinanceOperationGroup');
-    $Form->Values['BillCode'] = $this->System->Modules['Finance']->GetNextDocumentLineNumberId($FinanceGroup['DocumentLine'], $Year);
-    return $Form->Values;
-  }
-
-  function AfterInsertFinanceOperation($Form, $Id)
-  {
-    $FinanceGroup = $this->System->Modules['Finance']->GetFinanceGroupById($Form->Values['Group'], 'FinanceOperationGroup');
+    $FinanceGroup = $this->Finance->GetFinanceGroupById($Form->Values['Group'], 'FinanceOperationGroup');
+    $Form->Values['BillCode'] = $this->Finance->GetNextDocumentLineNumberId($FinanceGroup['DocumentLine'], $Year);
+    return $Form->Values;
+  }
+
+  function AfterInsertFinanceOperation(Form $Form, string $Id): array
+  {
+    $FinanceGroup = $this->Finance->GetFinanceGroupById($Form->Values['Group'], 'FinanceOperationGroup');
     $this->Database->query('UPDATE `'.$Form->Definition['Table'].'` SET `Value`= '.
       ($Form->Values['ValueUser'] * $FinanceGroup['ValueSign']).' WHERE `Id`='.$Id);
@@ -683 +688 @@
   }
 
-  function BeforeModifyFinanceOperation($Form, $Id)
-  {
-    $FinanceGroup = $this->System->Modules['Finance']->GetFinanceGroupById($Form->Values['Group'], 'FinanceOperationGroup');
+  function BeforeModifyFinanceOperation(Form $Form, string $Id): array
+  {
+    $FinanceGroup = $this->Finance->GetFinanceGroupById($Form->Values['Group'], 'FinanceOperationGroup');
     $this->Database->query('UPDATE `'.$Form->Definition['Table'].'` SET `Value`= '.
       ($Form->Values['ValueUser'] * $FinanceGroup['ValueSign']).' WHERE `Id`='.$Id);
@@ -691 +696 @@
   }
 
-  function BeforeInsertFinanceInvoice($Form)
+  function BeforeInsertFinanceInvoice(Form $Form): array
   {
     // Get new DocumentLineCode by selected invoice Group
     if (array_key_exists('Time', $Form->Values)) $Year = date("Y", $Form->Values['Time']);
       else $Year = date("Y", $Form->Values['ValidFrom']);
-    $Group = $this->System->Modules['Finance']->GetFinanceGroupById($Form->Values['Group'], 'FinanceInvoiceGroup');
-    $Form->Values['BillCode'] = $this->System->Modules['Finance']->GetNextDocumentLineNumberId($Group['DocumentLine'], $Year);
-    return $Form->Values;
-  }
-
-  function AfterInsertFinanceInvoice($Form, $Id)
-  {
-    $FinanceGroup = $this->System->Modules['Finance']->GetFinanceGroupById($Form->Values['Group'], 'FinanceInvoiceGroup');
+    $Group = $this->Finance->GetFinanceGroupById($Form->Values['Group'], 'FinanceInvoiceGroup');
+    $Form->Values['BillCode'] = $this->Finance->GetNextDocumentLineNumberId($Group['DocumentLine'], $Year);
+    return $Form->Values;
+  }
+
+  function AfterInsertFinanceInvoice(Form $Form, string $Id): array
+  {
+    $FinanceGroup = $this->Finance->GetFinanceGroupById($Form->Values['Group'], 'FinanceInvoiceGroup');
     $DbResult = $this->Database->query(str_replace('#Id', $Id, $Form->Definition['Items']['ValueUser']['SQL']));
     $DbRow = $DbResult->fetch_row();
@@ -713 +718 @@
   }
 
-  function BeforeModifyFinanceInvoice($Form, $Id)
-  {
-    $FinanceGroup = $this->System->Modules['Finance']->GetFinanceGroupById($Form->Values['Group'], 'FinanceInvoiceGroup');
+  function BeforeModifyFinanceInvoice(Form $Form, string $Id): array
+  {
+    $FinanceGroup = $this->Finance->GetFinanceGroupById($Form->Values['Group'], 'FinanceInvoiceGroup');
     $DbResult = $this->Database->query(str_replace('#Id', $Id, $Form->Definition['Items']['ValueUser']['SQL']));
     $DbRow = $DbResult->fetch_row();
@@ -724 +729 @@
   }
 
-  function AfterInsertFinanceInvoiceItem($Form, $Id)
+  function AfterInsertFinanceInvoiceItem(Form $Form, string $Id): array
   {
     $ParentForm = new Form($this->System->FormManager);
@@ -733 +738 @@
   }
 
-  function AfterModifyFinanceInvoiceItem($Form, $Id)
+  function AfterModifyFinanceInvoiceItem(Form $Form, string $Id): array
   {
     $ParentForm = new Form($this->System->FormManager);
@@ -742 +747 @@
   }
 
-  function BeforeInsertContract($Form)
+  function BeforeInsertContract(Form $Form): array
   {
     if (array_key_exists('Time', $Form->Values)) $Year = date("Y", $Form->Values['Time']);
       else $Year = date("Y", $Form->Values['ValidFrom']);
-    $Form->Values['BillCode'] = $this->System->Modules['Finance']->GetNextDocumentLineNumberId($Form->Values['DocumentLine'], $Year);
-    return $Form->Values;
+    $Form->Values['BillCode'] = $this->Finance->GetNextDocumentLineNumberId($Form->Values['DocumentLine'], $Year);
+    return $Form->Values;
+  }
+
+  static function Cast(AppModule $AppModule): ModuleFinance
+  {
+    if ($AppModule instanceof ModuleFinance)
+    {
+      return $AppModule;
+    }
+    throw new Exception('Expected ModuleFinance type but '.gettype($AppModule));
   }
 }