Skip to content

15. Anwendungsaufgabe – Version 7

Image

15.1. Implementierung

Hier werden wir uns noch einmal mit Version 6 befassen, indem wir die in den Hauptskripten verwendeten Konstanten in eine Konfigurationsdatei verschieben. Die Konfigurationsdatei wird eine JSON-Datei mit folgendem Inhalt sein:


{
    "rootDirectory": "C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-07",
    "databaseFilename": "Data/database.json",
    "taxAdminDataFileName": "Data/taxadmindata.json",
    "taxPayersDataFileName": "Data/taxpayersdata.json",
    "resultsFileName": "Data/results.json",
    "errorsFileName": "Data/errors.json",
    "dependencies": {
        "BaseEntity": "/../version-05/Entities/BaseEntity.php",
        "TaxAdminData": "/../version-05/Entities/TaxAdminData.php",
        "TaxPayerData": "/../version-05/Entities/TaxPayerData.php",
        "Database": "/../version-05/Entities/Database.php",
        "ExceptionImpots": "/../version-05/Entities/ExceptionImpots.php",
        "Utilitaires": "/../version-05/Utilities/Utilitaires.php",
        "InterfaceDao": "/../version-05/Dao/InterfaceDao.php",
        "TraitDao": "/../version-05/Dao/TraitDao.php",
        "InterfaceDao4TransferAdminData2Database": "/../version-05/Dao/InterfaceDao4TransferAdminData2Database.php",
        "DaoTransferAdminDataFromJsonFile2Database": "/../version-05/Dao/DaoTransferAdminDataFromJsonFile2Database.php",        
        "DaoImpotsWithTaxAdminDataInDatabase": "/../version-05/Dao/DaoImpotsWithTaxAdminDataInDatabase.php",
        "InterfaceMetier": "/../version-05/Métier/InterfaceMetier.php",
        "Metier": "/../version-05/Métier/Metier.php"
    },
    "dependencies4calculate": [
        "BaseEntity",
        "TaxAdminData",
        "TaxPayerData",
        "Database",
        "ExceptionImpots",
        "Utilitaires",
        "InterfaceDao",
        "TraitDao",
        "DaoImpotsWithTaxAdminDataInDatabase",
        "InterfaceMetier",
        "Metier"],
    "dependencies4transfer": [
        "BaseEntity",
        "TaxAdminData",
        "Database",
        "ExceptionImpots",
        "Utilitaires",
        "InterfaceDao",
        "TraitDao",  
        "InterfaceDao4TransferAdminData2Database",
        "DaoTransferAdminDataFromJsonFile2Database"]
}

In dieser Konfiguration:

  • Zeile 2: das Verzeichnis, von dem aus alle Pfade in dieser Konfigurationsdatei gemessen werden;
  • Zeilen 3–7: die Pfade zu allen JSON-Dateien in der Anwendung;
  • Zeilen 8–22: die Pfade zu allen Anwendungsdateien in der Form [Schlüssel=>Pfad];
  • Zeilen 23–34: die Abhängigkeiten für die Steuerberechnung in Form einer Liste von Schlüsseln aus dem [dependencies]-Wörterbuch (Zeilen 8–22);
  • Zeilen 35–44: Abhängigkeiten für die Übertragung der JSON-Datei [taxadmindata.json] in die Datenbank in Form einer Liste von Schlüsseln aus dem Wörterbuch [dependencies] (Zeilen 8–22);

Das Skript zum Übertragen der Steuerverwaltungsdaten in die Datenbank [MainTransferAdminDataFromFile2PostgresSQLDatabase.php] sieht nun wie folgt aus:


<?php
 
// strict adherence to declared types of function parameters
declare (strict_types=1);
 
// namespace
namespace Application;
 
// error handling by PHP
// ini_set("display_errors", "0");
//
// configuration file path
define("CONFIG_FILENAME", "../Data/config.json");
 
// we retrieve the configuration
$config = \json_decode(\file_get_contents(CONFIG_FILENAME), true);
 
