Skip to content

Commit c352c18

Browse files
mevdscheemevdschee
committed
rename columns to include
1 parent 865a75a commit c352c18

21 files changed

+48
-114
lines changed

‎api.php

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3428,9 +3428,9 @@ public function jsonSerialize()
34283428
}
34293429
}
34303430

3431-
// file: src/Tqdev/PhpCrudApi/Record/ColumnSelector.php
3431+
// file: src/Tqdev/PhpCrudApi/Record/ColumnIncluder.php
34323432

3433-
class ColumnSelector
3433+
class ColumnIncluder
34343434
{
34353435

34363436
private function isMandatory(String $tableName, String $columnName, array $params): bool
@@ -3473,7 +3473,7 @@ public function getNames(ReflectedTable $table, bool $primaryTable, array $param
34733473
{
34743474
$tableName = $table->getName();
34753475
$results = $table->columnNames();
3476-
$results = $this->select($tableName, $primaryTable, $params, 'columns', $results, true);
3476+
$results = $this->select($tableName, $primaryTable, $params, 'include', $results, true);
34773477
$results = $this->select($tableName, $primaryTable, $params, 'exclude', $results, false);
34783478
return $results;
34793479
}
@@ -3772,7 +3772,7 @@ public function __construct(GenericDB $db, ReflectionService $reflection)
37723772
{
37733773
$this->db = $db;
37743774
$this->tables = $reflection->getDatabase();
3775-
$this->columns = new ColumnSelector();
3775+
$this->columns = new ColumnIncluder();
37763776
$this->joiner = new RelationJoiner($this->columns);
37773777
$this->filters = new FilterInfo();
37783778
$this->ordering = new OrderingInfo();
@@ -3876,14 +3876,14 @@ class RelationJoiner
38763876

38773877
private $columns;
38783878

3879-
public function __construct(ColumnSelector $columns)
3879+
public function __construct(ColumnIncluder $columns)
38803880
{
38813881
$this->columns = $columns;
38823882
}
38833883

3884-
public function addMandatoryColumns(ReflectedTable $table, ReflectedDatabase $tables, array &$params)/*: void*/
3884+
public function addMandatoryColumns(ReflectedTable $table, ReflectedDatabase $tables, array &$params) /*: void*/
38853885
{
3886-
if (!isset($params['join']) || !isset($params['columns'])) {
3886+
if (!isset($params['join']) || !isset($params['include'])) {
38873887
return;
38883888
}
38893889
$params['mandatory'] = array();
@@ -3933,7 +3933,7 @@ private function getJoinsAsPathTree(ReflectedDatabase $tables, array $params): P
39333933
}
39343934

39353935
public function addJoins(ReflectedTable $table, array &$records, ReflectedDatabase $tables, array $params,
3936-
GenericDB $db)/*: void*/{
3936+
GenericDB $db) /*: void*/ {
39373937

39383938
$joins = $this->getJoinsAsPathTree($tables, $params);
39393939
$this->addJoinsForTables($table, $joins, $records, $tables, $params, $db);
@@ -4013,7 +4013,7 @@ private function getFkEmptyValues(ReflectedTable $t1, ReflectedTable $t2, array
40134013
return $fkValues;
40144014
}
40154015

4016-
private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params, GenericDB $db, array &$records)/*: void*/
4016+
private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params, GenericDB $db, array &$records) /*: void*/
40174017
{
40184018
$pk = $t2->getPk();
40194019
$columnNames = $this->columns->getNames($t2, false, $params);
@@ -4024,7 +4024,7 @@ private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params
40244024
}
40254025
}
40264026

4027-
private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkValues)/*: void*/
4027+
private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkValues) /*: void*/
40284028
{
40294029
$pkName = $t2->getPk()->getName();
40304030
foreach ($fkRecords as $fkRecord) {
@@ -4033,7 +4033,7 @@ private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkVa
40334033
}
40344034
}
40354035

4036-
private function setFkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $fkValues)/*: void*/
4036+
private function setFkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $fkValues) /*: void*/
40374037
{
40384038
$fks = $t1->getFksTo($t2->getName());
40394039
foreach ($fks as $fk) {
@@ -4058,7 +4058,7 @@ private function getPkEmptyValues(ReflectedTable $t1, array $records): array
40584058
return $pkValues;
40594059
}
40604060

4061-
private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkValues, array $params, GenericDB $db, array &$records)/*: void*/
4061+
private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkValues, array $params, GenericDB $db, array &$records) /*: void*/
40624062
{
40634063
$fks = $t2->getFksTo($t1->getName());
40644064
$columnNames = $this->columns->getNames($t2, false, $params);
@@ -4073,7 +4073,7 @@ private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkV
40734073
}
40744074
}
40754075

