Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/charlietyn/rest-generic-class/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Rest Generic Class provides a flexible dynamic filtering system that allows clients to build complex queries using the oper parameter. The system supports:
  • Multiple comparison operators (equality, range, pattern matching)
  • Logical grouping with and/or conditions
  • Nested filter structures for advanced queries
  • Automatic table prefixing to avoid column ambiguity
  • Database-specific features (PostgreSQL ilike, unaccent)

​
Basic Filter Structure

Filters are passed via the oper query parameter as a JSON object with logical operators: 
{
  "oper": {
    "and": [
      "status|=|active",
      "price|>|100"
    ]
  }
}
Each condition follows the format: field|operator|value

​
Supported Operators

The filtering system supports a comprehensive set of operators:

​
Comparison Operators

OperatorDescriptionExample
=Equalsstatus|=|active
!=, <>Not equalsstatus|!=|deleted
<Less thanprice|<|100
>Greater thanprice|>|50
<=Less than or equalstock|<=|10
>=Greater than or equalquantity|>=|5

​
Pattern Matching

OperatorDescriptionExample
likeCase-sensitive patternname|like|%John%
not likeNegated patternemail|not like|%test%
ilikeCase-insensitive (PostgreSQL)title|ilike|%search%
not ilikeNegated case-insensitivedescription|not ilike|%draft%
ilikeuWith unaccent (PostgreSQL)name|ilikeu|Jose (matches José)
regexpRegular expressioncode|regexp|^[A-Z]{3}
not regexpNegated regexcode|not regexp|[0-9]

​
List Operators

OperatorDescriptionExample
inValue in liststatus|in|active,pending
not in, notinValue not in listrole|not in|admin,superadmin

​
Range Operators

OperatorDescriptionExample
betweenValue between two valuesprice|between|10,100
not between, notbetweenValue outside rangeage|not between|18,65

​
Null Operators

OperatorDescriptionExample
nullField is NULLdeleted_at|null|
not null, notnullField is not NULLemail_verified_at|not null|

​
Date Operators

OperatorDescriptionExample
dateDate equalscreated_at|date|2024-03-05
not date, notdateDate not equalsupdated_at|not date|2024-01-01

​
Existence Operators

OperatorDescriptionExample
existsSubquery existsuser_id|exists|users.id
not exists, notexistsSubquery not existsparent_id|not exists|categories.id

​
Logical Operators

​
AND Conditions

All conditions must be true: 
{
  "oper": {
    "and": [
      "status|=|active",
      "price|>|100",
      "stock|>=|1"
    ]
  }
}

​
OR Conditions

At least one condition must be true: 
{
  "oper": {
    "or": [
      "category_id|=|1",
      "category_id|=|2",
      "featured|=|true"
    ]
  }
}

​
Nested Conditions

Combine AND/OR logic for complex queries: 
{
  "oper": {
    "and": [
      "status|=|active",
      {
        "or": [
          "priority|=|high",
          "urgent|=|true"
        ]
      }
    ]
  }
}
This creates SQL equivalent to: 
WHERE status = 'active' AND (priority = 'high' OR urgent = true)

​
Value Types

The filter system automatically decodes values: 
// Strings
"name|=|John"        // 'John'

// Numbers
"price|>|99.99"      // 99.99

// Booleans
"active|=|true"      // true
"deleted|=|false"    // false

// Null
"parent_id|=|null"   // null

// Arrays (comma-separated)
"id|in|1,2,3"        // [1, 2, 3]
"tags|in|red,blue"   // ['red', 'blue']

​
Configuration

Configure filtering behavior in config/rest-generic-class.php: 
'filtering' => [
    // Maximum nesting depth for complex filters
    'max_depth' => 5,
    
    // Maximum number of conditions per request
    'max_conditions' => 100,
    
    // Enforce relation allowlist
    'strict_relations' => true,
    
    // Allowed operators (customize as needed)
    'allowed_operators' => [
        '=', '!=', '<', '>', '<=', '>=',
        'like', 'not like', 'ilike', 'not ilike',
        'in', 'not in', 'between', 'not between',
        'null', 'not null', 'exists', 'not exists',
        'date', 'not date'
    ],
    
    // Validate column names against model fillable/table
    'validate_columns' => env('REST_VALIDATE_COLUMNS', true),
    
    // Strict mode throws errors for invalid columns
    'strict_column_validation' => env('REST_STRICT_COLUMNS', true),
    
    // Cache column lists for performance
    'column_cache_ttl' => 3600,
],

​
HasDynamicFilter Trait

The filtering logic is implemented in the HasDynamicFilter trait, which provides:

​
scopeWithFilters

Apply filters to an Eloquent query: 
use Ronu\RestGenericClass\Core\Traits\HasDynamicFilter;

class Product extends Model
{
    use HasDynamicFilter;
}

// In your controller or service
$query = Product::query();
$filters = [
    'and' => [
        'status|=|active',
        'price|>|100'
    ]
];

$results = $query->withFilters($filters)->get();

​
Key Methods

/**
 * Apply dynamic filters to query builder
 * 
 * @param Builder $query
 * @param array $params Filter structure
 * @param string $condition 'and' or 'or'
 * @param mixed $model Model instance for table prefixing
 * @return Builder
 */
public function scopeWithFilters($query, array $params, string $condition = 'and', $model = null)

​
Advanced Examples

​
Search with Multiple Conditions

GET /api/products?oper={"and":["status|=|active","category_id|in|1,2,3","price|between|50,200"]}

​
Complex Business Logic

Find active products that are either featured OR low in stock: 
{
  "oper": {
    "and": [
      "status|=|active",
      {
        "or": [
          "featured|=|true",
          "stock|<=|5"
        ]
      }
    ]
  }
}

{
  "oper": {
    "or": [
      "name|ilike|%search term%",
      "description|ilike|%search term%",
      "sku|like|%SEARCH%"
    ]
  }
}

​
Date Range Filtering

{
  "oper": {
    "and": [
      "created_at|>=|2024-01-01",
      "created_at|<|2024-12-31",
      "status|not in|draft,deleted"
    ]
  }
}

​
Security Considerations

The filtering system includes several protections:
  • Operator allowlist prevents SQL injection via invalid operators
  • Column validation ensures only valid table columns are queried
  • Max depth/conditions prevents DoS attacks with overly complex queries
  • Prepared statements all values are properly escaped
  • Relation restrictions only declared relations can be queried

​
Performance Tips

  1. Index filtered columns: Add database indexes to commonly filtered fields
  2. Limit nesting depth: Keep filter structures simple when possible
  3. Use specific operators: = is faster than like
  4. Avoid leading wildcards: name|like|%term is slower than name|like|term%
  5. Enable column caching: Reduces validation overhead

​
Error Handling

Common filtering errors: 
// Invalid operator
"field|invalid|value"  
// Throws: "The invalid value is not a valid operator"

// Invalid format
"field-operator-value"  
// Throws: "Invalid condition format: expected 'field|operator|value'"

// Wrong condition type
{"oper": "string"}  
// Throws: "Invalid condition format: expected a string like 'field|operator|value'"

// Unsupported logical key
{"oper": {"xor": [...]}}  
// Throws: "Unsupported logical key 'xor'. Only 'and' and 'or' are allowed."

Build docs developers (and LLMs) love

Get started for freeTalk to us