// include the necessary script dependencies
$rootDirectory = $config["rootDirectory"];
foreach ($config["dependencies4transfer"] as $dependency) {
  require $rootDirectory . $config["dependencies"][$dependency];
}
 
// definition of constants
define("DATABASE_CONFIG_FILENAME", "$rootDirectory/{$config["databaseFilename"]}");
define("TAXADMINDATA_FILENAME", "$rootDirectory/{$config["taxAdminDataFileName"]}");
 
//
try {
  // creation of the [dao] layer
  $dao = new DaoTransferAdminDataFromJsonFile2Database(DATABASE_CONFIG_FILENAME, TAXADMINDATA_FILENAME);
  // data transfer to the database
  $dao->transferAdminData2Database();
} catch (ExceptionImpots $ex) {
  // error is displayed
  print $ex->getMessage() . "\n";
}
// end
print "Terminé\n";
exit;

Kommentare

Der Code bleibt derselbe wie im verlinkten Abschnitt. Der einzige Unterschied besteht in der Verwendung der Datei [config.json] anstelle von Konstanten in den Zeilen 18–26;

  • Zeile 16: Die Funktion [file_get_contents] überträgt die Datei [config.json] in eine Zeichenkette. Die Funktion [json_decode] verwendet diese Zeichenkette dann, um das Wörterbuch [$config] zu erstellen. Der zweite Parameter [true] der Funktion [json_decode] gibt an, dass wir ein Wörterbuch erstellen möchten;
  • Zeilen 19–22: Wir fügen die Abhängigkeiten ein, die das Skript benötigt, um Daten aus der Datei [taxadmindata.json] in die Datenbank zu übertragen;
    • [$config["dependencies4transfer"]] ist das Array der vom Übertragungsskript benötigten Abhängigkeiten. Es handelt sich um eine Liste von Schlüsseln. Die Pfade der in das Projekt einzubindenden Dateien befinden sich im Wörterbuch [$config["dependencies"]];
    • $config["rootDirectory"] steht für den Pfad, mit dem die einzubindenden Dateien vorangestellt werden müssen;

Entsprechend sieht das Steuerberechnungsskript wie folgt aus [MainCalculateImpotsWithTaxAdminDataInPostgresDatabase]:


<?php
 
// strict adherence to declared types of function parameters
declare (strict_types=1);
 
// namespace
namespace Application;
 
// error handling by PHP
// ini_set("display_errors", "0");
//
// configuration file path
define("CONFIG_FILENAME", "../Data/config.json");
 
// we retrieve the configuration
$config = \json_decode(\file_get_contents(CONFIG_FILENAME), true);
 
// include the necessary script dependencies
$rootDirectory = $config["rootDirectory"];
foreach ($config["dependencies4calculate"] as $dependency) {
  require $rootDirectory . $config["dependencies"][$dependency];
}
 
// definition of constants
define("DATABASE_CONFIG_FILENAME", "$rootDirectory/{$config["databaseFilename"]}");
define("TAXPAYERSDATA_FILENAME", "$rootDirectory/{$config["taxPayersDataFileName"]}");
define("RESULTS_FILENAME", "$rootDirectory/{$config["resultsFileName"]}");
define("ERRORS_FILENAME", "$rootDirectory/{$config["errorsFileName"]}");
 
//
try {
  // creation of the [dao] layer
  $dao = new DaoImpotsWithTaxAdminDataInDatabase(DATABASE_CONFIG_FILENAME);
  // creation of the [business] layer
  $métier = new Metier($dao);
  // tax calculation in batch mode
  $métier->executeBatchImpots(TAXPAYERSDATA_FILENAME, RESULTS_FILENAME, ERRORS_FILENAME);
} catch (ExceptionImpots $ex) {
  // error is displayed
  print "Une erreur s'est produite : " . utf8_encode($ex->getMessage()) . "\n";
}
// end
print "Terminé\n";
exit;

15.2. Tests [Codeception]

Diese Version wird, wie die vorherigen, durch [Codeception]-Tests validiert.

Image

15.2.1. Testen der [DAO]-Schicht

Der [DaoTest.php]-Test sieht wie folgt aus:


<?php
 
