From: LeonardoBizzoni <leo2002714@gmail.com>
Date: Mon, 18 Apr 2022 09:32:18 +0000 (+0200)
Subject: Doc + createMigration script
X-Git-Url: http://git.leonardobizzoni.com/?a=commitdiff_plain;h=45c5f020239b7e34a5659f96024f24e1b539136d;p=highschool-graduation-project

Doc + createMigration script
---

diff --git a/README.org b/README.org
index 0517831..4e0bd79 100644
--- a/README.org
+++ b/README.org
@@ -210,18 +210,33 @@ if ($ruleName == self::RULE_MATCH && $value != $this->{$rule["match"]}) {
 #+end_src
 
 *** Database class
-Utilizza PDO per effettuare la connessione al server mariadb in esecuzione nel docker container.
+Il compito della Database class è quello di effettuare una connessione al server mariadb in esecuzione sul docker container ed applicare delle [[./www/Migrations][migration]].
 Sia le credenziali di accesso al database che il domain service name (DSN) sono salvate nel file "www/.env" (vedi [[./www/.env.example][.env.example]]) e per leggerle si utilizza il package [[https://github.com/vlucas/phpdotenv][phpdotenv]].
 
-Installazione:
+Installazione phpdotenv:
 #+begin_src bash
 cd www
 composer require vlucas/phpdotenv
 #+end_src
 
+Attraverso il metodo "applyMigrations()" la Database class è in grado di:
+- creare la migration table se non esiste nel DB
+- selezionare le migration presenti nella migration table
+- per ogni migration non presente nel DB, creare un'istanza ed esegue il metodo "up()"
+
 ** Migrations
-Contengono i cambiamenti efftuati in ordine sul database.
-/Formato migration: touch "m_$(date +%s)_name.php"/
+
+È importante che le migration class siano ordinate e che seguano tutte lo stesso stile di nomeclatura.
+La creazione di una migration class può essere effettuata tramite lo script [[./scripts/createMigration.sh][createMigration]].
+#+begin_src bash
+./scripts/createMigration pathToMigrationsDir migrationName
+#+end_src
+
+Queste classi vengono istanziate dalla core class *Database* attraverso il metodo "applyMigrations()".
+
+Ogni migration class è formata da _almeno_ 2 metodi:
+- "up()": esegue del codice SQL per effettuare una modifica al DB
+- "down()": esegue del codice SQL per annullare la modifica
 
 ** Models
 Le classi "Model" gestiscono i dati presenti nel database e controlla che i dati seguano delle determinate regole.
diff --git a/scripts/createMigration.sh b/scripts/createMigration.sh
new file mode 100755
index 0000000..5c7e694
--- /dev/null
+++ b/scripts/createMigration.sh
@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+name="m_$(date +%s)_$2"
+echo -e "<?php
+
+use app\\\core\\\Application;
+
+class $name
+{
+    public function up()
+    {
+        \$db = Application::\$app->db;
+        \$sql = \"\";
+        \$db->pdo->exec(\$sql);
+    }
+
+    public function down()
+    {
+        \$db = Application::\$app->db;
+        \$sql = \"\";
+        \$db->pdo->exec(\$sql);
+    }
+}
+?>" > "$1/$name.php"
diff --git a/www/core/Database.php b/www/core/Database.php
index 8c07075..35c1c31 100644
--- a/www/core/Database.php
+++ b/www/core/Database.php
@@ -71,11 +71,12 @@ CREATE TABLE IF NOT EXISTS migrations (
 
     public function saveMigration(array $migrations)
     {
-        $str = implode(",", array_map(fn($m) => "('$m')", $migrations));
+        $str = implode(",", array_map(fn ($m) => "('$m')", $migrations));
         $this->pdo->prepare("INSERT INTO migrations(migration) VALUES $str")->execute();
     }
 
-    protected function log(string $message) {
-        echo "[".date("Y/m/d H:m:s")."] - $message".PHP_EOL;
+    protected function log(string $message)
+    {
+        echo "[" . date("Y/m/d H:m:s") . "] - $message" . PHP_EOL;
     }
 }