4076-
private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkRecords, array &$pkValues)/*: void*/
4076+
private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkRecords, array &$pkValues) /*: void*/
40774077
{
40784078
$fks = $t2->getFksTo($t1->getName());
40794079
foreach ($fks as $fk) {
@@ -4087,7 +4087,7 @@ private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkR
40874087
}
40884088
}
40894089

4090-
private function setPkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $pkValues)/*: void*/
4090+
private function setPkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $pkValues) /*: void*/
40914091
{
40924092
$pkName = $t1->getPk()->getName();
40934093
$t2Name = $t2->getName();
@@ -4125,7 +4125,7 @@ private function getHabtmEmptyValues(ReflectedTable $t1, ReflectedTable $t2, Ref
41254125
return new HabtmValues($pkValues, $fkValues);
41264126
}
41274127

4128-
private function setHabtmValues(ReflectedTable $t1, ReflectedTable $t3, array &$records, HabtmValues $habtmValues)/*: void*/
4128+
private function setHabtmValues(ReflectedTable $t1, ReflectedTable $t3, array &$records, HabtmValues $habtmValues) /*: void*/
41294129
{
41304130
$pkName = $t1->getPk()->getName();
41314131
$t3Name = $t3->getName();

‎src/Tqdev/PhpCrudApi/Record/ColumnSelector.php

Lines changed: 0 additions & 66 deletions
This file was deleted.

‎src/Tqdev/PhpCrudApi/Record/RecordService.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public function __construct(GenericDB $db, ReflectionService $reflection)
1919
{
2020
$this->db = $db;
2121
$this->tables = $reflection->getDatabase();
22-
$this->columns = new ColumnSelector();
22+
$this->columns = new ColumnIncluder();
2323
$this->joiner = new RelationJoiner($this->columns);
2424
$this->filters = new FilterInfo();
2525
$this->ordering = new OrderingInfo();

‎src/Tqdev/PhpCrudApi/Record/RelationJoiner.php

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
<?php
22
namespace Tqdev\PhpCrudApi\Record;
33

4+
use Tqdev\PhpCrudApi\Column\Reflection\ReflectedDatabase;
5+
use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
46
use Tqdev\PhpCrudApi\Database\GenericDB;
57
use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
68
use Tqdev\PhpCrudApi\Record\Condition\OrCondition;
7-
use Tqdev\PhpCrudApi\Column\Reflection\ReflectedDatabase;
8-
use Tqdev\PhpCrudApi\Column\Reflection\ReflectedTable;
99

1010
class RelationJoiner
1111
{
1212

1313
private $columns;
1414

15-
public function __construct(ColumnSelector $columns)
15+
public function __construct(ColumnIncluder $columns)
1616
{
1717
$this->columns = $columns;
1818
}
1919

20-
public function addMandatoryColumns(ReflectedTable $table, ReflectedDatabase $tables, array &$params)/*: void*/
20+
public function addMandatoryColumns(ReflectedTable $table, ReflectedDatabase $tables, array &$params) /*: void*/
2121
{
22-
if (!isset($params['join']) || !isset($params['columns'])) {
22+
if (!isset($params['join']) || !isset($params['include'])) {
2323
return;
2424
}
2525
$params['mandatory'] = array();
@@ -69,7 +69,7 @@ private function getJoinsAsPathTree(ReflectedDatabase $tables, array $params): P
6969
}
7070

7171
public function addJoins(ReflectedTable $table, array &$records, ReflectedDatabase $tables, array $params,
72-
GenericDB $db)/*: void*/{
72+
GenericDB $db) /*: void*/ {
7373

7474
$joins = $this->getJoinsAsPathTree($tables, $params);
7575
$this->addJoinsForTables($table, $joins, $records, $tables, $params, $db);
@@ -149,7 +149,7 @@ private function getFkEmptyValues(ReflectedTable $t1, ReflectedTable $t2, array
149149
return $fkValues;
150150
}
151151

152-
private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params, GenericDB $db, array &$records)/*: void*/
152+
private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params, GenericDB $db, array &$records) /*: void*/
153153
{
154154
$pk = $t2->getPk();
155155
$columnNames = $this->columns->getNames($t2, false, $params);
@@ -160,7 +160,7 @@ private function addFkRecords(ReflectedTable $t2, array $fkValues, array $params
160160
}
161161
}
162162

163-
private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkValues)/*: void*/
163+
private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkValues) /*: void*/
164164
{
165165
$pkName = $t2->getPk()->getName();
166166
foreach ($fkRecords as $fkRecord) {
@@ -169,7 +169,7 @@ private function fillFkValues(ReflectedTable $t2, array $fkRecords, array &$fkVa
169169
}
170170
}
171171

172-
private function setFkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $fkValues)/*: void*/
172+
private function setFkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $fkValues) /*: void*/
173173
{
174174
$fks = $t1->getFksTo($t2->getName());
175175
foreach ($fks as $fk) {
@@ -194,7 +194,7 @@ private function getPkEmptyValues(ReflectedTable $t1, array $records): array
194194
return $pkValues;
195195
}
196196

197-
private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkValues, array $params, GenericDB $db, array &$records)/*: void*/
197+
private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkValues, array $params, GenericDB $db, array &$records) /*: void*/
198198
{
199199
$fks = $t2->getFksTo($t1->getName());
200200
$columnNames = $this->columns->getNames($t2, false, $params);
@@ -209,7 +209,7 @@ private function addPkRecords(ReflectedTable $t1, ReflectedTable $t2, array $pkV
209209
}
210210
}
211211

