Laravel Cross Eloquent Search

https://github.com/protonemedia/laravel-cross-eloquent-search
Admin
A Laravel package that enables searching across multiple Eloquent models simultaneously, with...
Tokens:8,501
Snippets:76
Trust Score:9.7
License:MIT
Update:7 months ago
Show doc for...
Tokens:
Raw
### Search Through Nested Relationships in PHP

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

This example demonstrates searching through nested relationships using dot notation within the column names passed to the `add` method.

```php
Search::add(Post::class, ['comments.body'])
    ->add(Video::class, ['posts.user.biography'])
    ->search('solution');
```

--------------------------------

### Get Results Without Searching in PHP

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

This example shows how to retrieve results without a search term by calling the `search` method without arguments or with an empty term. The `orderBy` method can be used to specify sorting columns.

```php
Search::add(Post::class)
    ->orderBy('published_at')
    ->add(Video::class)
    ->orderBy('released_at')
    ->search();
```

--------------------------------

### Retain Query String Parameters in Pagination Links in PHP

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

This example illustrates how to maintain query string parameters in pagination links using the `withQueryString` method. It can either use the current request's query string or accept a custom array of parameters.

```php
Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->paginate(15)
    ->withQueryString()  // Uses request()->query()
    ->search('build');
```

```php
Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->paginate(15)
    ->withQueryString(['filter' => 'active', 'sort' => 'date'])
    ->search('build');
```

--------------------------------

### Customize Model Type Value with searchType() (PHP)

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

Shows how to override the default model type value by defining a `searchType()` public method within your model. This allows for more specific or custom type naming in search results. The example uses a `Video` model to demonstrate this customization.

```php
class Video extends Model
{
    public function searchType()
    {
        return 'awesome_video';
    }
}

// Example result with searchType() method.
{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "video_id": null,
            "title": "foo",
            "published_at": null,
            "created_at": "2021-12-03T09:39:10.000000Z",
            "updated_at": "2021-12-03T09:39:10.000000Z",
            "type": "awesome_video",
        }
    ],
    ...
```

--------------------------------

### Configure search wildcards and matching

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

Shows how to control partial matching behavior using beginWithWildcard, endWithWildcard, and exactMatch methods to refine search result precision.

```php
Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->beginWithWildcard()
    ->endWithWildcard(false)
    ->search('os');
```

```php
Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->exactMatch()
    ->search('Laravel');
```

--------------------------------

### Perform basic cross-model search

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

Demonstrates how to initialize a search across multiple models using the Search facade. It accepts model classes and target columns to return a unified Eloquent collection.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

$results = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->search('howto');
```

```php
Search::new()
    ->add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->search('howto');
```

--------------------------------

### Run Tests (Bash)

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

Provides the command to execute the package's tests using Composer. This is a standard command for verifying the functionality and stability of the package.

```bash
composer test
```

--------------------------------

### Sounds Like Search Functionality in PHP

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

This code demonstrates how to use the `soundsLike` method to find terms that sound similar to the search query. It's applied after adding models and columns to the search instance.

```php
Search::new()
    ->add(Post::class, 'framework')
    ->add(Video::class, 'framework')
    ->soundsLike()
    ->search('larafel');
```

--------------------------------

### Simple Pagination for Search Results in PHP

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

This code shows how to implement simple pagination for search results using `simplePaginate`. This method returns a `Paginator` instance, which is not length-aware, and also accepts optional parameters for customization.

```php
Search::add(Post::class, 'title')
    ->add(Video::class, 'title')

    ->simplePaginate()
    // or
    ->simplePaginate($perPage = 15, $pageName = 'page', $page = 1)

    ->search('build');
```

--------------------------------

### Full-Text Search Implementation in PHP

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

This snippet shows how to perform full-text searches using the `addFullText` method, which leverages native database full-text search capabilities. It supports specifying search modes and searching through relationships.

```php
Search::new()
    ->add(Post::class, 'title')
    ->addFullText(Video::class, 'title', ['mode' => 'boolean'])
    ->addFullText(Blog::class, ['title', 'subtitle', 'body'], ['mode' => 'boolean'])
    ->search('framework -css');
```

```php
Search::new()
    ->addFullText(Page::class, [
        'posts' => ['title', 'body'],
        'sections' => ['title', 'subtitle', 'body'],
    ])
    ->search('framework -css');
