Download the PHP package ahmedabdo/searchable without Composer

Searchable

Laravel Searchable is package that adds easy customizable searching and filtering ability to Laravel Eloquent Models

• Installation

• Searching

  • Usage Example

  • Search Columns

  • Custom Search

  • Overwrite Default Columns

  • Search Options

• Filtering

  • Usage Example

  • Filtering Columns

  • Filter Query String

  • Operators

  • Filter Modes

  • Filter Blade Script

  • Filter Helpers

  • Custom Operators

Installation

Searching

Search Usage Example

• Use the Abdo\Searchable\Searchable trait in your model.
• Define the columns you want to use for searching within the searchable array.
• Utilize the search scope to perform searches on the selected columns.

Search Columns

To define the search columns for a model, you can utilize a property decorated with the #[SearchColumns] attribute. This property will contain the default columns for searching the model, as well as any relations that need to be eagerly loaded. In case the #[SearchColumns] attribute is not set, the fillable columns will be used as a fallback.

Custom Search

If you wish to customize the search query for a specific column, you can create a method with the #[Search("colname")] attribute and craft a custom query specifically for that chosen column.

In the example above, the "time" column is stored in the database as a datetime value. If you wish to customize the search functionality for this column by adding a new orWhere statement for searching by day name, you can employ the #[SearchAdd("colname")] attribute.

By utilizing this attribute, you can incorporate the desired orWhere statement into the column search query, while still leveraging the existing search query provided by the package.

[!NOTE]
you may use as many searchAdd methods as you want.

If you have used either #[Search("colname")] or #[SearchAdd("colname")] to customize relation search, the builder instance passed to the custom method will be the builder for the relation model.

Overwrite Default Columns

If you want to override the columns defined in the model, you can pass the columns as a second parameter to the search scope.

Search Options

You can add an options array for columns

The column can have three options

Filtering

Filter Usage Example

Filtering Columns

By default, the columns used for filtering will be those defined in the property with the #[SearchColumns] attribute, combined with the columns specified in the fillable array. If you wish to use different columns as the default for filtering, you can define a property with the #[FilterColumns] attribute.

Filter Query String

The query string parameter names should match to the column names. If you are filtering a relation, you can use a colon : as a separator between the relation name and the column name, instead of a dot . The query string should follow to this pattern.

If you have used a parameter name that differs from the column name, you can pass both the column name and the filter value to the filter scope.

Operators

The operators allowed for filtering include any operator that can be sent to the where builder method, plus additional operators.

[!NOTE]
When using the "between" operator, two arguments must be provided, separated by a comma. If the from argument is not specified, the data will be filtered from negative infinity up to the to argument. Similarly, if the to argument is not provided, the data will be filtered up to positive infinity. For example: ?created_at=bt|,2010-01-01 retrieves all records created before January 1, 2010. Another example: ?created_at=bt|2010-01-01, retrieves all records created after January 1, 2010.

Filter Modes

there is two filter modes and mode and or mode the default mode is and
for changing the mode

Filter Blade Script

If you are utilizing regular Blade templates for the frontend, there is a simple JavaScript script available that simplifies the creation of filter forms. To include this script, add the @searchableScripts directive to your main layout.

then you can create filter form like by following steps

Usage:

• ensure that the form has class filter
• The input name should match the corresponding column name
• For relations, use a colon : as a separator ex: relation:columnName
• Set the desired filtering operator in the data-filter attribute, with the default being =
• use filterValue("queryParam") to get the filter value

Filter Helpers

filterParam

The "filterParam" helper function is utilized to extract the filter value from the query string. This helper function should be utilized when employing a blade filter form, especially if the input field name differs from the corresponding column name.

filterValue

The "filterValue" helper is employed to retrieve the value utilized for filtering in order to display this value in the input field, as an illustrative example.

Custom Operators

In case you need to define a custom operator for filtering and searching, there are two distinct approaches available.

[!NOTE] custom operator must start with sp_

In Config
To publish the configuration file, execute the following command

Once the configuration file has been published, you have the option to define your custom operators within the operators array.

In Service Provider

Additionally, you can register your custom operators within the boot method of one of the service providers.