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

Author: phpsa

README.md

@@ -42,6 +42,29 @@ You can override the methods by simply putting in your own methods to override -
 * PUT  (class::update) - triggers a new `Phpsa\LaravelApiController\Events\Updated` Event which has the updated record available as `$record`
 * DELETE (class::destry) - triggers a new `Phpsa\LaravelApiController\Events\Deleted` Event which has the deleted record available as `$record`
 
+## Policies
+
+Policies: https://laravel.com/docs/6.x/authorization#generating-policies
+
+Generate with `php artisan make:policy PostPolicy --model=Post`
+
+* Get list - calls the `viewAny` policy
+* Get single - calls the `view` policy
+* Post New - calls the `create` policy
+* Put Update - calls the `update` policy
+* Delete item - calls the `delete` policy
+
+## Resources / Collections (Transforming)
+ Resources: https://laravel.com/docs/6.x/eloquent-resources
+
+ Generate with
+ `php artisan make:resource UserResource` and `php artisan make:resource UserCollection`
+
+in your controller override the following params:
+```php
+	protected $resourceSingle = UserResource::class;
+	protected $resourceCollection = UserCollection::class;
+```
 
 ## Filtering
 
@@ -106,13 +129,16 @@ see https://laravel.com/docs/5.8/validation#conditionally-adding-rules
 
 The following parameters are set in the Base Api controller and can be overwritten by your Controller on a case by case basis:
 
-* `protected $resourceKeySingular = 'data';`	Resource key for an item.
-* `protected $resourceKeyPlural = 'data';`		Resource key for a collection.
-* `protected $defaultFields = ['*'];`			Default Fields to respond with
-* `protected $defaultSort = null;`				Set the default sorting for queries.
-* `protected $defaultLimit = 25;`				Number of items displayed at once if not specified. (0 = maximumLimit)
-* `protected $maximumLimit = 0;`				Maximum limit that can be set via $_GET['limit']. - this ties in with the defaultLimit aswell, and if wanting to disable pagination , both should be 0. ) will allow all records to be returned in a single call.
-* `protected $unguard = false;`   				Do we need to unguard the model before create/update?
+* **DEPRECATED** `protected $resourceKeySingular = 'data';`
+* **DEPRECATED** `protected $resourceKeyPlural = 'data';`
+
+* `protected $resourceSingle = JsonResource::class;`			Collection to use for your single resource
+* `protected $resourceCollection = ResourceCollection::class;`	Collection to use for your resource collection
+* `protected $defaultFields = ['*'];`							Default Fields to respond with
+* `protected $defaultSort = null;`								Set the default sorting for queries.
+* `protected $defaultLimit = 25;`								Number of items displayed at once if not specified. (0 = maximumLimit)
+* `protected $maximumLimit = 0;`								Maximum limit that can be set via $_GET['limit']. - this ties in with the defaultLimit aswell, and if wanting to disable pagination , both should be 0. ) will allow all records to be returned in a single call.
+* `protected $unguard = false;`   								Do we need to unguard the model before create/update?
 
 ## Security
 
