heimrichhannot/contao-entity_filter

This module offers an input type for selecting one or more entities by comfortably 'clicking together' sql-like conditions.

1.1.3 2017-06-27 15:22 UTC

This package is not auto-updated.

Last update: 2024-10-26 20:48:23 UTC


README

This module offers an input type for selecting one or more entities by comfortably "clicking together" sql-like conditions.

alt text

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',
    )
);