```

--------------------------------

### Search Through Multiple Columns in PHP

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

This code shows how to search through multiple columns for a model by providing an array of column names as the second argument to the `add` method.

```php
Search::add(Post::class, ['title', 'body'])
    ->add(Video::class, ['title', 'subtitle'])
    ->search('eloquent');
```

--------------------------------

### Standalone Search Term Parsing (PHP)

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

Illustrates how to use the `parseTerms` method for standalone search term parsing. This method can be used to process search queries independently of the main search functionality. It also shows how to provide a callback function to iterate over each parsed term.

```php
$terms = Search::parseTerms('drums guitar');

Search::parseTerms('drums guitar', function($term, $key) {
    //
});
```

--------------------------------

### Perform Basic Cross-Model Search

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Demonstrates how to initialize a search across multiple Eloquent models using the Search facade. It returns a combined collection of results sorted by updated_at by default.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Basic search across two models
$results = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->search('laravel');

// Using the new() method for cleaner indentation
$results = Search::new()
    ->add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->search('howto');
```

--------------------------------

### Include Model Type in Search Results (PHP)

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

Demonstrates how to use the `includeModelType()` method to add the model's type to each search result. This is useful for distinguishing between different models in the search results. The default key for the type is 'type', but this can be customized.

```php
Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->includeModelType()
    ->paginate()
    ->search('foo');

// Example result with model identifier.
{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "video_id": null,
            "title": "foo",
            "published_at": null,
            "created_at": "2021-12-03T09:39:10.000000Z",
            "updated_at": "2021-12-03T09:39:10.000000Z",
            "type": "Post",
        },
        {
            "id": 1,
            "title": "foo",
            "subtitle": null,
            "published_at": null,
            "created_at": "2021-12-03T09:39:10.000000Z",
            "updated_at": "2021-12-03T09:39:10.000000Z",
            "type": "Video",
        },
    ],
    ...
```

--------------------------------

### Count Search Results in PHP

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

This code demonstrates how to count the number of search results using the `count` method. It's called after defining the models and search criteria.

```php
Search::add(Post::published(), 'title')
    ->add(Video::where('views', '>', 2500), 'title')
    ->count('compile');
```

--------------------------------

### Apply conditional search clauses

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

Utilizes the 'when' method to dynamically add models to the search query based on user state or application logic.

```php
Search::new()
    ->when($user->isVerified(), fn($search) => $search->add(Post::class, 'title'))
    ->when($user->isAdmin(), fn($search) => $search->add(Video::class, 'title'))
    ->search('howto');
```

--------------------------------

### Paginate Search Results in PHP

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

This snippet demonstrates how to paginate search results using the `paginate` method before calling `search`. It returns a `LengthAwarePaginator` instance and accepts optional parameters for customization, mirroring Laravel's database pagination.

```php
Search::add(Post::class, 'title')
    ->add(Video::class, 'title')

    ->paginate()
    // or
    ->paginate($perPage = 15, $pageName = 'page', $page = 1)

    ->search('build');
```

--------------------------------

### Eager Loading Relationships in Search in PHP

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

This snippet shows how to eager load relationships for search results. The `with` method is used on the Eloquent model before adding it to the search instance.

```php
Search::add(Post::with('comments'), 'title')
    ->add(Video::with('likes'), 'title')
    ->search('guitar');
```

--------------------------------

### Implement Phonetic Sounds-Like Search

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Enable soundex matching to find phonetically similar terms, which is effective for handling user input misspellings across multiple models.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Enable sounds-like matching
$results = Search::new()
    ->add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->soundsLike()
    ->search('larafel');

// Works across multiple models
$results = Search::add(User::class, 'name')
    ->add(Company::class, 'name')
    ->soundsLike()
    ->search('Jhon');
```

--------------------------------

### Configure Wildcard Matching

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Explains how to modify search behavior using wildcard methods. Options include enabling leading wildcards, disabling trailing wildcards, or forcing exact matches.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Enable wildcard at the beginning: %term%
$results = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->beginWithWildcard()
    ->search('os');

// Disable ending wildcard: %term (only match endings)
$results = Search::add(Post::class, 'title')
    ->beginWithWildcard()
    ->endWithWildcard(false)
    ->search('os');

// Exact match: no wildcards, uses = operator instead of LIKE
$results = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->exactMatch()
    ->search('Laravel');
```

