https://github.com/heimrichhannot/contao-filter-bundle
A generic filter for contao entities.
https://github.com/heimrichhannot/contao-filter-bundle
Last synced: 8 months ago
JSON representation
A generic filter for contao entities.
- Host: GitHub
- URL: https://github.com/heimrichhannot/contao-filter-bundle
- Owner: heimrichhannot
- License: lgpl-3.0
- Created: 2017-09-22T14:01:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T07:48:25.000Z (over 1 year ago)
- Last Synced: 2025-06-25T06:52:00.191Z (9 months ago)
- Language: PHP
- Size: 1.41 MB
- Stars: 4
- Watchers: 5
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Contao filter bundle
This bundle offers a generic filter module to use with arbitrary contao entities containing standard filter with initial filters and filter form types including [symfony form type representations](https://symfony.com/doc/current/reference/forms/types).
## Features
- Form handling using symfony form component
- Form rendering by using symfony form templates (currently available: bootstrap 3-5, foundation, div, table)
- Numerous [symfony form types](https://symfony.com/doc/4.4/reference/forms/types.html) supported
- Highly customizable and detached from tl_module table
- Label/Message handling using symfony translations
- Render form always empty (without user selection)
- Merge data over multiple filter forms with same form name
- Default Values (can be overwritten by user)
- Initial Values (can`t be overwritten by user)
- Stores filter data in session (no GET parameter URL remnant)
- Content element "Filter-Preselect" with optional redirect functionality to preselect filter on given page
- Content element "Filter-Hyperlink" with filter preselect feature
- Integrations:
- `codefog/contao-news_categories`
- `codefog/tags-bundle`
- `heimrichhannot/contao-categories-bundle`
- `heimrichhannot/contao-encore-bundle`
## Usage
### Install
1. Install with composer or contao manager
```
composer require heimrichhannot/contao-filter-bundle
```
1. Update database
We recommend to use this bundle toghether with [List Bundle](https://github.com/heimrichhannot/contao-list-bundle) and [Reader Bundle](https://github.com/heimrichhannot/contao-reader-bundle).
### Setup
1. Create a filter configuration within System -> Filter & sort configuration
1. Add filter elements to the filter config.
1. If you want to show the filter somewhere (for example to filter a list), create a filter/sort frontend module.
### Wrapper elements (DateRange, ProximitySearch, ...)
The Wrapper element has to be places **before** the fields associated with them.
For example the date_range wrapper element needs to be placed before the two associated date fields.
### Preselect
Filter Bundle Forms are not typical GET-Forms, so it is not possible to simple
copy the filter urls to share or bookmark
a filtered list. To overcome this limitation, preselect urls can be generated.
Preselect urls for the current filter can be found within template variabled,
you can create a preselect content element or get the url programmatically from
the FilterConfig.
#### Template variables
If a filter is set, the variable `preselectUrl` contains the preselection url for
the current filter. It's available in the filter templates and the frontend module
template.
You can for example create a copy preselect url button:
```twig
{% if preselectUrl is defined and preselectUrl is not empty %}
{% endif %}
```
#### Content element
You can use one of the following content elements:
- "Filter-Preselect" with optional redirect functionality to preselect filter on given page
- "Filter-Hyperlink" with filter preselect feature
#### FilterConfig
You can generate the preselect link from the FilterConfig instance
```php
filterManager->findById($this->objModel->filter);
return !empty($filterConfig->getData()) ? $filterConfig->getPreselectAction($filterConfig->getData(), true) : ''
}
}
```
## Inserttags
Insert tag | Arguments | Description
--- | --------- | -------
`{{filter_reset_url::*::*}}` | filter ID :: page ID or alias | This tag will be replaced with a reset filter link to an internal page with (replace 1st * with the filter ID, replace 2nd * with the page ID or alias)
## Further documentation
[Developer introductions](docs/developers.md)
[Templates](docs/templates.md)