Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heimrichhannot/contao-entity_filter
https://github.com/heimrichhannot/contao-entity_filter
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/heimrichhannot/contao-entity_filter
- Owner: heimrichhannot
- Created: 2016-12-13T11:50:16.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-27T15:22:18.000Z (over 7 years ago)
- Last Synced: 2023-08-21T11:17:06.791Z (over 1 year ago)
- Language: PHP
- Size: 62.5 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contao Entity Filter
This module offers an input type for selecting one or more entities by comfortably "clicking together" sql-like conditions.
## Features
- "click together" conditions for filtering (aka selecting) arbitrary contao entities
- load existing filter conditions from other records
- display a result list of your filtering right in the contao record's edit view
### Technical instructions
This module offers 3 comfortable different functions for adding the widgets mentioned before right to your dca.
_Note: Of course, you can also copy these 3 functions and customize them if they don't suit your needs_
#### Add the entity filter widget to your dca:
```
\HeimrichHannot\EntityFilter\Backend\EntityFilter::addFilterToDca(
// the name of the field
'memberConditions',
// your dca
'tl_md_recipient_list',
// the table to be filtered
'tl_member'
);
```
#### Add a field for copying entity filters from other records:
```
\HeimrichHannot\EntityFilter\Backend\EntityFilter::addFilterCopierToDca(
// the name of the field
'filterCopier',
// your dca
'tl_recipient_list',
// the dca where the field values are situated you want to copy (usually the same as your dca)
'tl_recipient_list',
// the entity_filter field
'memberConditions',
// a custom options_callback -> if left out, array('HeimrichHannot\FieldValueCopier\Backend\FieldValueCopier', 'getOptions') is used
array('Namespace\SomeClass', 'getOptions')
);
```
#### Add a live-reloaded table for showing the results of your conditions:
```
\HeimrichHannot\EntityFilter\Backend\EntityFilter::addListToDca(
// the name of the field
'memberList',
// your dca
'tl_recipient_list',
// the entity_filter field
'memberConditions',
// the table being filtered
'tl_member',
// the header fields of the table
array(
'title',
'firstname',
'lastname',
'email',
)
);
```