phpsa
diff --git a/‎README.md
+45-8 b/‎README.md
+45-8
diff --git a/‎composer.json
+1-1 b/‎composer.json
+1-1
diff --git a/‎config/laravel-api-controller.php
+10-21 b/‎config/laravel-api-controller.php
+10-21
diff --git a/‎src/Contracts/ModelRepository.php
+107 b/‎src/Contracts/ModelRepository.php
+107
@@ -42,6 +42,36 @@ 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
+
+Query/Data modifiers in policies for the api endpoints
+
+* `qualifyCollectionQueryWithUser($user, $repository)` -> return void - add any queries to the repository (ie ->where('x','))
+* `qualifyItemQueryWithUser($user, $repository)`-> return void - add any queries to the repository (ie ->where('x','))
+* `qualifyStoreDataWithUser($data)` - return the updated data array
+* `qualifyUpdateDataWithUser($data)` - return the updated data array
+
+## 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 +136,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 +155,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
@@ -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",
 
@@ -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',
     ],
-
 ];
@@ -0,0 +1,107 @@
+<?php
+
+namespace Phpsa\LaravelApiController\Contracts;
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Eloquent\Model;
+use Phpsa\LaravelApiController\Exceptions\ApiException;
+use Phpsa\LaravelApiController\Repository\BaseRepository;
+
+trait ModelRepository
+{
+    /**
+     * Eloquent model instance.
+     *
+     * @var mixed|Model instance
+     */
+    protected static $model;
+
+    /**
+     * Repository instance.
+     *
+     * @var mixed|BaseRepository
+     */
+    protected $repository;
+
+    /**
+     * Holds the available table columns.
+     *
+     * @var array
+     */
+    protected $tableColumns = [];
+
+    /**
+     * @throws ApiException
+     */
+    protected function makeModel(): void
+    {
+        $model = resolve($this->model());
+
+        if (! $model instanceof Model) {
+            throw new ApiException("Class {$this->model()} must be an instance of " . Model::class);
+        }
+
+        self::$model = $model;
+    }
+
+    /**
+     * Creates our repository linkage.
+     */
+    protected function makeRepository()
+    {
+        $this->repository = BaseRepository::withModel($this->model());
+    }
+
+    /**
+     * Set which columns area available in the model.
+     *
+     * @param Model $model
+     */
+    protected function setTableColumns(?Model $model = null): void
+    {
+        if (is_null($model)) {
+            $model = self::$model;
+        }
+        $table = $model->getTable();
+        $this->tableColumns[$table] = Schema::getColumnListing($table);
+    }
+
+    /**
+     * gets avaialble columns for the table.
+     *
+     * @param Model $model
+     *
+     * @return array
+     */
+    protected function getTableColumns(?Model $model = null): array
+    {
+        if (is_null($model)) {
+            $model = self::$model;
+        }
+
+        $table = $model->getTable();
+
+        if (! isset($this->tableColumns[$table])) {
+            $this->setTableColumns($model);
+        }
+
+        return $this->tableColumns[$table];
+    }
+
+    /**
+     * Eloquent model.
+     *
+     * @return string (model classname)
+     */
+    abstract protected function model();
+
+    /**
+     * Unguard eloquent model if needed.
+     */
+    protected function unguardIfNeeded()
+    {
+        if ($this->unguard) {
+            self::$model->unguard();
+        }
+    }
+}