refactor project

Author: Tilo Kowalski

README.md

@@ -1,5 +1,10 @@
-# Flink - PHP ORM Library
+# Flink - PHP Magic ORM Library
 
 **Development has been discontinued and further use is not recommended.**
 
-Library for automatic database entity mapping, fully functioning by magic methods.
+This project was a great learning experience for me and I formerly used it for a couple of personal projects. However, it does not meet my current standards for safety and code quality and I would not recommend using it for any new projects, especially not for production.
+
+## About the project
+
+Flink is a Library for automatic database entity mapping, fully functioning by magic methods.
+Entities are represented by classes which extend the `Entity` class. Each Entity requires a corresponding list and mapper class and can be used to automatically map database entries to objects and vice versa.

composer.json

@@ -1,8 +1,8 @@
 {
     "name": "tilokowalski/flink",
     "description": "ORM Library",
-    "type": "library",
     "license": "Apache-2.0",
+    "type": "library",
     "autoload": {
         "psr-4": {
             "Flink\\": "src/"
@@ -11,11 +11,11 @@
     "authors": [
         {
             "name": "Tilo Kowalski",
-            "email": "privat@tilokowalski.de"
+            "email": "dev@tilokowalski.de"
         }
     ],
     "minimum-stability": "stable",
     "require": {
-        "tilokowalski/delight": "^1.5"
+        "tilokowalski/delight": "^1.0"
     }
 }

composer.lock

@@ -8,4 +8,5 @@ public function __construct(?string $message = null) {
         if (null === $message) $message = 'failed to handle database';
         parent::__construct($message);
     }
+    
 }

src/Exception/Database.php

@@ -8,4 +8,5 @@ class QueryException extends \Flink\Exception\Database {
     public function __construct(mysqli_sql_exception $exception, string $query) {
         parent::__construct('"' . $query . '" ' . $exception->getMessage());
     }
+    
 }

src/Exception/Database/QueryException.php

@@ -8,4 +8,5 @@ public function __construct(?string $message = null) {
         if (null === $message) $message = 'failed to handle entity';
         parent::__construct($message);
     }
+    
 }

src/Exception/Entity.php

@@ -8,4 +8,5 @@ public function __construct(?string $message = null) {
         if (null === $message) $message = 'called function is not defined';
         parent::__construct($message);
     }
+    
 }

src/Exception/Entity/UndefinedFunction.php

@@ -8,4 +8,5 @@ public function __construct(string $class, string $attribute) {
         $message = $class . '->' . $attribute . ' is neither a property nor a mapped relation';
         parent::__construct($message);
     }
+    
 }