Merge pull request #530 from mevdschee/psr7

Implement PSR-7, PSR-15 and PSR-17

Author: mevdschee

.gitignore

@@ -0,0 +1,3 @@
+composer.phar
+composer.lock
+.git

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Maurits van der Schee
+Copyright (c) 2019 Maurits van der Schee
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -71,18 +71,6 @@ These are all the configuration options and their default value between brackets
 - "cacheTime": Number of seconds the cache is valid (`10`)
 - "debug": Show errors in the "X-Debug-Info" header (`false`)
 
-## Compilation
-
-The code resides in the "`src`" directory. You can access it at the URL:
-
-    http://localhost:8080/src/records/posts/1
-
-You can compile all files into a single "`api.php`" file using:
-
-    php build.php
-
-NB: The script appends the classes in alphabetical order (directories first).
-
 ## Limitations
 
 These limitation and constrains apply:
@@ -115,34 +103,32 @@ The following features are supported:
   - Spatial/GIS fields and filters supported with WKT
   - Generate API documentation using OpenAPI tools
   - Authentication via JWT token or username/password
+  - Support for reading database structure in JSON
+  - Support for modifying database structure using REST endpoint
+  - Security enhancing middleware is included
+  - Standard compliant: PSR-2, PSR-4, PSR-7, PSR-15 and PSR-17
+
+## Compilation
+
+You can compile all files into a single "`api.php`" file using:
 
-### Extra Features
+    php build.php
+
+You can access the non-compiled code at the URL:
+
+    http://localhost:8080/src/records/posts/1
 
-These features are new in v2 and were not included in v1:
+The non-compiled code resides in the "`src`" and "`vendor`" directories.
 
-  - Does not reflect on every request (better performance)
-  - Complex filters (with both "and" & "or") are supported
-  - Support for output of database structure in JSON
-  - Support for boolean and binary data in all database engines
-  - Support for relational data on read (not only on list operation)
-  - Support for middleware to modify all operations (also list)
-  - Error reporting in JSON with corresponding HTTP status
-  - Support for basic authentication and via auth provider (JWT)
-  - Support for basic firewall functionality
-  - Prevent database scraping using list limits
+### Updating dependencies
 
-### Dropped features
+You can update all dependencies of this project using the following command:
 
-The following features of v1 were dropped in v2:
+    php update.php
 
-  - ~~Streaming data, low memory footprint~~
-  - ~~Supports file upload from web forms (multipart/form-data)~~
-  - ~~Condensed JSON output: first row contains field names~~
-  - ~~Relation "transforms" (of condensed JSON) for PHP and JavaScript~~
-  - ~~Unstructured data support through JSON/JSONB~~
-  - ~~SQLite support~~
+This script will install and run [Composer](https://getcomposer.org/) to update the required dependencies in the "`vendor`" directory.
 
-NB: You can find v1 here: https://github.com/mevdschee/php-crud-api/tree/v1
+NB: The update script will also patch the dependencies in the vendor directory for PHP 7.0 compatibility.
 
 ## Middleware
 
@@ -782,7 +768,7 @@ You may use the "customization" middleware to modify request and response and im
         $environment->start = microtime(true);
     },
     'customization.afterHandler' => function ($operation, $tableName, $response, $environment) {
-        $response->addHeader('X-Time-Taken', microtime(true) - $environment->start);
+        return $response->withHeader('X-Time-Taken', microtime(true) - $environment->start);
     },
 
 The above example will add a header "X-Time-Taken" with the number of seconds the API call has taken.