--------------------------------

### Handle Multi-word and Phrase Searches

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Demonstrates how to search for exact phrases using quotes or by disabling term parsing to treat the entire input as a single search string.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Phrase search with double quotes
$results = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->search('"macos big sur"');

// Disable term parsing (same result as using quotes)
$results = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->dontParseTerm()
    ->search('macos big sur');
```

--------------------------------

### Register Multiple Models for Search

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Shows how to register multiple models and their searchable columns in a single operation using addMany(). This approach is a cleaner alternative to chaining multiple add() calls.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Add multiple models with addMany()
$results = Search::addMany([
    [Post::class, 'title'],
    [Video::class, 'title', 'published_at'],  // With custom order column
    [Comment::class, ['body', 'author_name']],  // Multiple columns
    [Post::published(), 'body'],  // With query builder
])->search('laravel');

// Equivalent to:
$results = Search::new()
    ->add(Post::class, 'title')
    ->add(Video::class, 'title', 'published_at')
    ->add(Comment::class, ['body', 'author_name'])
    ->add(Post::published(), 'body')
    ->search('laravel');
```

--------------------------------

### Apply Conditional Search Queries

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Build search queries dynamically using conditional logic with the when() method, or tap into the underlying Searcher instance for advanced operations.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;
use ProtoneMedia\LaravelCrossEloquentSearch\Searcher;

// Conditionally add models with when()
$results = Search::new()
    ->when($user->isVerified(), fn($search) => $search->add(Post::class, 'title'))
    ->when($user->isAdmin(), fn($search) => $search->add(Video::class, 'title'))
    ->when($sortByRelevance, fn($search) => $search->orderByRelevance())
    ->search('howto');

// Tap into the searcher instance
$results = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->tap(function (Searcher $searcher) {
        Log::info('Searching...', [
            'models' => $searcher->getModelsToSearchThrough()
        ]);
    })
    ->search('laravel');
```

--------------------------------

### Search Multiple Columns per Model

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Shows how to target multiple database columns for a single model by passing an array of column names to the add method.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Search in title and body for Posts, title and subtitle for Videos
$results = Search::add(Post::class, ['title', 'body'])
    ->add(Video::class, ['title', 'subtitle'])
    ->search('eloquent');
```

--------------------------------

### Add Constraints to Eloquent Models for Search in PHP

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

This snippet demonstrates how to add constraints to Eloquent models before searching by passing an instance of the Eloquent query builder to the `add` method instead of the class name.

```php
Search::add(Post::published(), 'title')
    ->add(Video::where('views', '>', 2500), 'title')
    ->search('compile');
```

--------------------------------

### Apply Query Constraints and Scopes

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Enhance search queries by passing Eloquent query builders directly, allowing for the application of constraints and the use of scoped queries. This enables more complex filtering and targeted searches.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Using query scopes and where clauses
$results = Search::add(Post::published(), 'title')
    ->add(Video::where('views', '>', 2500), 'title')
    ->search('compile');

// Complex query constraints
$results = Search::add(
        Post::where('status', 'published')
            ->where('created_at', '>', now()->subMonth()),
        'title'
    )
    ->add(
        Video::whereNotNull('published_at')
            ->where('duration', '>', 60),
        'title'
    )
    ->search('tutorial');
```

--------------------------------

### Advanced sorting and relevance

Source: https://github.com/protonemedia/laravel-cross-eloquent-search/blob/master/README.md

Configures result ordering by specific columns, relevance scores, or model priority. Note that relevance sorting is not supported for nested relationships.

```php
Search::add(Post::class, 'title', 'published_at')
    ->add(Video::class, 'title', 'released_at')
    ->orderByDesc()
    ->search('learn');
```

```php
Search::add(Post::class, 'title')
    ->beginWithWildcard()
    ->orderByRelevance()
    ->search('Apple iPad');
```

```php
Search::new()
    ->add(Comment::class, ['body'])
    ->add(Post::class, ['title'])
    ->add(Video::class, ['title', 'description'])
    ->orderByModel([
        Post::class, Video::class, Comment::class,
    ])
    ->search('Artisan School');
