Merge branch 'master' of github.com:mevdschee/php-crud-api

Author: mevdschee

README.md

@@ -40,6 +40,7 @@ This is a single file application! Upload "api.php" somewhere and enjoy!
 ## Limitations
 
   - Primary keys should either be auto-increment (from 1 to 2^53) or UUID
+  - Column names must be strictly alphanumeric, hyphens/underscores are allowed
   - Composite primary or foreign keys are not supported
   - Complex filters (with both "and" & "or") are not supported
   - Complex writes (transactions) are not supported
@@ -180,7 +181,7 @@ Search is implemented with the "filter" parameter. You need to specify the colum
   - ge: greater or equal (number is higher than or equal to value)
   - gt: greater than (number is higher than value)
   - bt: between (number is between two comma separated values)
-  - in: in (number is in comma separated list of values)
+  - in: in (number or string is in comma separated list of values)
   - is: is null (field contains "NULL" value)
 
 You can negate all filters by prepending a 'n' character, so that 'eq' becomes 'neq'.
@@ -604,7 +605,7 @@ You can call the ```php_crud_api_transform()``` function to structure the data h
 }
 ```
 
-This transform function is available for PHP and JavaScript in the files ```php_crud_api_transform.php``` and ```php_crud_api_transform.js``` in the "lib" folder.
+This transform function is available for PHP, JavaScript and Python in the files ```php_crud_api_transform.php```, ```php_crud_api_transform.js``` and ```php_crud_api_transform.py``` in the "lib" folder.
 
 ## Permissions
 

lib/php_crud_api_transform.py

@@ -0,0 +1,35 @@
+def php_crud_api_transform(tables):
+
+    def get_objects(tables, table_name, where_index=None, match_value=None):
+        objects = []
+        for record in tables[table_name]['records']:
+            if where_index == None or (record[where_index] == match_value):
+                object = {}
+                columns = tables[table_name]['columns']
+                for column in columns:
+                    index = columns.index(column)
+                    object[column] = record[index]
+                    for relation, reltable in tables.items():
+                        for key, target in reltable.get('relations', {}).items():
+                            if target == table_name + '.' + column:
+                                relcols = reltable['columns']
+                                column_indices = {value: relcols.index(value) for value in relcols}
+                                object[relation] = get_objects(
+                                    tables, relation, column_indices[key], record[index])
+                objects.append(object)
+        return objects
+
+    tree = {}
+    for name, table in tables.items():
+        if not 'relations' in table:
+            tree[name] = get_objects(tables, name)
+            if 'results' in table:
+                tree['_results'] = table['results']
+    return tree
+
+
+if __name__ == "__main__":
+    input = {"posts": {"columns": ["id","user_id","category_id","content"],"records": [[1,1,1,"blogstarted"]]},"post_tags": {"relations": {"post_id": "posts.id"},"columns": ["id","post_id","tag_id"],"records": [[1,1,1],[2,1,2]]},"categories": {"relations": {"id": "posts.category_id"},"columns": ["id","name"],"records": [[1,"anouncement"]]},"tags": {"relations": {"id": "post_tags.tag_id"},"columns": ["id","name"],"records": [[1,"funny"],[2,"important"]]},"comments": {"relations": {"post_id": "posts.id"},"columns": ["id","post_id","message"],"records": [[1,1,"great"],[2,1,"fantastic"]]}}
+    output = {"posts": [{"id": 1,"post_tags": [{"id": 1,"post_id": 1,"tag_id": 1,"tags": [{"id": 1,"name": "funny"}]},{"id": 2,"post_id": 1,"tag_id": 2,"tags": [{"id": 2,"name": "important"}]}],"comments": [{"id": 1,"post_id": 1,"message": "great"},{"id": 2,"post_id": 1,"message": "fantastic"}],"user_id": 1,"category_id": 1,"categories": [{"id": 1,"name": "anouncement"}],"content": "blogstarted"}]}
+
+    print(php_crud_api_transform(input)  == output)

tests/Tests.php

@@ -391,6 +391,13 @@ public function testFilterPostsNotIn()
         $test->expect('{"posts":[{"id":5,"user_id":1,"category_id":1,"content":"#1"},{"id":6,"user_id":1,"category_id":1,"content":"#2"}]}');
     }
 
+    public function testFilterCommentsStringIn()
+    {
+        $test = new Api($this);
+        $test->get('/comments?filter=message,in,fantastic,thank you&transform=1');
+        $test->expect('{"comments":[{"id":2,"post_id":1,"message":"fantastic"},{"id":3,"post_id":2,"message":"thank you"}]}');
+    }
+
     public function testFilterPostsBetween()
     {
         $test = new Api($this);