README

A flexible and developer-friendly trait for Laravel Eloquent models that enables smart, customizable search functionality across model columns and relationships. Perfect for building dynamic filters and admin panels.

📦 Installation

composer require youssefreda/searchable:@dev

Note: This version uses @dev stability flag — make sure your project allows it in composer.json or add:

🚀 Features

• 🔎 Search directly on model fields
• 🔗 Supports searching across relationships (belongsTo, hasMany, etc.)
• 🔢 Smart numeric vs. string search
• 🌐 Handles Arabic text search using utf8mb4
• ⚙️ Define custom labels, types, and visibility
• 📥 Auto-generate dropdown options for searchable fields

🛠️ Usage

1. Use the Trait in Your Model

use Searchable\Traits\Searchable;

class Apartment extends Model
{
    use Searchable;
}

2. Define $searchable Property

protected static $searchable = [
    'client_name' => 'Client Name',
    'cost' => 'Cost',
    'user' => [
        'label' => 'User',
        'relation' => 'user',
        'field' => 'full_name'
    ]
];

Field Configuration Options:

🔍 Search Examples

Global Search

Apartment::search('Ahmed')->get();

Column-Specific Search

Apartment::search('Ahmed', 'client_name')->get();

🎛️ Generating Dropdown Options

Use getSearchColumnOptions() to generate ['key' => 'label'] pairs:

$options = Apartment::getSearchColumnOptions();

Output:

[
    'client_name' => 'Client Name',
    'cost' => 'Cost',
    'user' => 'User'
]

Blade Integration Example

@php
    $columns = \App\Models\Apartment::getSearchColumnOptions();
@endphp

<select name="column" class="form-select">
    <option value="all">{{ __('All Fields') }}</option>
    @foreach($columns as $value => $label)
        <option value="{{ $value }}" {{ request('column') === $value ? 'selected' : '' }}>
            {{ $label }}
        </option>
    @endforeach
</select>

✅ This snippet will allow the user to choose which column to search in. The list is auto-generated from the model's $searchable property.

🧪 Example Model: Apartment

use App\Traits\Searchable;

class Apartment extends Model
{
    use Searchable;

    protected static $searchable = [
        'client_name' => 'Client Name',
        'floor' => 'Floor',
        'commission' => 'Commission',
        'user' => [
            'label' => 'User',
            'relation' => 'user',
            'field' => 'full_name'
        ],
        'project' => [
            'label' => 'Project',
            'relation' => 'project',
            'field' => 'name'
        ]
    ];

    public function user()    { return $this->belongsTo(User::class); }
    public function project() { return $this->belongsTo(Project::class); }
}

⚙️ How It Works

🧠 Smart Numeric Detection

You can either:

• Explicitly define the type using 'type' => 'number'
• Or let it auto-detect based on field name patterns (e.g., cost, amount, price, etc.)

📄 License

MIT © Youssef Reda

🤝 Contribute

Pull Requests and Issues are welcome!