\ListFilterForm
Synopsis
class ListFilterForm
extends Form
{
- // members
- private static array $allowed_actions = ;
- private static boolean $submit_use_button_tag = true;
- private static string $submit_classes = 'button btn';
- private static boolean $default_ajax_disabled = false;
- protected ListFilterSet $record = NULL;
- protected SS_List $resultList = NULL;
- protected ListFilterWidget $widget = NULL;
- protected boolean $processedOnBeforeRender = false;
- protected string $formMethod = 'GET';
- // methods
- public void __construct()
- public PaginatedList getResultList()
- public string TagStart()
- public string TagEnd()
- public boolean getHasSubmitted()
- public ListFilterForm setAJAXEnabled()
- public boolean getAJAXEnabled()
- public $this setWidget()
- public ListFilterWidget getWidget()
- public FieldList getFormFields()
- public FieldList getFormActions()
- public final FieldList getFormFieldsAll()
- public final FieldList getFormActionsAll()
- public void loadDataFrom()
- public FieldList fieldsByClass()
- public array getVarData()
- public ListFilterSet getRecord()
- public SiteTree getPage()
- public void processFilterBackendData()
- public array getTemplates()
- public HTMLText ShowingMessage()
- public HTMLText Listing()
- public array FilterBackendData()
- public HTMLText doWidget()
- public string Link()
- public HTMLText|string doGetListing()
- public array doGetListing_Ajax()
- public null doGetListing_Static()
- public void addRequirements()
- public void onBeforeRender()
- public final void onBeforeRenderAll()
- public void forTemplate()
Hierarchy
Extends
- Form
Tasks
Line | Task |
---|---|
351 | (Jake): ensure this doesn't affect AJAX performance unnecessarily. |
370 | (Jake): Add and test |
589 | (Jake): Perhaps change this to $this->getPage() |
Members
private
- $allowed_actions
- $default_ajax_disabled
—
boolean
Configure if the listing is loaded via AJAX or not. -
$submit_classes
Default classes applied to the FormAction
protected
- $formMethod — string
- $processedOnBeforeRender — boolean
- $record — ListFilterSet
- $resultList
—
SS_List
The current result set - $widget — ListFilterWidget
Methods
public
- __construct()
- FilterBackendData()
- Link()
- Listing() — For calling $ListFilterForm.Listing in a template.
- ShowingMessage() — For calling $ListFilterForm.ShowingMessage in a template.
- TagEnd() — Close form tag.
- TagStart() — Opening tag for the <form>. Useful for splitting various fields across the page into different locations. (ie. Left sidebar has filtering options, right listing side has a sort dropdown)
- addRequirements() — Add CSS/JavaScript requirements for form.
- doGetListing()
- doGetListing_Ajax()
- doGetListing_Static()
- doWidget() — For calling $ListFilterForm.Widget in a template.
- fieldsByClass() — Get a list of filter group fields by their class.
- forTemplate()
- getAJAXEnabled()
- getFormActions()
- getFormActionsAll()
- getFormFields()
- getFormFieldsAll() — Get the form fields for the form on this page. Can modify this FieldSet by using {@link updateFormFields()} on an {@link Extension} subclass which is applied to this form.
- getHasSubmitted() — Detect if the form has been submitted.
- getPage() — Get current page.
- getRecord()
- getResultList() — Get the underlying result set this form has filtered down
- getTemplates()
- getVarData() — If visiting the page with GET parameterss.
- getWidget()
- loadDataFrom() — {@inheritdoc}
- onBeforeRender()
- onBeforeRenderAll()
- processFilterBackendData() — Process the filter backend data before rendering the form.
- setAJAXEnabled()
- setWidget()