add config to enable the relation cleanup

Author: Cyril Wanner

.gitignore

@@ -2,4 +2,5 @@
 composer.phar
 composer.lock
 .DS_Store
-.phpintel
+.phpintel
+.idea

config/apihandler.php

@@ -50,6 +50,24 @@
 
     'fulltext_score_column' => '_score',
 
+    /*
+    |--------------------------------------------------------------------------
+    | Cleanup Relations in the Response
+    |--------------------------------------------------------------------------
+    |
+    | By default, the API Handler returns all loaded relations of the models,
+    | even if they are not in the '_with' param or explicitly loaded with
+    | $builder->with(). These unexpected relations can come from custom
+    | accessor methods or when you access a relation in your code in general.
+    |
+    | If you want these to get removed from the response, set this value
+    | to true so only the ones in the '_with' param or explicitly added with
+    | $builder->with('relation') get returned.
+    |
+     */
+
+    'cleanup_relations' => false,
+
     /*
     |--------------------------------------------------------------------------
     | Errors

src/Result.php

@@ -3,6 +3,7 @@
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Response;
+use \Illuminate\Support\Facades\Config;
 
 class Result
 {
@@ -56,9 +57,17 @@ public function getResponse()
     public function getResult()
     {
         if ($this->parser->multiple) {
-            $result = $this->cleanupRelationsOnModels($this->parser->builder->get());
+            $result = $this->parser->builder->get();
+
+            if (Config::get('apihandler.cleanup_relations', false)) {
+                $result = $this->cleanupRelationsOnModels($result);
+            }
         } else {
-            $result = $this->cleanupRelations($this->parser->builder->first());
+            $result = $this->parser->builder->first();
+
+            if (Config::get('apihandler.cleanup_relations', false)) {
+                $result = $this->cleanupRelations($result);
+            }
         }
 
         return $result;