rename columns to include

api.php

@@ -3428,9 +3428,9 @@ class ListDocument implements \JsonSerializable
     }
 }
 
-// file: src/Tqdev/PhpCrudApi/Record/ColumnSelector.php
+// file: src/Tqdev/PhpCrudApi/Record/ColumnIncluder.php
 
-class ColumnSelector
+class ColumnIncluder
 {
 
     private function isMandatory(String $tableName, String $columnName, array $params): bool
@@ -3473,7 +3473,7 @@ class ColumnSelector
     {
         $tableName = $table->getName();
         $results = $table->columnNames();
-        $results = $this->select($tableName, $primaryTable, $params, 'columns', $results, true);
+        $results = $this->select($tableName, $primaryTable, $params, 'include', $results, true);
         $results = $this->select($tableName, $primaryTable, $params, 'exclude', $results, false);
         return $results;
     }
@@ -3772,7 +3772,7 @@ class RecordService
     {
         $this->db = $db;
         $this->tables = $reflection->getDatabase();
-        $this->columns = new ColumnSelector();
+        $this->columns = new ColumnIncluder();
         $this->joiner = new RelationJoiner($this->columns);
         $this->filters = new FilterInfo();
         $this->ordering = new OrderingInfo();
@@ -3876,14 +3876,14 @@ class RelationJoiner
 
     private $columns;
 
-    public function __construct(ColumnSelector $columns)
+    public function __construct(ColumnIncluder $columns)
     {
         $this->columns = $columns;
     }
 
-    public function addMandatoryColumns(ReflectedTable $table, ReflectedDatabase $tables, array &$params)/*: void*/
+    public function addMandatoryColumns(ReflectedTable $table, ReflectedDatabase $tables, array &$params) /*: void*/
     {
-        if (!isset($params['join']) || !isset($params['columns'])) {
+        if (!isset($params['join']) || !isset($params['include'])) {
             return;
         }
         $params['mandatory'] = array();
@@ -3933,7 +3933,7 @@ class RelationJoiner
     }
 
     public function addJoins(ReflectedTable $table, array &$records, ReflectedDatabase $tables, array $params,
-        GenericDB $db)/*: void*/{
+        GenericDB $db) /*: void*/ {
 
         $joins = $this->getJoinsAsPathTree($tables, $params);
         $this->addJoinsForTables($table, $joins, $records, $tables, $params, $db);
@@ -4013,7 +4013,7 @@ class RelationJoiner
         return $fkValues;
     }
 
-    private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params, GenericDB $db, array &$records)/*: void*/
+    private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params, GenericDB $db, array &$records) /*: void*/
     {
         $pk = $t2->getPk();
         $columnNames = $this->columns->getNames($t2, false, $params);
@@ -4024,7 +4024,7 @@ class RelationJoiner
         }
     }
 
-    private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkValues)/*: void*/
+    private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkValues) /*: void*/
     {
         $pkName = $t2->getPk()->getName();
         foreach ($fkRecords as $fkRecord) {
@@ -4033,7 +4033,7 @@ class RelationJoiner
         }
     }
 
-    private function setFkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $fkValues)/*: void*/
+    private function setFkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $fkValues) /*: void*/
     {
         $fks = $t1->getFksTo($t2->getName());
         foreach ($fks as $fk) {
@@ -4058,7 +4058,7 @@ class RelationJoiner
         return $pkValues;
     }
 
-    private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkValues, array $params, GenericDB $db, array &$records)/*: void*/
+    private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkValues, array $params, GenericDB $db, array &$records) /*: void*/
     {
         $fks = $t2->getFksTo($t1->getName());
         $columnNames = $this->columns->getNames($t2, false, $params);
@@ -4073,7 +4073,7 @@ class RelationJoiner
         }
     }
 
-    private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkRecords, array &$pkValues)/*: void*/
+    private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkRecords, array &$pkValues) /*: void*/
     {
         $fks = $t2->getFksTo($t1->getName());
         foreach ($fks as $fk) {
@@ -4087,7 +4087,7 @@ class RelationJoiner
         }
     }
 
