Changelog

- Added: query filter for crud - Added: json response for QueryException - Updated: crud.ts to crud.vue
Blair2004 · Sep 21, 2021 · 2bfd421 · 2bfd421
1 parent d565757
commit 2bfd421
Show file tree

Hide file tree

Showing 15 changed files with 296 additions and 123 deletions.
diff --git a/app/Crud/OrderCrud.php b/app/Crud/OrderCrud.php
@@ -8,6 +8,7 @@
 use TorMorten\Eventy\Facades\Events as Hook;
 use Exception;
 use App\Models\Order;
+use App\Services\Helper;
 use App\Services\OrdersService;
 use Illuminate\Support\Facades\DB;
 
@@ -42,6 +43,13 @@ class OrderCrud extends CrudService
         [ 'nexopos_customers', 'nexopos_customers.id', '=', 'nexopos_orders.customer_id' ],
     ];
 
+    public $pick                =   [
+        'nexopos_users'         =>  [ 'username' ],
+        'nexopos_customers'     =>  [ 'name' ]
+    ];
+
+    public $queryFilters    =   [];
+
     /**
      * Define where statement
      * @var  array
@@ -75,6 +83,38 @@ public function __construct()
         parent::__construct();
 
         Hook::addFilter( $this->namespace . '-crud-actions', [ $this, 'setActions' ], 10, 2 );
+
+        /**
+         * Let's define the query filters
+         * we would like to apply to the crud
+         */
+        $this->queryFilters     =   [
+            [
+                'type'  =>  'date',
+                'name'  =>  'created_at',
+                'description'   =>  __( 'Restrict the orders by the creation date.' ),
+                'label' =>  __( 'Created At' )
+            ], [
+                'type'      =>  'select',
+                'label'     =>  __( 'Payment Status' ),
+                'name'      =>  'payment_status',
+                'description'   =>  __( 'Restrict the orders by the payment status.' ),
+                'options'   =>  Helper::kvToJsOptions([
+                    Order::PAYMENT_PAID                 =>  __( 'Paid' ),
+                    Order::PAYMENT_PARTIALLY            =>   __( 'Partially Paid' ),
+                    Order::PAYMENT_PARTIALLY_REFUNDED   =>  __( 'Partially Refunded' ),
+                    Order::PAYMENT_REFUNDED             =>  __( 'Refunded' ),
+                    Order::PAYMENT_UNPAID               =>  __( 'Unpaid' ),
+                    Order::PAYMENT_VOID                 =>  __( 'Voided' ),
+                ])
+            ], [
+                'type'      =>  'select',
+                'label'     =>  __( 'Author' ),
+                'name'      =>  'nexopos_orders.author',
+                'description'   =>  __( 'Restrict the orders by the author.' ),
+                'options'   =>  Helper::toJsOptions( User::get(), [ 'id', 'username' ])
+            ]
+        ];
     }
 
     /**

diff --git a/app/Exceptions/Handler.php b/app/Exceptions/Handler.php
@@ -76,6 +76,12 @@ public function render($request, Throwable $exception)
         }
 
         if ( $exception instanceof QueryException ) {
+            if ( $request->expectsJson() ) {
+                return response()->json([
+                    'message' => $exception->getMessage()
+                ], 404);    
+            } 
+
             return ( new ExceptionsQueryException( $exception->getMessage() ) )
                 ->render( $request );
         }

diff --git a/app/Http/Controllers/Dashboard/CrudController.php b/app/Http/Controllers/Dashboard/CrudController.php
@@ -406,6 +406,7 @@ public function crudGet( string $namespace, Request $request )
 
         /**
          * Let's check it the resource has a method to retreive an item
+         * @var CrudService
          */
         $resource  =   new $crudClass;
 
@@ -462,6 +463,7 @@ public function getConfig( string $namespace )
                     get_class( $resource ) . '@getColumns', 
                     $resource->getColumns()
                 ),
+                'queryFilters'          =>  Hook::filter( get_class( $resource ) . '@getQueryFilters', $resource->getQueryFilters() ),
                 'labels'                =>  Hook::filter( get_class( $resource ) . '@getLabels', $resource->getLabels() ),
                 'links'                 =>  Hook::filter( get_class( $resource ) . '@getLinks', $resource->getLinks() ?? [] ),
                 'bulkActions'           =>  Hook::filter( get_class( $resource ) . '@getBulkActions', $resource->getBulkActions() ),

diff --git a/app/Services/CrudService.php b/app/Services/CrudService.php
@@ -35,6 +35,12 @@ class CrudService
      */
     protected   $columns    =   [];
 
+    /**
+     * Query filters
+     * @param array
+     */
+    protected $queryFilters  =   [];
+
     /**
      * Link
      * @return array
@@ -129,6 +135,15 @@ public function getBulkActions()
         return $this->bulkActions;
     }
 
+    /**
+     * Returns the available query filters
+     * @return array
+     */
+    public function getQueryFilters()
+    {
+        return $this->queryFilters;
+    }
+
     public function __extractTable( $relation )
     {
         $parts  =   explode( ' as ', $relation[0] );
@@ -390,6 +405,25 @@ public function getEntries( $config = [] )
             );
         }
 
+        /**
+         * @since 4.5.5
+         * Will filter request using provided
+         * query filters
+         */
+        if ( $request->query( 'queryFilters' ) ) {
+            $filters    =   json_decode( urldecode( $request->query( 'queryFilters' ) ), true );
+
+            /**
+             * @todo we might need to get the filter from the resource
+             * so that we can parse correctly the provider query filters.
+             */
+            if ( ! empty( $filters ) ) {
+                foreach( $filters as $key => $value ) {
+                    $query->where( $key, $value );
+                }
+            }
+        }
+
         /**
          * let's make the "perPage" value adjustable
          */

diff --git a/config/nexopos.php b/config/nexopos.php
@@ -1,6 +1,6 @@
 <?php
 return [
-    'version'       =>  '4.5.4',
+    'version'       =>  '4.5.5',
     'languages'     =>  [
         'en'        =>  'English',
         'fr'        =>  'Français',

diff --git a/public/css/app.css b/public/css/app.css
diff --git a/public/js/app.min.js b/public/js/app.min.js
diff --git a/public/js/auth.min.js b/public/js/auth.min.js
diff --git a/public/js/manifest.js b/public/js/manifest.js
diff --git a/public/js/pos.min.js b/public/js/pos.min.js
diff --git a/public/js/setup.min.js b/public/js/setup.min.js
diff --git a/public/js/vendor.js b/public/js/vendor.js
diff --git a/resources/ts/components/components.ts b/resources/ts/components/components.ts
@@ -6,7 +6,7 @@ import { nsInput }              from  './ns-input';
 import { nsSelect }             from  './ns-select';
 import { nsSelectAudio }        from  './ns-select-audio';
 import { nsCheckbox }           from  './ns-checkbox';
-import { nsCrud }               from  './ns-crud';
+import { default as nsCrud }    from  './ns-crud.vue';
 import { nsTableRow }           from  './ns-table-row';
 import { nsSpinner }            from  './ns-spinner';
 import { nsCrudForm }           from  './ns-crud-form';