Download the PHP package heimrichhannot/contao-filter-bundle without Composer
On this page you can find all versions of the php package heimrichhannot/contao-filter-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package contao-filter-bundle
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.
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 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
-
Install with composer or contao manager
- Update database
We recommend to use this bundle toghether with List Bundle and Reader Bundle.
Setup
- Create a filter configuration within System -> Filter & sort configuration
- Add filter elements to the filter config.
- 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:
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
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 Templates
All versions of contao-filter-bundle with dependencies
ausi/slug-generator Version ^1.0
codefog/contao-haste Version ^4.18 || ^5.0
contao/core-bundle Version ^4.9
heimrichhannot/contao-be_explanation-bundle Version ^2.3
heimrichhannot/contao-encore-contracts Version ^1.0
heimrichhannot/contao-entity-filter-bundle Version ^1.5
heimrichhannot/contao-fieldpalette-bundle Version >=0.6.12 <2.0-dev
heimrichhannot/contao-multi-column-editor-bundle Version ^2.0
heimrichhannot/contao-utils-bundle Version ^2.226
heimrichhannot/contao-twig-support-bundle Version ^0.2.16||^1.0
symfony/config Version ^4.4||^5.4
symfony/dependency-injection Version ^4.4||^5.4
symfony/event-dispatcher-contracts Version ^1.0 || ^2.0 || ^3.0
symfony/event-dispatcher Version ^4.4||^5.4
symfony/form Version ^4.4||^5.4
symfony/framework-bundle Version ^4.4||^5.4
symfony/http-foundation Version ^4.4||^5.4
symfony/http-kernel Version ^4.4||^5.4
symfony/intl Version ^4.4||^5.4
symfony/options-resolver Version ^4.4||^5.4
symfony/property-access Version ^4.4||^5.4
symfony/routing Version ^4.4||^5.4
symfony/translation Version ^4.4||^5.4
symfony/translation-contracts Version ^1.0 || ^2.0 || ^3.0
twig/extra-bundle Version ^3.0
twig/html-extra Version ^2.12||^3.0
twig/intl-extra Version ^2.12||^3.0
twig/string-extra Version ^2.12||^3.0
ext-pdo Version *