Registering Models

The scoutify:searchable command

The easiest way to register a model is using the provided Artisan command:

php artisan scoutify:searchable User

This command will:

1. Implement the GloballySearchable contract.
2. Add the Searchable trait.
3. Automatically resolve the URL for the search results.

Manual Registration

You can also register models manually by adding the contract and trait yourself:

use Matheusmarnt\Scoutify\Concerns\Searchable;
use Matheusmarnt\Scoutify\Contracts\GloballySearchable;
use Illuminate\Database\Eloquent\Model;

class Article extends Model implements GloballySearchable
{
    use Searchable;

    public function globalSearchUrl(): string
    {
        return route('articles.show', $this);
    }
}

Customization Methods

Tailor how your models appear in the search results by overriding these methods:

Content

Title & Subtitle

Control the primary and secondary text for each result.

public function globalSearchTitle(): string
{
    return $this->full_name;
}

public function globalSearchSubtitle(): ?string
{
    return "Department: {$this->department->name} • Joined {$this->created_at->diffForHumans()}";
}

Destination URL

The action taken when a user selects the result.

public function globalSearchUrl(): string
{
    return route('users.profile', $this->username);
}

Branding

Icons

Supports Blade Icons syntax.

public static function globalSearchIcon(): string
{
    return 'heroicon-o-user-circle';
}

Colors

Defines the accent color for group chips and UI highlights.

public static function globalSearchColor(): string
{
    return 'sky'; // Tailwind color name
}

Organization

Grouping

Cluster results under a specific category header.

public static function globalSearchGroup(): string
{
    return 'System Operators';
}

Filter Labels

The display name shown in the top filter bar.

public static function globalSearchLabel(): string
{
    return 'Admins';
}

---

Advanced Customization

Scoutify allows for deep integration with your business logic. Here is an example of a high-power implementation:

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Matheusmarnt\Scoutify\Authorization\VisibilityRule;
use Matheusmarnt\Scoutify\Concerns\Searchable;
use Matheusmarnt\Scoutify\Contracts\GloballySearchable;
use Matheusmarnt\Scoutify\Contracts\HasGlobalSearchVisibility;

class Project extends Model implements GloballySearchable, HasGlobalSearchVisibility
{
    use Searchable;

    public function globalSearchTitle(): string
    {
        return $this->is_archived
            ? "[Archived] {$this->name}"
            : $this->name;
    }

    public static function globalSearchIcon(): string
    {
        return 'heroicon-o-folder-open';
    }

    public function globalSearchVisibility(): VisibilityRule
    {
        return VisibilityRule::make()
            ->policy('view')
            ->using(fn ($record, $user) => $user->current_team_id === $record->team_id);
    }

    public function globalSearchUrl(): string
    {
        return route('projects.show', $this);
    }
}

Subtitle Auto-discovery

Scoutify automatically looks for common fields to use as a subtitle, such as description, subtitle, excerpt, summary, bio, or body.

HTML content in these fields is automatically sanitized to plain text and truncated to 150 characters.

Tip

Override globalSearchSubtitle() to provide a custom subtitle instead of relying on auto-discovery.

Icon Resolution

Scoutify integrates with Blade Icons. You can use icons from any installed pack:

public static function globalSearchIcon(): string
{
    return 'ri-customer-service-2-fill';
}

Dry Run

Use the --dry-run flag to see what changes the scoutify:searchable command would make without actually modifying any files:

php artisan scoutify:searchable User --dry-run