PHP Developer Guide
Other documentationsDemoCommunityGitHub
  • Forest Admin
  • Getting started
    • How it works
    • Quick start
      • Symfony
      • Laravel
    • Create your agent
    • Troubleshooting
    • Migrating legacy agents
      • Pre-requisites
      • Recommendations
      • Migration steps
      • Code transformations
        • API Charts
        • Live Queries
        • Smart Charts
        • Route overrides
        • Smart Actions
        • Smart Fields
        • Smart Relationships
        • Smart Segments
  • Data Sources
    • Getting Started
      • Collection selection
      • Naming conflicts
      • Query interface and Native Queries
        • Fields and projections
        • Filters
        • Aggregations
    • Provided data sources
      • Doctrine
      • Eloquent
        • Polymorphic relationships
    • Write your own
      • Translation strategy
        • Structure declaration
        • Capabilities declaration
        • Read implementation
        • Write implementation
        • Intra-data source Relationships
      • Contribute
  • Agent customization
    • Getting Started
    • Actions
      • Scope and context
      • Result builder
      • Static Forms
      • Dynamic Forms
      • Related data invalidation
    • Charts
      • Value
      • Objective
      • Percentage
      • Distribution
      • Leaderboard
      • Time-based
    • Fields
      • Add fields
      • Move, rename and remove fields
      • Override binary field mode
      • Override writing behavior
      • Override filtering behavior
      • Override sorting behavior
      • Validation
    • Hooks
      • Collection hook
      • Collection override
    • Pagination
    • Plugins
      • Write your own
    • Relationships
      • To a single record
      • To multiple records
      • Computed foreign keys
      • Under the hood
    • Search
    • Segments
  • Frontend customization
    • Smart Charts
      • Create a table chart
      • Create a bar chart
      • Create a cohort chart
      • Create a density map
    • Smart Views
      • Create a Map view
      • Create a Calendar view
      • Create a Shipping view
      • Create a Gallery view
      • Create a custom tinder-like validation view
      • Create a custom moderation view
  • Deploying to production
    • Environments
      • Deploy on AWS
      • Deploy on Heroku
      • Deploy on GCP
      • Deploy on Ubuntu
    • Development workflow
    • Using branches
    • Deploying your changes
    • Forest Admin CLI commands
      • init
      • login
      • branch
      • switch
      • set-origin
      • push
      • environments:create
      • environments:reset
      • deploy
  • Upgrade
    • Laravel agent upgrade to v3
  • Under the hood
    • .forestadmin-schema.json
    • Data Model
      • Typing
      • Relationships
    • Security & Privacy
Powered by GitBook
On this page
  • Search modes
  • Default behavior
  • Customization

Was this helpful?

  1. Agent customization

Search

PreviousUnder the hoodNextSegments

Last updated 3 months ago

Was this helpful?

This is the official documentation of the forestadmin/laravel-forestadmin v2+ and forestadmin/symfony-forestadmin PHP agents.

In Forest Admin, pages that show lists of records have a free-text search bar on top of them.

Search modes

2 search modes are supported: "normal" and "extended".

  • All searches start by being a "normal" search.

  • If the records users are looking for are not found, it is possible to trigger an "extended" search from the footer.

Default behavior

Natively, the search behavior is to seek value occurrences within columns of the Collection (in normal mode), and columns of the Collections of direct relations (in extended mode).

By default, Forest Admin will search only in specific columns, depending on their type:

Column Type
Default search behavior

Enum

Column is equal to the search string (case-insensitive).

Number

Column is equal to the search string (if the search string is numeric).

String

Column contains the search string (case-insensitive).

Uuid

Column is equal to the search string.

Other types

Column is ignored by the default search handler.

Customization

Alternatively, you may want to change how the search behaves in your admin panel.

For instance:

  • search only on the columns that are relevant to your use case.

  • use full-text indexes (i.e. Postgres tsquery and tsvector, Algolia, Elastic search, ...)

Making the search case-sensitive by default

In this example, we use the searchExtended condition to toggle between case-sensitive and insensitive searches.

