Download the PHP package tobento/app-search without Composer
On this page you can find all versions of the php package tobento/app-search. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package app-search
App Search
The search app provides interfaces to search resources by filters. It comes with a default implementation and some basic filters.
Table of Contents
- Getting Started
- Requirements
- Documentation
- App
- Search Boot
- Search Config
- Basic Usage
- Searching
- Features
- Search Feature
- Search
- Adding Searchables
- Creating Searchables
- Adding Filters
- Creating Filters
- Searching
- Available Searchables
- Menu Searchable
- Repository Searchable
- Available Filters
- Clear Filter
- Input Filter
- Pagination Filter
- Searchables Filter
- Search Term Filter
- Select Filter
- Credits
Getting Started
Add the latest version of the app search project running this command.
Requirements
- PHP 8.0 or greater
Documentation
App
Check out the App Skeleton if you are using the skeleton.
You may also check out the App to learn more about the app in general.
Search Boot
The search boot does the following:
- migrates search config, view and asset files
- implements search interfaces based on the search config file
- boots features defined in config file
Search Config
The configuration for the search is located in the file at the default App Skeleton config location where you can configure the implemented search interfaces for your application and more.
Basic Usage
Searching
This example shows how a search process works in general. If you use the Search Feature, there is no need to implement anything.
Features
Search Feature
The search feature provides a simple search page where users can search the applications content. Furthermore, it provides a searchbar which you may render on all pages.
Check out the Search section on how to add searchables, filters and more as this feature uses the implemented search interfaces.
Config
In the config file you can configure this feature:
Search Page
The search page is available under the url.
Searchbar
In any view file, render the view named which will display a search input element:
Search
Adding Searchables
You may use and add the create your own searchables if desired.
Option 1
In the Search Config file you can configure your searchables:
Option 2
Use the App on method to add searchables only on demand:
Creating Searchables
You may create searchables for specific resources if you need full search and filter control.
Inspect the following files to see different searchable implementations:
Example
Adding Filters
Option 1
In the Search Config file you can configure your filters:
Option 2
Use the App on method to add filters only on demand:
Creating Filters
You may create custom filters to fit your requirements.
Inspect the following files to see different filter implementations:
Available Searchables
Menu Searchable
The searchable allows you to search the provided menu items using the Search Term Filter.
You may check out the Menu Service for more information.
Repository Searchable
The searchable allows you to search the provided repository using the Search Term Filter.
You may check out the Repository Service for more information.
Available Filters
Clear Filter
This filter displays a button to clear all filters.
Input Filter
This filter displays a HTML input element to filter searchables.
Pagination Filter
The main purpose of this filter is to use for the searchables pagination. Check out the Available Searchables class files to see its usage in action.
Searchables Filter
This filter displays checkboxes with the searchables to enable or disable for searching.
Search Term Filter
This filter displays a search input element to search for the provided search term.
Select Filter
This filter displays a HTML select element with options to filter searchables.
Credits
- Tobias Strub
- All Contributors
- Tabler Icons
All versions of app-search with dependencies
tobento/app Version ^1.0.7
tobento/app-http Version ^1.0
tobento/app-language Version ^1.0
tobento/app-migration Version ^1.0
tobento/app-translation Version ^1.0
tobento/app-view Version ^1.0
tobento/css-modal Version ^1.0
tobento/service-collection Version ^1.0
tobento/service-pagination Version ^1.0
tobento/service-menu Version ^1.0
tobento/service-repository Version ^1.0
tobento/service-support Version ^1.0
tobento/service-view Version ^1.0