Logic inversion (#35)

samatcd · phpsa · commit f15462ad7e27 · 2019-12-17T09:14:06.000+13:00
* Develop (#33) * Added Created, Updated and Deleted events, Moved request to each method to allow overloading: * Apply fixes from StyleCI * Scrutinizer updates * Update controller.stub * Feature/requests mapping (#13) * Event accepts request object and any type of request can now be pushed through * Apply fixes from StyleCI (#12) * Request should have a constructor for instances with models * Update BaseRepository.php * Apply fixes from StyleCI (#15) * Fixed namespace type declaration * Fixed namespace type declaration * Fixed namespace type declaration * Feature/requests mapping (#17) * Event accepts request object and any type of request can now be pushed through * Apply fixes from StyleCI (#12) * Request should have a constructor for instances with models * Update BaseRepository.php * Apply fixes from StyleCI (#18) * Feature/policy collections update (#19) * Develop (#14) * Added Created, Updated and Deleted events, Moved request to each method to allow overloading: * Apply fixes from StyleCI * Scrutinizer updates * Update controller.stub * Feature/requests mapping (#13) * Event accepts request object and any type of request can now be pushed through * Apply fixes from StyleCI (#12) * Request should have a constructor for instances with models * Update BaseRepository.php * Apply fixes from StyleCI (#15) * Fixed namespace type declaration * Fixed namespace type declaration * Fixed namespace type declaration * Develop To Master (#16) * Added Created, Updated and Deleted events, Moved request to each method to allow overloading: * Apply fixes from StyleCI * Scrutinizer updates * Update controller.stub * Feature/requests mapping (#13) * Event accepts request object and any type of request can now be pushed through * Apply fixes from StyleCI (#12) * Request should have a constructor for instances with models * Update BaseRepository.php * Apply fixes from StyleCI (#15) * Fixed namespace type declaration * Fixed namespace type declaration * Fixed namespace type declaration * Added resource collections and policy check. * Updated Readme * Formatting * Apply fixes from StyleCI (#20) * Scrutinizer fixes - deprecation / namesapce * Feature/policy collections update (#22) * Develop (#14) * Added Created, Updated and Deleted events, Moved request to each method to allow overloading: * Apply fixes from StyleCI * Scrutinizer updates * Update controller.stub * Feature/requests mapping (#13) * Event accepts request object and any type of request can now be pushed through * Apply fixes from StyleCI (#12) * Request should have a constructor for instances with models * Update BaseRepository.php * Apply fixes from StyleCI (#15) * Fixed namespace type declaration * Fixed namespace type declaration * Fixed namespace type declaration * Develop To Master (#16) * Added Created, Updated and Deleted events, Moved request to each method to allow overloading: * Apply fixes from StyleCI * Scrutinizer updates * Update controller.stub * Feature/requests mapping (#13) * Event accepts request object and any type of request can now be pushed through * Apply fixes from StyleCI (#12) * Request should have a constructor for instances with models * Update BaseRepository.php * Apply fixes from StyleCI (#15) * Fixed namespace type declaration * Fixed namespace type declaration * Fixed namespace type declaration * Added resource collections and policy check. * Updated Readme * Formatting * Apply fixes from StyleCI (#20) * Scrutinizer fixes - deprecation / namesapce * Added middleware and query qualifiers * Policy Update * Post adding new and artisan updated, code cleanup * Apply fixes from StyleCI (#21) * Scrutiniser fixes * Put now handles relations * Fix return types * Minor updates to fix relationships and make command * Sanke case vs camel case * Apply fixes from StyleCI (#23) * Minor bugfix for case sensitifity * Fixed make command * model is static * Apply fixes from StyleCI (#24) * Scrutiniser fixes * Apply fixes from StyleCI (#25) * Apply fixes from StyleCI (#27) * Policiies auth mehtod without users * user not needed * Tidy up uri parser class * Fixes * fix more * Feature/policy collections update (#29) * Added resource collections and policy check. * Updated Readme * Formatting * Apply fixes from StyleCI (#20) * Scrutinizer fixes - deprecation / namesapce * Added middleware and query qualifiers * Policy Update * Post adding new and artisan updated, code cleanup * Apply fixes from StyleCI (#21) * Scrutiniser fixes * Put now handles relations * Fix return types * Minor updates to fix relationships and make command * Sanke case vs camel case * Apply fixes from StyleCI (#23) * Minor bugfix for case sensitifity * Fixed make command * model is static * Apply fixes from StyleCI (#24) * Scrutiniser fixes * policies - for unauthed users * Minor updates * STYLEFIXES * fixed phpcs rule * Apply fixes from StyleCI (#31) * Feature/policy collections update (#32) * Added resource collections and policy check. * Updated Readme * Formatting * Apply fixes from StyleCI (#20) * Scrutinizer fixes - deprecation / namesapce * Added middleware and query qualifiers * Policy Update * Post adding new and artisan updated, code cleanup * Apply fixes from StyleCI (#21) * Scrutiniser fixes * Put now handles relations * Fix return types * Minor updates to fix relationships and make command * Sanke case vs camel case * Apply fixes from StyleCI (#23) * Minor bugfix for case sensitifity * Fixed make command * model is static * Apply fixes from StyleCI (#24) * Scrutiniser fixes * policies - for unauthed users * Minor updates * STYLEFIXES * fixed phpcs rule * Apply fixes from StyleCI (#31) * minor updates * csfixer run on code * Missing file updated * Includes should be returnable * static not defined * Allowed fields updated * minor updates * Logic inversion + Updated excludeArrayValues to exclude if not in optionals instead of always including. * Added accessor notes about $appends usage * Update controller with query modifier * Add extra query parser method * Include previous exception with ApiException
diff --git a/README.md b/README.md
@@ -120,7 +120,8 @@ By default all fields are returned, you can limit that to specific fields in the
 * Api Controller parameter `$defaultFields` default as `protected $defaultFields = ['*'];` - switch to include an array of fields
 * fields param in url querystring: ie `fields=id,name,age` = will only return those, this will also override the above.
 * in your response resource you can set the static::allowedFields to lock down which fields are returnable
-* addfields and removefields params in url querystring will work with these.
+* `addfields` and `removefields` params in url querystring will work with these.
+* Use laravel [eloquent model `$appends`](https://laravel.com/docs/6.x/eloquent-serialization#appending-values-to-json) property to automatically include custom attribute accessors.
 
 ## Relationships
 
diff --git a/src/Contracts/Parser.php b/src/Contracts/Parser.php
@@ -23,6 +23,13 @@ protected function getUriParser($request)
         return self::$uriParser;
     }
 
+    protected function parseExtraQueryParams($request, array $extraParams = []): void
+    {
+        $all = $request->query->all();
+        $new = array_merge_recursive($all, $extraParams);
+        $request->query->add($new);
+    }
+
     /**
      * Parses our include joins.
      */
diff --git a/src/Helpers.php b/src/Helpers.php
@@ -117,7 +117,7 @@ public static function filterFieldsFromRequest($request, ?array $defaultFields,
     public static function excludeArrayValues(array $array, array $excludes, ?array $optionals = []): array
     {
         return Arr::where($array, function ($value) use ($excludes, $optionals) {
-            return ! in_array($value, $excludes) || in_array($value, $optionals);
+            return ! in_array($value, $excludes) || ! in_array($value, $optionals);
         });
     }
 }
diff --git a/src/Http/Controllers/Api/Controller.php b/src/Http/Controllers/Api/Controller.php
@@ -105,8 +105,9 @@ public function __construct()
      *
      * @param \Illuminate\Http\Request|\Illuminate\Foundation\Http\FormRequest $request
      */
-    public function handleIndexAction($request)
+    public function handleIndexAction($request, array $extraParams = [])
     {
+        $this->parseExtraQueryParams($request, $extraParams);
         $this->validateRequestType($request);
         $this->authoriseUserAction('viewAny');
         $this->getUriParser($request);
@@ -168,7 +169,7 @@ public function handleStoreAction($request)
         } catch (\Illuminate\Database\QueryException $exception) {
             $message = config('app.debug') ? $exception->getMessage() : 'Failed to create Record';
 
-            throw new ApiException($message);
+            throw new ApiException($message, $exception->getCode(), $exception);
         } catch (\Exception $exception) {
             DB::rollback();
 
@@ -183,8 +184,9 @@ public function handleStoreAction($request)
      * @param int $id
      * @param \Illuminate\Http\Request|\Illuminate\Foundation\Http\FormRequest $request
      */
-    public function handleShowAction($id, $request)
+    public function handleShowAction($id, $request, array $extraParams = [])
     {
+        $this->parseExtraQueryParams($request, $extraParams);
         $this->validateRequestType($request);
 
         $this->authoriseUserAction('view', self::$model::find($id));

Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ public static function filterFieldsFromRequest($request, ?array $defaultFields,`
`117`	`117`	`public static function excludeArrayValues(array $array, array $excludes, ?array $optionals = []): array`
`118`	`118`	`{`
`119`	`119`	`return Arr::where($array, function ($value) use ($excludes, $optionals) {`
`120`		`- return ! in_array($value, $excludes) \|\| in_array($value, $optionals);`
	`120`	`+ return ! in_array($value, $excludes) \|\| ! in_array($value, $optionals);`
`121`	`121`	`});`
`122`	`122`	`}`
`123`	`123`	`}`