PHP code example of firevel / filterable

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

firevel / filterable example snippets

// In app/Models/User.php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Firevel\Filterable\Filterable;

class User extends Model
{
    use Filterable;

    /**
     * Specify which fields (or “virtual” keys) can be filtered,
     * along with their data types.
     */
    protected $filterable = [
        'id'         => 'id',
        'first_name' => 'string',
        'last_name'  => 'string',
        'email'      => 'string',
        'created_at' => 'datetime',
    ];
}

$users = User::filter([
    'first_name' => ['like' => 'Smith'],
    'created_at' => ['>'    => '2023-01-01'],
])->get();

protected $filterable = [
    'id'            => 'id',
    'first_name'    => 'string',
    'last_name'     => 'string',
    'email'         => 'string',
    'created_at'    => 'datetime',
    'is_active'     => 'boolean',
    'meta'          => 'json',
    'roles'         => 'relationship',
];

class User extends Model
{
    use Filterable;

    protected $validateColumns = true;

    protected $filterable = [
        'id'       => 'id',
        'email'    => 'string',
        'status'   => 'string',
    ];
}

// 1) Simple equality (defaults to '=')
$users = User::filter([ 'id' => 5 ])->get();
// → SELECT * FROM users WHERE id = 5;

// 2) Explicit operators
$users = User::filter([ 'created_at' => ['>' => '2024-01-01'] ])->get();
// → SELECT * FROM users WHERE created_at > '2024-01-01';

// 3) LIKE operator for strings
$users = User::filter([ 'email' => ['like' => '%@example.com'] ])->get();
// → SELECT * FROM users WHERE email LIKE '%@example.com';

$filters = [
    'first_name' => ['like' => 'John'],
    'created_at' => ['>='   => '2025-01-01'],
    'status'     => ['='    => 'active'],
];

$users = User::filter($filters)->get();
// → SELECT * FROM users
//    WHERE first_name LIKE '%John%'
//      AND created_at >= '2025-01-01'
//      AND status = 'active';

   use Illuminate\Database\Eloquent\Model;
   use Firevel\Filterable\Filterable;

   class User extends Model
   {
       use Filterable;

       protected $filterable = [
           'first_name' => 'string',
           'last_name'  => 'string',
           'email'      => 'string',
           'created_at' => 'datetime',

           // “name” isn’t a real column; mark it as a custom scope
           'name'       => 'scope',
       ];

       // Add a local scopeName() to combine first_name OR last_name
       public function scopeName($query, $value)
       {
           $query->where(function ($q) use ($value) {
               $q->where('first_name', 'like', "%{$value}%")
                 ->orWhere('last_name',  'like', "%{$value}%");
           });
       }
   }
   

   // Will invoke scopeName() internally
   $users = User::filter([
       'name'       => ['like' => 'Smith'], 
       'created_at' => ['>'    => '2025-01-01']
   ])->get();
   

  protected $filterable = [
      'meta' => 'json',
      // … other fields …
  ];
  

  // Get users whose JSON “meta->role” equals “admin”
  $users = User::filter([ 'meta->role' => ['=' => 'admin'] ])->get();
  // → SELECT * FROM users WHERE JSON_EXTRACT(meta, '$.role') = 'admin';
  

  protected $filterable = [
      'tags' => 'array', // assumes tags is a JSON array column
  ];
  

  // Get users whose “tags” array contains “premium”
  $users = User::filter([ 'tags' => ['in' => 'premium'] ])->get();
  // → SELECT * FROM users WHERE JSON_CONTAINS(tags, '"premium"');
  

// In User.php
protected $filterable = [
    'email'      => 'string',
    'orders'     => 'relationship',
];

// In Order.php (no special setup 

// 1) Just check that a user has at least one order:
$usersWithAnyOrder = User::filter([ 'orders' => ['>' => 0] ])->get();
// → SELECT * FROM users 
//    WHERE ( SELECT COUNT(*) FROM orders WHERE orders.user_id = users.id ) > 0;

// 2) Filter by a condition on the order itself:
$filters = [
    'orders.status' => ['=' => 'shipped'],
    'email'         => ['like' => '%@example.com'],
];
$users = User::filter($filters)->get();
// → SELECT * FROM users
//    WHERE EXISTS (
//      SELECT 1 FROM orders 
//       WHERE orders.user_id = users.id 
//         AND status = 'shipped'
//    ) 
//      AND email LIKE '%@example.com';

> // Define a custom where clause for the related model
> $relatedWhere = function ($query) {
>     $query->where('price', '>', 100);
> };
>
> User::useRelationshipQuery($relatedWhere)
>     ->filter([ 'orders' => ['in' => [1,2,3]] ])
>     ->get();
> 

  protected $filterable = [
      'is_active' => 'boolean',
  ];
  

  // Accepts true/false, "1"/"0", "true"/"false" (case insensitive)
  $activeUsers   = User::filter(['is_active' => ['=' => 'true']])->get();
  $inactiveUsers = User::filter(['is_active' => ['=' => '0']])->get();
  

  // Users with no email
  $usersNoEmail = User::filter([ 'email' => ['is' => 'null'] ])->get();

  // Users where deleted_at IS NOT NULL (soft‐deleted)
  $trashed = User::filter([ 'deleted_at' => ['not' => 'null'] ])->get();
  

// 1) Find all “admin” users created in the last 30 days,
//    whose email domain is “example.com” and have placed at least one “shipped” order.

$filters = [
    'role'       => ['='    => 'admin'],
    'created_at' => ['>='   => now()->subDays(30)->toDateString()],
    'email'      => ['like' => '%@example.com'],
    'orders.status' => ['=' => 'shipped'],
];

$admins = User::filter($filters)
    ->orderBy('created_at', 'desc')
    ->paginate(15);


// 2) Search by “full name” (composite filter: first_name OR last_name),
//    and also filter by a JSON metadata key:
$filters = [
    'name'           => ['like' => 'Doe'],         // see “Composite Filters”
    'meta->department'=> ['='  => 'engineering'],  // JSON column
    'status'         => ['='    => 'active'],
];

$users = User::filter($filters)->get();


// 3) Get all products whose “tags” JSON array 

  protected $validateColumns = true;