```

--------------------------------

### Paginate Search Results

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Implement pagination for search results using Laravel's built-in pagination features. Supports both length-aware pagination (with total count) and simple pagination (without total count for better performance). Custom pagination options and query string preservation are also available.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Length-aware pagination (includes total count)
$results = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->paginate()
    ->search('build');
// Returns: LengthAwarePaginator

// Custom pagination options
$results = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->paginate(
        $perPage = 15,
        $pageName = 'page',
        $page = 1
    )
    ->search('build');

// Simple pagination (no total count, better performance)
$results = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->simplePaginate(15, 'page', 1)
    ->search('build');
// Returns: Paginator

// Preserve query string parameters in pagination links
$results = Search::add(Post::class, 'title')
    ->paginate(15)
    ->withQueryString()  // Uses request()->query() automatically
    ->search('build');

// Or pass custom parameters
$results = Search::add(Post::class, 'title')
    ->paginate(15)
    ->withQueryString(['filter' => 'active', 'sort' => 'date'])
    ->search('build');
// Pagination links include: ?page=2&filter=active&sort=date
```

--------------------------------

### Parse Search Terms Programmatically

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Utilizes the standalone parser to break down user input into a collection of terms. Supports phrase preservation and callback-based processing for custom validation or transformation logic.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Parse terms into a collection
$terms = Search::parseTerms('drums guitar');
// Returns: Collection ['drums', 'guitar']

$terms = Search::parseTerms('"foo bar"');
// Returns: Collection ['foo bar'] (keeps phrase intact)

// Parse with callback
Search::parseTerms('drums guitar', function ($term, $key) {
    echo "Term {$key}: {$term}";
});
// Output: Term 0: drums, Term 1: guitar

// Use parsed terms for custom logic
$terms = Search::parseTerms($userInput);
foreach ($terms as $term) {
    // Validate or transform each term
    if (strlen($term) < 3) {
        continue;
    }
    // Build custom query...
}
```

--------------------------------

### Apply Custom Sorting to Search Results

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Illustrates how to define specific order columns per model and control the sort direction (ascending or descending) for the combined result set.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Sort by custom columns per model, descending order
$results = Search::add(Post::class, 'title', 'published_at')
    ->add(Video::class, 'title', 'released_at')
    ->orderByDesc()
    ->search('learn');

// Alternative: set order column after adding the model
$results = Search::new()
    ->add(Post::class, 'title')
    ->orderBy('published_at')
    ->add(Video::class, 'title')
    ->orderBy('released_at')
    ->orderByDesc()
    ->search('tutorial');
```

--------------------------------

### Eager Load Relationships in Search Results

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Optimize search performance by eager loading relationships and counts to prevent N+1 query issues when accessing related data.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Eager load with counts
$results = Search::add(
        Post::with('comments')->withCount('comments'),
        'title'
    )
    ->add(
        Video::with('likes', 'author'),
        'title'
    )
    ->search('guitar');

// Access eager loaded relations
foreach ($results as $result) {
    if ($result instanceof Post) {
        echo $result->comments_count;
        foreach ($result->comments as $comment) {
            echo $comment->body;
        }
    }
}
```

--------------------------------

### Retrieve Unified Model Results Without Search Terms

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Demonstrates how to fetch combined results from multiple models without a search query, useful for building unified feeds. It supports custom ordering and pagination across different model types.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Get all results without searching, ordered by custom columns
$results = Search::new()
    ->add(Post::class)
    ->orderBy('published_at')
    ->add(Video::class)
    ->orderBy('released_at')
    ->search();

// Paginate a unified feed
$feed = Search::new()
    ->add(Post::published())
    ->orderBy('published_at')
    ->add(Video::where('status', 'public'))
    ->orderBy('created_at')
    ->orderByDesc()
    ->paginate(20)
    ->search();
```

--------------------------------

### Perform Case-Insensitive Searches

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Configures the search to ignore case sensitivity regardless of the underlying database collation. This is often combined with wildcard searching for broader result matching.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Case-insensitive search
$results = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->beginWithWildcard()
    ->ignoreCase()
    ->search('FOO');
// Matches: 'foo', 'Foo', 'FOO', 'fOO', etc.

// Combine with other options
$results = Search::add(Article::class, ['title', 'content'])
    ->beginWithWildcard()
    ->ignoreCase()
    ->paginate(15)
    ->search('LARAVEL framework');