// strict adherence to declared function parameter types
declare (strict_types=1);
 
// namespace
namespace Application;
 
// defining constants
define("ROOT", "C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-07");
// configuration file path
define("CONFIG_FILENAME", ROOT."/Data/config.json");
// we retrieve the configuration
$config = \json_decode(\file_get_contents(CONFIG_FILENAME), true);
// include the necessary script dependencies
$rootDirectory = $config["rootDirectory"];
foreach ($config["dependencies4calculate"] as $dependency) {
  require $rootDirectory . $config["dependencies"][$dependency];
}
// other constants
define("DATABASE_CONFIG_FILENAME", "$rootDirectory/{$config["databaseFilename"]}");
 
// test -----------------------------------------------------
 
class DaoTest extends \Codeception\Test\Unit {
  // TaxAdminData
  private $taxAdminData;
 
  public function __construct() {
    parent::__construct();
    // creation of the [dao] layer
    $dao = new DaoImpotsWithTaxAdminDataInDatabase(DATABASE_CONFIG_FILENAME);
    $this->taxAdminData = $dao->getTaxAdminData();
  }
 
  // tests
  public function testTaxAdminData() {
    …
  }
 
}

Kommentare

  • Zeilen 9–21: Definition der Testumgebung. Wir verwenden dieselbe Umgebung ohne die [Business]-Schicht wie das im verlinkten Abschnitt beschriebene Hauptskript [MainCalculateImpotsWithTaxAdminDataInPostgresDatabase];
  • Zeilen 29–34: Aufbau der [dao]-Schicht;
  • Zeile 33: Das Attribut [$this→taxAdminData] enthält die zu testenden Daten;
  • Zeilen 37–39: Die Methode [testTaxAdminData] ist diejenige, die im verlinkten Abschnitt beschrieben wird;

Die Testergebnisse lauten wie folgt:

Image

15.2.2. [Business]-Layer-Test

Der Test [MetierTest.php] sieht wie folgt aus:


<?php
 
// strict adherence to declared types of function parameters
declare (strict_types=1);
 
// namespace
namespace Application;
 
// defining constants
define("ROOT", "C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-07");
// configuration file path
define("CONFIG_FILENAME", ROOT . "/Data/config.json");
// we retrieve the configuration
$config = \json_decode(\file_get_contents(CONFIG_FILENAME), true);
// include the necessary script dependencies
$rootDirectory = $config["rootDirectory"];
foreach ($config["dependencies4calculate"] as $dependency) {
  require $rootDirectory . $config["dependencies"][$dependency];
}
// other constants
define("DATABASE_CONFIG_FILENAME", "$rootDirectory/{$config["databaseFilename"]}");
 
// test class
class MetierTest extends \Codeception\Test\Unit {
  // business layer
  private $métier;
 
  public function __construct() {
    parent::__construct();
    // creation of the [dao] layer
    $dao = new DaoImpotsWithTaxAdminDataInDatabase(DATABASE_CONFIG_FILENAME);
    // creation of the [business] layer
    $this->métier = new Metier($dao);
  }
 
  // tests
  public function test1() {
    …
  }
 
  -----------------------------------
 
  public function test11() {
    …
  }
 
}

Kommentare

  • Zeilen 9–21: Definition der Testumgebung. Wir verwenden dieselbe wie im Hauptskript [MainCalculateImpotsWithTaxAdminDataInPostgresDatabase], das im verlinkten Abschnitt beschrieben wird;
  • Zeilen 28–34: Aufbau der [dao]-Schicht;
  • Zeile 33: Das Attribut [$this→business] ist eine Referenz auf die zu testende [business]-Schicht;
  • Zeilen 37–45: Die Methoden [test1, test2…, test11] sind diejenigen, die im verlinkten Abschnitt beschrieben sind;

Die Testergebnisse lauten wie folgt:

Image

https://stahe.github.io
Dieses Tutorial, verfasst von Serge Tahé, wird der Öffentlichkeit gemäß den Bedingungen der Creative Commons Namensnennung – Nicht kommerziell – ShareAlike 3.0 Unported.