DatabaseMigrator

Author: Sebastian Michaelsen

README.md

@@ -1,6 +1,6 @@
 # PHPFramework Documentation
 
-This documentation refers to version 1.3 of [our fork](https://github.com/app-zap/PHPFramework) of the [PHPFramework](https://github.com/Luzifer/PHPFramework) which was developed by Knut Ahlers.
+This documentation refers to version 1.4 of [our fork](https://github.com/app-zap/PHPFramework) of the [PHPFramework](https://github.com/Luzifer/PHPFramework) which was developed by Knut Ahlers.
 
 Don't worry, there will be a new name soon to get rid of this confusion.
 

SUMMARY.md

@@ -11,5 +11,6 @@
    * [Signal/Slot](in-depth_documentation/signalslot.md)
    * [Plugin](in-depth_documentation/plugin.md)
    * [Domain Driven Design and ORM](in-depth_documentation/domain_driven_design_and_orm.md)
+   * [DatabaseMigrator](in-depth_documentation/databasemigrator.md)
 * [Versions](versions/README.md)
 

in-depth_documentation/databasemigrator.md

@@ -0,0 +1,17 @@
+# DatabaseMigrator
+
+PHPFramework ships with a DatabaseMigrator which allows you to execute SQL files automatically. The migrator works only one-way at the moment.
+
+## How it works
+
+The migrator must be enabled and a directory must be provided (see the Configuration section for the details).
+
+If it is enabled it is invoked on every call to the framework at an early point of execution (from a Signal in the constructor of the Dispatcher).
+
+It executes numbered `.sql` files in the right order and remembers the last executed number. Each file is only executed once.
+
+At the moment the `.sql` files must start at `1` and must increase without omitting any numbers. ([It's planned](https://github.com/app-zap/PHPFramework/issues/24) to change that to be less restricitive).
+
+Files can either just contain the number as filename (`21.sql`) or also description separated from the number by underscore (`22_user_table.sql`).
+
+All files must be directly in the configured directory. Subdirectories are not supported at the moment.