```

--------------------------------

### Perform Full-Text Search with Laravel

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Utilize native database full-text search capabilities, including boolean mode and relationship searching. This allows for complex query syntax and searching across multiple columns or related models.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Full-text search with boolean mode
$results = Search::new()
    ->add(Post::class, 'title')
    ->addFullText(Video::class, 'title', ['mode' => 'boolean'])
    ->addFullText(Blog::class, ['title', 'subtitle', 'body'], ['mode' => 'boolean'])
    ->search('framework -css');

// Full-text search through relationships
$results = Search::new()
    ->addFullText(Page::class, [
        'posts' => ['title', 'body'],
        'sections' => ['title', 'subtitle', 'body'],
    ])
    ->search('laravel eloquent');

// Mixed direct columns and relations
$results = Search::new()
    ->addFullText(Video::class, [
        'title',
        'blogs' => ['title', 'subtitle', 'body'],
    ])
    ->search('Laravel');
```

--------------------------------

### Order Search Results by Model Type

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Control the order in which results from different model types appear. You can prioritize specific models to be listed before others. This can be combined with `orderByDesc` for descending order within each model type.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Prioritize results by model type
$results = Search::new()
    ->add(Comment::class, ['body'])
    ->add(Post::class, ['title'])
    ->add(Video::class, ['title', 'description'])
    ->orderByModel([
        Post::class,    // Posts appear first
        Video::class,   // Then Videos
        Comment::class, // Comments last
    ])
    ->search('Artisan School');

// Combine with orderByDesc for descending within each type
$results = Search::new()
    ->add(Post::class, 'title', 'published_at')
    ->add(Video::class, 'title', 'published_at')
    ->orderByModel([Video::class, Post::class])
    ->orderByDesc()
    ->search('framework');
```

--------------------------------

### Count Search Results

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Retrieve the total count of matching records without executing the full query to fetch models, useful for UI indicators or pagination preparation.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Count total matches
$count = Search::add(Post::published(), 'title')
    ->add(Video::where('views', '>', 2500), 'title')
    ->count('compile');

echo "Found {$count} results";

// Useful for showing result counts before pagination
$totalCount = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->count('laravel');
```

--------------------------------

### Search Through Model Relationships

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Perform searches across related models using dot notation for nested relationships. This allows you to query data within associated models, such as searching for posts that have comments containing specific keywords or videos whose authors have certain biographical details.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Search through direct relationships
$results = Search::add(Post::class, ['comments.body'])
    ->search('solution');
// Finds Posts that have comments containing 'solution'

// Search through nested relationships
$results = Search::add(Video::class, ['posts.user.biography'])
    ->search('developer');
// Finds Videos whose posts have users with 'developer' in biography

// Combine direct and relationship columns
$results = Search::new()
    ->add(Video::class, ['title', 'posts.comments.body'])
    ->add(Post::class, ['title', 'comments.body'])
    ->search('amazing feature');
```

--------------------------------

### Order Search Results by Relevance

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Sort search results based on the number of occurrences of search terms. Results with more matches are ranked higher. This feature is not supported when searching through nested relationships.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Sort by relevance - more term matches = higher ranking
$results = Search::new()
    ->add(Post::class, ['title', 'body'])
    ->add(Video::class, ['title', 'description'])
    ->beginWithWildcard()
    ->orderByRelevance()
    ->search('Apple iPad');

// Example: "Apple unveils new iPad mini with iPad Pro features" ranks higher
// than "Apple introduces new product" because iPad appears twice
// Note: Not supported when searching through nested relationships
```

--------------------------------

### Identify Model Types in Search Results

Source: https://context7.com/protonemedia/laravel-cross-eloquent-search/llms.txt

Include a type attribute in the search results to distinguish between different model classes. Supports custom keys and custom type values via model methods.

```php
use ProtoneMedia\LaravelCrossEloquentSearch\Search;

// Add type identifier to results
$results = Search::add(Post::class, 'title')
    ->add(Video::class, 'title')
    ->includeModelType()
    ->paginate()
    ->search('foo');

// Custom type key name
$results = Search::add(Post::class, 'title')
    ->includeModelType('model_class')
    ->search('foo');

// Custom type value via model method
class Video extends Model
{
    public function searchType()
    {
        return 'awesome_video';
    }
}
```
Tokens:
Raw