Elgg\Menus\FilterSortItems Class Reference

Add generic sort_by menu items to a filter menu. More...

Static Public Member Functions
static	registerTimeCreatedSorting (\Elgg\Event $event)
	Register sorting menu items based on the time_created attribute. More...
static	registerLastActionSorting (\Elgg\Event $event)
	Register sorting menu items based on the last_action attribute. More...
static	registerLastLoginSorting (\Elgg\Event $event)
	Register sorting menu items based on the last_login metadata. More...
static	registerNameSorting (\Elgg\Event $event)
	Register sorting menu items based on the name metadata. More...
static	registerTitleSorting (\Elgg\Event $event)
	Register sorting menu items based on the title metadata. More...
static	registerSortingDropdown (\Elgg\Event $event)
	Setup the sorting options in a dropdown menu, This should be used in combination with the other register function in this class. More...

Detailed Description

Add generic sort_by menu items to a filter menu.

Since

4.2

Definition at line 12 of file FilterSortItems.php.

Member Function Documentation

static Elgg\Menus\FilterSortItems::registerLastActionSorting ( \Elgg\Event  $event )

static

Register sorting menu items based on the last_action attribute.

Parameters

\Elgg\Event

$event

'register', 'menu:filter<:some filter_id>'

Returns

MenuItems|null

Definition at line 71 of file FilterSortItems.php.

static Elgg\Menus\FilterSortItems::registerLastLoginSorting ( \Elgg\Event  $event )

static

Register sorting menu items based on the last_login metadata.

Parameters

\Elgg\Event

$event

'register', 'menu:filter<:some filter_id>'

Returns

MenuItems|null

Definition at line 106 of file FilterSortItems.php.

static Elgg\Menus\FilterSortItems::registerNameSorting ( \Elgg\Event  $event )

static

Register sorting menu items based on the name metadata.

Parameters

\Elgg\Event

$event

'register', 'menu:filter<:some filter_id>'

Returns

MenuItems|null

Definition at line 140 of file FilterSortItems.php.

static Elgg\Menus\FilterSortItems::registerSortingDropdown ( \Elgg\Event  $event )

static

Setup the sorting options in a dropdown menu, This should be used in combination with the other register function in this class.

This function should have a very high priority to make sure not to interfere with other register events

Parameters

\Elgg\Event

$event

'register', 'menu:filter<:some filter_id>'

Returns

MenuItems|null

Definition at line 245 of file FilterSortItems.php.

static Elgg\Menus\FilterSortItems::registerTimeCreatedSorting ( \Elgg\Event  $event )

static

Register sorting menu items based on the time_created attribute.

Parameters

\Elgg\Event

$event

'register', 'menu:filter<:some filter_id>'

Returns

MenuItems|null

Definition at line 21 of file FilterSortItems.php.

static Elgg\Menus\FilterSortItems::registerTitleSorting ( \Elgg\Event  $event )

static

Register sorting menu items based on the title metadata.

Parameters

\Elgg\Event

$event

'register', 'menu:filter<:some filter_id>'

Returns

MenuItems|null

Definition at line 192 of file FilterSortItems.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/Menus/FilterSortItems.php