\ListFilterSet
Synopsis
class ListFilterSet
extends DataObject
{
- // members
- private static array $db = ;
- private static array $has_many = ;
- private static array $defaults = ;
- private static array $summary_fields = ;
- protected ListFilterForm $form = NULL;
- protected ArrayList $listFilters = NULL;
- protected $_cache_special_list = NULL;
- // methods
- public FieldList getCMSFields()
- public FieldList updateCMSFields()
- public ArrayList PagesAttachedTo()
- public string getListClass()
- public string getTitle()
- public string getListFiltersString()
- public ListFilterSet setCaller()
- public getCaller()
- public Controller getContentController()
- public $this getForm()
- public $this setForm()
- public ArrayList ListFiltersPersist()
- public SS_List BaseList()
- public void SpecialList()
- public SS_List FilteredList()
- public SS_List PaginatedFilteredList()
- public array FilterData()
- public SS_List FilterBackendData()
- public string CMSEditLink()
- public void applyFilterToList()
- public array unNamespaceFilterFields()
Hierarchy
Extends
- DataObject
Members
private
- $db
- $defaults
- $has_many
- $summary_fields
protected
-
$_cache_special_list
If the ListClassName is set to a 'special list' type, use that list. - $form — ListFilterForm
- $listFilters
—
ArrayList
Store each of the 'ListFilters()' in an ArrayList to keep their modified state persistent.
Methods
public
- BaseList()
- CMSEditLink() — Generates a link to edit this page in the CMS.
- FilterBackendData() — Runs each filter group seperately and stores any backend filter data that may exist.
- FilterData() — When generating map pins / widget data, this function will add additional data so that the pins can be filtered in JavaScript.
- FilteredList() — Runs filters over a base SS_List based on user-input.
- ListFiltersPersist() — Get all the list filters, but only once. This ensures they keep state across execution.
- PagesAttachedTo() — Return a list of the pages this list filter is used on.
- PaginatedFilteredList()
- SpecialList()
- applyFilterToList() — Apply filters to any given list based on user-input
- getCMSFields()
- getCaller()
- getContentController() — Get the current content controller
- getForm()
- getListClass()
- getListFiltersString()
- getTitle()
- setCaller()
- setForm()
- unNamespaceFilterFields()
- updateCMSFields()