-    private function setPkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $pkValues)/*: void*/
+    private function setPkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $pkValues) /*: void*/
     {
         $pkName = $t1->getPk()->getName();
         $t2Name = $t2->getName();
@@ -4125,7 +4125,7 @@ class RelationJoiner
         return new HabtmValues($pkValues, $fkValues);
     }
 
-    private function setHabtmValues(ReflectedTable $t1, ReflectedTable $t3, array &$records, HabtmValues $habtmValues)/*: void*/
+    private function setHabtmValues(ReflectedTable $t1, ReflectedTable $t3, array &$records, HabtmValues $habtmValues) /*: void*/
     {
         $pkName = $t1->getPk()->getName();
         $t3Name = $t3->getName();

src/Tqdev/PhpCrudApi/Record/ColumnSelector.php

@@ -1,66 +0,0 @@
-<?php
-namespace Tqdev\PhpCrudApi\Record;
-
-use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
-
-class ColumnSelector
-{
-
-    private function isMandatory(String $tableName, String $columnName, array $params): bool
-    {
-        return isset($params['mandatory']) && in_array($tableName . "." . $columnName, $params['mandatory']);
-    }
-
-    private function select(String $tableName, bool $primaryTable, array $params, String $paramName,
-        array $columnNames, bool $include): array{
-        if (!isset($params[$paramName])) {
-            return $columnNames;
-        }
-        $columns = array();
-        foreach (explode(',', $params[$paramName][0]) as $columnName) {
-            $columns[$columnName] = true;
-        }
-        $result = array();
-        foreach ($columnNames as $columnName) {
-            $match = isset($columns['*.*']);
-            if (!$match) {
-                $match = isset($columns[$tableName . '.*']) || isset($columns[$tableName . '.' . $columnName]);
-            }
-            if ($primaryTable && !$match) {
-                $match = isset($columns['*']) || isset($columns[$columnName]);
-            }
-            if ($match) {
-                if ($include || $this->isMandatory($tableName, $columnName, $params)) {
-                    $result[] = $columnName;
-                }
-            } else {
-                if (!$include || $this->isMandatory($tableName, $columnName, $params)) {
-                    $result[] = $columnName;
-                }
-            }
-        }
-        return $result;
-    }
-
-    public function getNames(ReflectedTable $table, bool $primaryTable, array $params): array
-    {
-        $tableName = $table->getName();
-        $results = $table->columnNames();
-        $results = $this->select($tableName, $primaryTable, $params, 'columns', $results, true);
-        $results = $this->select($tableName, $primaryTable, $params, 'exclude', $results, false);
-        return $results;
-    }
-
-    public function getValues(ReflectedTable $table, bool $primaryTable, /* object */ $record, array $params): array
-    {
-        $results = array();
-        $columnNames = $this->getNames($table, $primaryTable, $params);
-        foreach ($columnNames as $columnName) {
-            if (property_exists($record, $columnName)) {
-                $results[$columnName] = $record->$columnName;
-            }
-        }
-        return $results;
-    }
-
-}

src/Tqdev/PhpCrudApi/Record/RecordService.php

@@ -19,7 +19,7 @@ class RecordService
     {
         $this->db = $db;
         $this->tables = $reflection->getDatabase();
-        $this->columns = new ColumnSelector();
+        $this->columns = new ColumnIncluder();
         $this->joiner = new RelationJoiner($this->columns);
         $this->filters = new FilterInfo();
         $this->ordering = new OrderingInfo();

src/Tqdev/PhpCrudApi/Record/RelationJoiner.php

@@ -1,25 +1,25 @@
 <?php
 namespace Tqdev\PhpCrudApi\Record;
 
+use Tqdev\PhpCrudApi\Column\Reflection\ReflectedDatabase;
+use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
 use Tqdev\PhpCrudApi\Database\GenericDB;
 use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
 use Tqdev\PhpCrudApi\Record\Condition\OrCondition;
-use Tqdev\PhpCrudApi\Column\Reflection\ReflectedDatabase;
-use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
 
 class RelationJoiner
 {
 
     private $columns;
 
-    public function __construct(ColumnSelector $columns)
+    public function __construct(ColumnIncluder $columns)
     {
         $this->columns = $columns;
     }
 
-    public function addMandatoryColumns(ReflectedTable $table, ReflectedDatabase $tables, array &$params)/*: void*/
+    public function addMandatoryColumns(ReflectedTable $table, ReflectedDatabase $tables, array &$params) /*: void*/
     {
-        if (!isset($params['join']) || !isset($params['columns'])) {
+        if (!isset($params['join']) || !isset($params['include'])) {
             return;
         }
         $params['mandatory'] = array();
@@ -69,7 +69,7 @@ class RelationJoiner
     }
 
     public function addJoins(ReflectedTable $table, array &$records, ReflectedDatabase $tables, array $params,
-        GenericDB $db)/*: void*/{
+        GenericDB $db) /*: void*/ {
 
         $joins = $this->getJoinsAsPathTree($tables, $params);
         $this->addJoinsForTables($table, $joins, $records, $tables, $params, $db);
@@ -149,7 +149,7 @@ class RelationJoiner
         return $fkValues;
     }
 
-    private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params, GenericDB $db, array &$records)/*: void*/
+    private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params, GenericDB $db, array &$records) /*: void*/
     {
         $pk = $t2->getPk();
         $columnNames = $this->columns->getNames($t2, false, $params);
@@ -160,7 +160,7 @@ class RelationJoiner
         }
     }
 
-    private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkValues)/*: void*/
+    private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkValues) /*: void*/
     {
         $pkName = $t2->getPk()->getName();
         foreach ($fkRecords as $fkRecord) {
@@ -169,7 +169,7 @@ class RelationJoiner
         }
     }
 
