1st attempt at adding exclude (issue #136). If both include and exclude are used, include happens first, then the exclude. The exclude list is either {columns/fields} or {table}.{columns/fields} in format. If the {columns/fields} format is used, it will only be applicable to responses with a single table. If relations are pulled in, be aware that excluding a specified table/field/column could have unintended consequences to the response.

Author: jr3cermak

api.php

@@ -1527,6 +1527,28 @@ protected function addRelationColumns($columns,$select) {
 		return $columns;
 	}
 
+	protected function excludeFields($fields,$exclude) {
+		if ($fields) {
+			$columns = explode(',',$exclude);
+			foreach($columns as $column) {
+				$table = "";
+				if (strpos($column,'.')) {
+					$key = explode('.',$column);
+					$table = $key[0];
+					$column = $key[1];
+				} else {
+					if (count($fields)==1) {
+						$table = array_keys($fields)[0];
+					}
+				}
+				if (array_key_exists($table,$fields) and array_key_exists($column,$fields[$table])) {
+					unset($fields[$table][$column]);
+				}
+			}
+		}
+		return $fields;
+	}
+
 	protected function findFields($tables,$columns,$database) {
 		$fields = array();
 		foreach ($tables as $i=>$table) {
@@ -1609,6 +1631,7 @@ protected function getParameters($settings) {
 		$table     = $this->parseRequestParameter($request, 'a-zA-Z0-9\-_');
 		$key       = $this->parseRequestParameter($request, 'a-zA-Z0-9\-_,'); // auto-increment or uuid
 		$action    = $this->mapMethodToAction($method,$key);
+		$exclude   = $this->parseGetParameter($get, 'exclude', 'a-zA-Z0-9\-_,.');
 		$include   = $this->parseGetParameter($get, 'include', 'a-zA-Z0-9\-_,');
 		$page      = $this->parseGetParameter($get, 'page', '0-9,');
 		$filters   = $this->parseGetParameterArray($get, 'filter', false);
@@ -1628,6 +1651,7 @@ protected function getParameters($settings) {
 		list($tables,$collect,$select) = $this->findRelations($tables,$database,$auto_include);
 		$columns = $this->addRelationColumns($columns,$select);
 		$fields = $this->findFields($tables,$columns,$database);
+		if (isset($exclude)) $fields = $this->excludeFields($fields,$exclude);
 
 		// permissions
 		if ($table_authorizer) $this->applyTableAuthorizer($table_authorizer,$action,$database,$tables);
@@ -2084,6 +2108,13 @@ protected function swagger($settings) {
 					if ($action['name']=='list') {
 						echo '"parameters":[';
 						echo '{';
+						echo '"name":"exclude",';
+						echo '"in":"query",';
+						echo '"description":"One or more related entities (comma separated).",';
+						echo '"required":false,';
+						echo '"type":"string"';
+						echo '},';
+						echo '{';
 						echo '"name":"include",';
 						echo '"in":"query",';
 						echo '"description":"One or more related entities (comma separated).",';

tests/tests.php

@@ -357,6 +357,20 @@ public function testListWithPaginateLastPage()
 		$test->expect('{"posts":{"columns":["id","user_id","category_id","content"],"records":[[14,1,1,"#10"]],"results":11}}');
 	}
 
+	public function testListExampleFromReadmeFullRecord()
+	{
+		$test = new API($this);
+		$test->get('/posts?filter=id,eq,1');
+		$test->expect('{"posts":{"columns":["id","user_id","category_id","content"],"records":[[1,1,1,"blog started"]]}}');
+	}
+
+	public function testListExampleFromReadmeWithExclude()
+	{
+		$test = new API($this);
+		$test->get('/posts?exclude=id&filter=id,eq,1');
+		$test->expect('"posts":{"columns":["user_id","category_id","content"],"records":[[1,1,"blog started"]]}}');
+	}
+
 	public function testListExampleFromReadme()
 	{
 		$test = new API($this);
@@ -371,6 +385,13 @@ public function testListExampleFromReadmeWithTransform()
 		$test->expect('{"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":"announcement","icon":null}],"content":"blog started"}]}');
 	}
 
+	public function testListExampleFromReadmeWithTransformWithExclude()
+	{
+		$test = new API($this);
+		$test->get('/posts?include=categories,tags,comments&exclude=comments.message&filter=id,eq,1&transform=1');
+		$test->expect('{"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":"announcement","icon":null}],"content":"blog started"}]}');
+	}
+
 	public function testEditCategoryWithBinaryContent()
 	{
 		$binary = base64_encode("\0abc\0\n\r\b\0");