PHPackages                             acadea/fullsite-search - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. acadea/fullsite-search

ActiveLibrary

acadea/fullsite-search
======================

Laravel package to perform full site search based on Laravel Scout

v1.0.2(4y ago)315556MITPHPPHP ^7.4|^8.0

Since Oct 26Pushed 4y ago2 watchersCompare

[ Source](https://github.com/acadea/fullsite-search)[ Packagist](https://packagist.org/packages/acadea/fullsite-search)[ Docs](https://github.com/acadea/fullsite-search)[ GitHub Sponsors](https://github.com/acadea)[ RSS](/packages/acadea-fullsite-search/feed)WikiDiscussions master Synced 5d ago

READMEChangelog (3)Dependencies (6)Versions (4)Used By (0)

Laravel Full Site Search
========================

[](#laravel-full-site-search)

[![Latest Version on Packagist](https://camo.githubusercontent.com/02fc216282b24ac76629c74ededc70b905d262165a51155a0113fe19310477f3/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6163616465612f66756c6c736974652d7365617263682e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/acadea/fullsite-search)[![GitHub Tests Action Status](https://camo.githubusercontent.com/01fb5df29139bc7375fcbabdd8726893fd1d543a1ab8cf980960f0153e2be0cc/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f6163616465612f66756c6c736974652d7365617263682f72756e2d74657374733f6c6162656c3d7465737473)](https://github.com/acadea/fullsite-search/actions?query=workflow%3Arun-tests+branch%3Amaster)[![Total Downloads](https://camo.githubusercontent.com/938780cedc5b682f119e455935252edd8f9323cda9b395d0aa94d6799b5702ef/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6163616465612f66756c6c736974652d7365617263682e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/acadea/fullsite-search)

Laravel package to perform full site search based on Laravel Scout. Bringing the `search everything` box to live in a laravel app.

Support us
----------

[](#support-us)

Learn the idea behind this package in my:

- [Medium Blog](https://medium.com/p/27bbdc75ae8)
- [Youtube Lesson](https://www.youtube.com/watch?v=yuG1kS9WFz0)

Follow us on Youtube: [https://www.youtube.com/channel/acadeaio](https://www.youtube.com/channel/UCU5RsUGkVcPM9QvFHyKm1OQ)

Buy us a coffee:

Paypal: [https://www.paypal.com/donate/?hosted\_button\_id=HPD9HHN3HBPDC](https://www.paypal.com/donate/?hosted_button_id=HPD9HHN3HBPDC)

Quick Start
-----------

[](#quick-start)

```
// Expect a collection of models in the search result
$results = \Acadea\FullSite\FullSiteSearch::search('in');
```

Each model returned has 3 additional attributes:

- a. `match` -- the match + neighbouring text found from our DB records
- b. `model` -- the related model name
- c. `view_link` -- the URL for the user to navigate in the frontend to view the resource

To return the results as an API response:

```
// Controller
return \Acadea\FullSite\Resources\SiteSearchResource::collection($results);
```

For your convenience, we have bootstrapped the API endpoint for you. You can disable this in the config file. Just set the `fullsite-search.api.disabled` config to `true`.

#### Example:

[](#example)

URL: `/api/site-search?search=in`

We get:

```
{
    "data": [
        {
            "id": 2,
            "match": "...ER happen in a frighte...",
            "model": "Post",
            "view_link": "http://127.0.0.1:8000/posts/2"
        },
        {
            "id": 4,
            "match": "Drawling, Stretching, ...",
            "model": "Post",
            "view_link": "http://127.0.0.1:8000/posts/4"
        },
        {
            "id": 6,
            "match": "...ed to her in the dista...",
            "model": "Post",
            "view_link": "http://127.0.0.1:8000/posts/6"
        }
    ]
}
```

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require acadea/fullsite-search
```

You can publish the config file with:

```
php artisan vendor:publish --provider="Acadea\FullSite\FullSiteServiceProvider" --tag="config"
```

This is the contents of the published config file:

```
return [
    // path to your models directory, relative to /app
    'model_path' => 'Models',

    'api' => [
        // enable api endpoint
        'disabled' => false,
        // the api endpoint uri
        'url' => '/api/site-search',
    ],

    // you can put any models that you want to exclude from the search here
    'exclude' => [
        // example:
        // \App\Models\Comment::class
    ],

    // the number of neighbouring characters that you want to include in the match field of API response
    'buffer' => 10,

    // this is where you define where should the search result leads to.
    // the link should navigate to the resource view page
    // by default, we use `//` , you can define anything here
    // We will replace `{id}` or `{ id }` with the model id
    'view_mapping' => [
        // \App\Models\Comment::class => '/comments/view/{id}'
    ],
];
```

Testing
-------

[](#testing)

```
composer test
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [sam-ngu](https://github.com/sam-ngu)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity26

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~171 days

Total

3

Last Release

1683d ago

PHP version history (2 changes)v1.0.0PHP ^7.4

v1.0.2PHP ^7.4|^8.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/56226102?v=4)[Acadea](/maintainers/Acadea)[@acadea](https://github.com/acadea)

---

Top Contributors

[![sam-ngu](https://avatars.githubusercontent.com/u/30950704?v=4)](https://github.com/sam-ngu "sam-ngu (24 commits)")

---

Tags

acadeafullsite-search

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/acadea-fullsite-search/health.svg)

```
[![Health](https://phpackages.com/badges/acadea-fullsite-search/health.svg)](https://phpackages.com/packages/acadea-fullsite-search)
```

###  Alternatives

[illuminate/console

The Illuminate Console package.

12944.1M5.1k](/packages/illuminate-console)[timokoerber/laravel-one-time-operations

Run operations once after deployment - just like you do it with migrations!

6481.7M11](/packages/timokoerber-laravel-one-time-operations)[vormkracht10/laravel-mails

Laravel Mails can collect everything you might want to track about the mails that has been sent by your Laravel app.

24149.7k](/packages/vormkracht10-laravel-mails)[illuminate/process

The Illuminate Process package.

44699.5k65](/packages/illuminate-process)[muhammadsadeeq/laravel-activitylog-ui

A beautiful, modern UI for Spatie's Activity Log with advanced filtering, analytics, and real-time features.

17510.1k](/packages/muhammadsadeeq-laravel-activitylog-ui)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)