-    private function setFkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $fkValues)/*: void*/
+    private function setFkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $fkValues) /*: void*/
     {
         $fks = $t1->getFksTo($t2->getName());
         foreach ($fks as $fk) {
@@ -194,7 +194,7 @@ class RelationJoiner
         return $pkValues;
     }
 
-    private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkValues, array $params, GenericDB $db, array &$records)/*: void*/
+    private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkValues, array $params, GenericDB $db, array &$records) /*: void*/
     {
         $fks = $t2->getFksTo($t1->getName());
         $columnNames = $this->columns->getNames($t2, false, $params);
@@ -209,7 +209,7 @@ class RelationJoiner
         }
     }
 
-    private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkRecords, array &$pkValues)/*: void*/
+    private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkRecords, array &$pkValues) /*: void*/
     {
         $fks = $t2->getFksTo($t1->getName());
         foreach ($fks as $fk) {
@@ -223,7 +223,7 @@ class RelationJoiner
         }
     }
 
-    private function setPkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $pkValues)/*: void*/
+    private function setPkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $pkValues) /*: void*/
     {
         $pkName = $t1->getPk()->getName();
         $t2Name = $t2->getName();
@@ -261,7 +261,7 @@ class RelationJoiner
         return new HabtmValues($pkValues, $fkValues);
     }
 