@@ -122,7 +148,11 @@ instead of using the issue tracker.
 ## Credits
 
 - [Craig G Smith](https://github.com/phpsa)
+- [Phil Taylor]()
 - [All contributors](https://github.com/phpsa/laravel-api-controller/graphs/contributors)
 
-[badge_laravel]:   https://img.shields.io/badge/Laravel-5.8%20to%205.8-orange.svg?style=flat-square
+## Sponsors
+- [Custom D](https://customd.com)
+
+[badge_laravel]:   https://img.shields.io/badge/Laravel-5.8%20to%206-orange.svg?style=flat-square
 [badge_issues]:    https://img.shields.io/github/issues/ARCANEDEV/Support.svg?style=flat-square

composer.json

@@ -16,7 +16,7 @@
   ],
   "require": {
     "php": ">=7.1.3",
-    "illuminate/support": "~5.8.0|~6.0|~6.1"
+    "illuminate/support": "~5.8.0|^6.0"
   },
   "require-dev": {
     "orchestra/testbench": "~3.8.0",

config/laravel-api-controller.php

@@ -1,26 +1,16 @@
 <?php
 
 return [
-    /*
-     * Relative path from the app directory to api controllers directory.
-     */
-    'controllers_dir'  => 'Http/Controllers/Api',
-    /*
-     * Relative path from the app directory to the api routes file.
-     */
-    'routes_file'      => '../routes/api.php',
-    /*
-     * Relative path from the app directory to the models directory. Typically it's either 'Models' or ''.
-     */
-    'models_base_dir'  => 'Models',
-    /*
-     * Relative path from the base directory to the api controller stub.
-     */
-    'controller_stub'  => 'vendor/phpsa/laravel-api-controller/src/Generator/stubs/controller.stub',
-    /*
-     * Relative path from the base directory to the route stub.
-     */
-    'route_stub'       => 'vendor/phpsa/laravel-api-controller/src/Generator/stubs/route.stub',
+    // Relative path from the app directory to api controllers directory.
+    'controllers_dir' => 'Http/Controllers/Api',
+    // Relative path from the app directory to the api routes file.
+    'routes_file' => '../routes/api.php',
+    // Relative path from the app directory to the models directory. Typically it's either 'Models' or ''.
+    'models_base_dir' => 'Models',
+    // Relative path from the base directory to the api controller stub.
+    'controller_stub' => 'vendor/phpsa/laravel-api-controller/src/Generator/stubs/controller.stub',
+    // Relative path from the base directory to the route stub.
+    'route_stub' => 'vendor/phpsa/laravel-api-controller/src/Generator/stubs/route.stub',
 
     'parameters' => [
         'include' => 'include',
@@ -30,5 +20,4 @@
         'page' => 'page',
         'group' => 'group',
     ],
-
 ];

src/Events/Created.php

@@ -27,8 +27,6 @@ class Created
      *
      * @param  \Illuminate\Database\Eloquent\Model  $record
      * @param \Illuminate\Http\Request|\Illuminate\Foundation\Http\FormRequest $request
-     *
-     * @return void
      */
     public function __construct($record, $request)
     {

src/Events/Deleted.php

@@ -27,8 +27,6 @@ class Deleted
      *
      * @param  \Illuminate\Database\Eloquent\Model  $record
      * @param \Illuminate\Http\Request|\Illuminate\Foundation\Http\FormRequest $request
-     *
-     * @return void
      */
     public function __construct($record, $request)
     {

src/Events/Updated.php

@@ -27,8 +27,6 @@ class Updated
      *
      * @param  \Illuminate\Database\Eloquent\Model  $record
      * @param \Illuminate\Http\Request|\Illuminate\Foundation\Http\FormRequest $request
-     *
-     * @return void
      */
     public function __construct($record, $request)
     {

src/Generator/ApiMakeCommand.php

@@ -11,34 +11,38 @@
 class ApiMakeCommand extends Command
 {
     use DetectsApplicationNamespace;
+
     /**
      * The filesystem instance.
      *
      * @var \Illuminate\Filesystem\Filesystem
      */
     protected $files;
+
     /**
      * The console command name.
      *
      * @var string
      */
     protected $name = 'make:api';
+
     /**
      * The console command description.
      *
      * @var string
      */
     protected $description = 'Create api controller and api routes for a given model (phpsa/laravel-api-controller)';
+
     /**
      * The array of variables available in stubs.
      *
      * @var array
      */
     protected $stubVariables = [
-        'app'         => [],
-        'model'       => [],
-        'controller'  => [],
-        'route'       => [],
+        'app' => [],
+        'model' => [],
+        'controller' => [],
+        'route' => [],
     ];
 
     protected $modelsBaseNamespace;
@@ -56,8 +60,6 @@ public function __construct(Filesystem $files)
 
     /**
      * Execute the console command.
-     *
-     * @return void
      */
     public function handle()
     {
@@ -169,6 +171,7 @@ protected function addRoutes()
         $routesFile = app_path(config('laravel-api-controller.routes_file'));
         // read file
         $lines = file($routesFile);
+
         if (! $lines) {
             //@todo - better error handling here
             return false;
@@ -183,6 +186,7 @@ protected function addRoutes()
         }
         // save file
         $fp = fopen($routesFile, 'w');
+
         if (! is_resource($fp)) {
             //@todo - better error handling here
             return false;
@@ -202,6 +206,7 @@ protected function addRoutes()
     protected function createClass($type)
     {
         $path = $this->getPath($this->stubVariables[$type]['fullNameWithoutRoot']);
+
         if ($this->files->exists($path)) {
             $this->error(ucfirst($type).' already exists!');
 

src/Generator/stubs/controller.stub

@@ -26,9 +26,9 @@ class {{controller.name}} extends Controller
      * @return Response
      */
     public function index(Request $request)
-	{
-		return $this->handleIndexAction($request);
-	}
+    {
+        return $this->handleIndexAction($request);
+    }
 
    /**
     * Store a newly created resource in storage.
@@ -54,7 +54,7 @@ class {{controller.name}} extends Controller
      */
     public function show($id, Request $request)
     {
-		return $this->handleShowAction($id, $request);
+		    return $this->handleShowAction($id, $request);
     }
 
     /**