212-
private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkRecords, array &$pkValues)/*: void*/
212+
private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkRecords, array &$pkValues) /*: void*/
213213
{
214214
$fks = $t2->getFksTo($t1->getName());
215215
foreach ($fks as $fk) {
@@ -223,7 +223,7 @@ private function fillPkValues(ReflectedTable $t1, ReflectedTable $t2, array $pkR
223223
}
224224
}
225225

226-
private function setPkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $pkValues)/*: void*/
226+
private function setPkValues(ReflectedTable $t1, ReflectedTable $t2, array &$records, array $pkValues) /*: void*/
227227
{
228228
$pkName = $t1->getPk()->getName();
229229
$t2Name = $t2->getName();
@@ -261,7 +261,7 @@ private function getHabtmEmptyValues(ReflectedTable $t1, ReflectedTable $t2, Ref
261261
return new HabtmValues($pkValues, $fkValues);
262262
}
263263

264-
private function setHabtmValues(ReflectedTable $t1, ReflectedTable $t3, array &$records, HabtmValues $habtmValues)/*: void*/
264+
private function setHabtmValues(ReflectedTable $t1, ReflectedTable $t3, array &$records, HabtmValues $habtmValues) /*: void*/
265265
{
266266
$pkName = $t1->getPk()->getName();
267267
$t3Name = $t3->getName();

‎tests/functional/001_records/002_list_post_columns.log

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
GET /records/posts?columns=id,content
1+
GET /records/posts?include=id,content
22
===
33
200
44
Content-Type: application/json

‎tests/functional/001_records/005_read_post_columns.log

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
GET /records/posts/2?columns=id,content
1+
GET /records/posts/2?include=id,content
22
===
33
200
44
Content-Type: application/json

‎tests/functional/001_records/008_edit_post_columns_missing_field.log

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
PUT /records/posts/3?columns=id,content
1+
PUT /records/posts/3?include=id,content
22

33
{"content":"test (edited 2)"}
44
===

‎tests/functional/001_records/009_edit_post_columns_extra_field.log

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
PUT /records/posts/3?columns=id,content
1+
PUT /records/posts/3?include=id,content
22

33
{"user_id":2,"content":"test (edited 3)"}
44
===

‎tests/functional/001_records/015_delete_post_ignore_columns.log

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
DELETE /records/posts/4?columns=id,content
1+
DELETE /records/posts/4?include=id,content
22
===
33
200
44
Content-Type: application/json

‎tests/functional/001_records/033_list_example_from_readme_tag_name_only.log

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
GET /records/posts?columns=tags.name&join=categories&join=post_tags,tags&join=comments&filter=id,eq,1
1+
GET /records/posts?include=tags.name&join=categories&join=post_tags,tags&join=comments&filter=id,eq,1
22
===
33
200
44
Content-Type: application/json

0 commit comments

Comments
 (0)