LeftAndMain_SearchFilter

interface LeftAndMain_SearchFilter (View source)

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

Methods

public
string
getChildrenMethod()

Method on Hierarchy objects which is used to traverse into children relationships.

public
string
getNumChildrenMethod()

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

public
bool
isPageIncluded(DataObject $page)

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

public
array|string
getPageClasses(DataObject $page)

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

Details

at line 2045
string getChildrenMethod()

Method on Hierarchy objects which is used to traverse into children relationships.

Return Value

string

at line 2052
string getNumChildrenMethod()

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

Return Value

string

at line 2062
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 2070
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