-    private function setHabtmValues(ReflectedTable $t1, ReflectedTable $t3, array &$records, HabtmValues $habtmValues)/*: void*/
+    private function setHabtmValues(ReflectedTable $t1, ReflectedTable $t3, array &$records, HabtmValues $habtmValues) /*: void*/
     {
         $pkName = $t1->getPk()->getName();
         $t3Name = $t3->getName();

tests/functional/001_records/002_list_post_columns.log

@@ -1,4 +1,4 @@
-GET /records/posts?columns=id,content
+GET /records/posts?include=id,content
 ===
 200
 Content-Type: application/json

tests/functional/001_records/005_read_post_columns.log

@@ -1,4 +1,4 @@
-GET /records/posts/2?columns=id,content
+GET /records/posts/2?include=id,content
 ===
 200
 Content-Type: application/json

tests/functional/001_records/008_edit_post_columns_missing_field.log

@@ -1,4 +1,4 @@
-PUT /records/posts/3?columns=id,content
+PUT /records/posts/3?include=id,content
 
 {"content":"test (edited 2)"}
 ===

tests/functional/001_records/009_edit_post_columns_extra_field.log

@@ -1,4 +1,4 @@
-PUT /records/posts/3?columns=id,content
+PUT /records/posts/3?include=id,content
 
 {"user_id":2,"content":"test (edited 3)"}
 ===

tests/functional/001_records/015_delete_post_ignore_columns.log

@@ -1,4 +1,4 @@
-DELETE /records/posts/4?columns=id,content
+DELETE /records/posts/4?include=id,content
 ===
 200
 Content-Type: application/json

tests/functional/001_records/033_list_example_from_readme_tag_name_only.log

@@ -1,4 +1,4 @@
-GET /records/posts?columns=tags.name&join=categories&join=post_tags,tags&join=comments&filter=id,eq,1
+GET /records/posts?include=tags.name&join=categories&join=post_tags,tags&join=comments&filter=id,eq,1
 ===
 200
 Content-Type: application/json

tests/functional/001_records/041_cors_pre_flight.log

@@ -1,4 +1,4 @@
-OPTIONS /records/posts/1?columns=id
+OPTIONS /records/posts/1?include=id
 Origin: http://example.com
 Access-Control-Request-Method: POST
 Access-Control-Request-Headers: X-XSRF-TOKEN, X-Requested-With

tests/functional/001_records/042_cors_headers.log

@@ -1,4 +1,4 @@
-GET /records/posts/1?columns=id
+GET /records/posts/1?include=id
 Origin: http://example.com
 ===
 200

tests/functional/001_records/052_edit_user_location.log

@@ -8,7 +8,7 @@ Content-Length: 1
 
 1
 ===
-GET /records/users/1?columns=id,location
+GET /records/users/1?include=id,location
 ===
 200
 Content-Type: application/json

tests/functional/001_records/053_list_user_locations.log

@@ -1,4 +1,4 @@
-GET /records/users?columns=id,location
+GET /records/users?include=id,location
 ===
 200
 Content-Type: application/json

tests/functional/001_records/054_edit_user_with_id.log

@@ -8,7 +8,7 @@ Content-Length: 1
 
 1
 ===
-GET /records/users/1?columns=id,username,password
+GET /records/users/1?include=id,username,password
 ===
 200
 Content-Type: application/json

tests/functional/001_records/057_filter_on_and.log

@@ -1,4 +1,4 @@
-GET /records/posts?columns=id&filter=id,ge,1&filter=id,le,2
+GET /records/posts?include=id&filter=id,ge,1&filter=id,le,2
 ===
 200
 Content-Type: application/json

tests/functional/001_records/058_filter_on_or.log

@@ -1,4 +1,4 @@
-GET /records/posts?columns=id&filter1=id,eq,1&filter2=id,eq,2
+GET /records/posts?include=id&filter1=id,eq,1&filter2=id,eq,2
 ===
 200
 Content-Type: application/json

tests/functional/001_records/059_filter_on_and_plus_or.log

@@ -1,4 +1,4 @@
-GET /records/posts?columns=id&filter1=id,eq,1&filter2=id,gt,1&filter2=id,lt,3
+GET /records/posts?include=id&filter1=id,eq,1&filter2=id,gt,1&filter2=id,lt,3
 ===
 200
 Content-Type: application/json

tests/functional/001_records/060_filter_on_or_plus_and.log

@@ -1,4 +1,4 @@
-GET /records/posts?columns=id&filter1=id,eq,1&filter2=id,eq,2&filter=user_id,eq,1
+GET /records/posts?include=id&filter1=id,eq,1&filter2=id,eq,2&filter=user_id,eq,1
 ===
 200
 Content-Type: application/json

tests/functional/001_records/061_get_post_content_with_included_tag_names.log

@@ -1,4 +1,4 @@
-GET /records/posts/1?columns=content,tags.name&join=tags
+GET /records/posts/1?include=content,tags.name&join=tags
 ===
 200
 Content-Type: application/json

tests/functional/001_records/069_increment_event_visitors.log

@@ -1,4 +1,4 @@
-GET /records/events/1?columns=visitors
+GET /records/events/1?include=visitors
 ===
 200
 Content-Type: application/json
@@ -36,7 +36,7 @@ Content-Length: 5
 
 [1,1]
 ===
-GET /records/events/1?columns=visitors
+GET /records/events/1?include=visitors
 ===
 200
 Content-Type: application/json
@@ -54,7 +54,7 @@ Content-Length: 1
 
 1
 ===
-GET /records/events/1?columns=visitors
+GET /records/events/1?include=visitors
 ===
 200
 Content-Type: application/json