1. interface
  2. SilverStripe
  3. \
  4. Admin
  5. \
  6. LeftAndMain_SearchFilter

LeftAndMain_SearchFilter

interface LeftAndMain_SearchFilter

Abstract interface for a class which may be used to filter the results displayed in a nested tree

Methods

string
getChildrenMethod()

Method on {@link Hierarchy} objects which is used to traverse into children relationships.

string
getNumChildrenMethod()

Method on {@link Hierarchy} objects which is used find the number of children for a parent page

bool
isPageIncluded(DataObject $page)

Returns TRUE if the given page should be included in the tree.

array|string
getPageClasses(DataObject $page)

Given a page, determine any additional CSS classes to apply to the tree node

Details

at line 19
string getChildrenMethod()

Method on {@link Hierarchy} objects which is used to traverse into children relationships.

Return Value

string

at line 26
string getNumChildrenMethod()

Method on {@link Hierarchy} objects which is used find the number of children for a parent page

Return Value

string

at line 36
bool isPageIncluded(DataObject $page)

Returns TRUE if the given page should be included in the tree.

Caution: Does NOT check view permissions on the page.

Parameters

DataObject $page

Return Value

bool

at line 44
array|string getPageClasses(DataObject $page)

Given a page, determine any additional CSS classes to apply to the tree node

Parameters

DataObject $page

Return Value

array|string