use ForestAdmin\AgentPHP\DatasourceCustomizer\CollectionCustomizer;
use ForestAdmin\AgentPHP\DatasourceToolkit\Components\Query\ConditionTree\Operators;

$forestAgent->customizeCollection(
    'People',
    function (CollectionCustomizer $builder) {
        $builder->replaceSearch(
            function ($searchString, $extendedMode) {
           	    $operator = $extendedMode ? Operators::CONTAINS : Operators::ICONTAINS;

                return [
                	'aggregator' => 'Or',
                	'conditions' => [
                	    ['field' => 'firstName', 'operator' => $operator, 'value' => $searchString],
                	    ['field' => 'lastName', 'operator' => $operator, 'value' => $searchString],
                	]
                ];
            }
        );
    }
);

Changing searched columns

use ForestAdmin\AgentPHP\DatasourceCustomizer\CollectionCustomizer;
use ForestAdmin\AgentPHP\DatasourceToolkit\Components\Query\ConditionTree\Operators;

$forestAgent->customizeCollection(
    'Product',
    function (CollectionCustomizer $builder) {
        $builder->replaceSearch(
            function ($searchString, $extendedMode) {
                $productReferenceRegexp = '/^[a-f]{16}$/i';
                $barCodeRegexp = '/^[0-9]{10}$/i';

           	    // User is searching using a product reference.
           	    if (preg_match($productReferenceRegexp, $str)) {
           	        return ['field' => 'reference', 'operator' => Operators::EQUAL, 'value' => $searchString];
           	    }

           	    // User is search a barcode
           	    if (preg_match($barCodeRegexp, $str)) {
           	        return ['field' => 'barCode', 'operator' => Operators::EQUAL, 'value' => $searchString];
           	    }

           	    // User is searching something else, in "normal" mode, let's search in the product name only
           	    if (! $extendedMode) {
           	        return ['field' => 'name', 'operator' => Operators::CONTAINS, 'value' => $searchString];
           	    }

           	    // In "extended" mode, we search on name, description and brand name
                return [
                	'aggregator' => 'Or',
                	'conditions' => [
                	    ['field' => 'name', 'operator' => Operators::CONTAINS, 'value' => $searchString],
                	    ['field' => 'description', 'operator' => Operators::CONTAINS, 'value' => $searchString],
                	    ['field' => 'brand:name', 'operator' => Operators::EQUAL, 'value' => $searchString],
                	]
                ];
            }
        );
    }
);

Calling an external API

If your data is indexed using a SaaS, an external store, or a full-text index, you can call it in the search handler.

use ForestAdmin\AgentPHP\DatasourceCustomizer\CollectionCustomizer;
use ForestAdmin\AgentPHP\DatasourceToolkit\Components\Query\ConditionTree\Operators;
use Algolia\AlgoliaSearch\SearchClient;

$forestAgent->customizeCollection(
    'Product',
    function (CollectionCustomizer $builder) {
        $builder->replaceSearch(
            function ($searchString, $extendedMode) {
                $client = SearchClient::create("YourApplicationID", "YourWriteAPIKey");
                $index = $client->initIndex("test_index");
                $results = $index->search(
                    $searchString,
                    [
                        'attributesToRetrieve' => ['id'],
                        'hitsPerPage' => 50,
                    ]
                );

                return ['field' => 'id', 'operator' => Operators::IN, 'value' => array_map(fn ($hit) => $hit['id'], $results)];
            }
        );
    }
);

Disable the search

You can remove the search bar by disabling the search on a collection:

use ForestAdmin\AgentPHP\DatasourceCustomizer\CollectionCustomizer;

$forestAgent->customizeCollection(
    'Product',
    function (CollectionCustomizer $builder) {
        $builder->disableSearch();
    }
);

If you want to make a column searchable, you must define the right operator to allow the search to be performed. Please refer to the table to know which operator to define.

To customize the search behavior, you must define a handler that returns a .

By default, the search bar is displayed when at least one field supports the operator used for search based on its type ().

see this table
Operators to support
A search bar on the main Table View
Extended search call to action
ConditionTree