interface_SD_Meeting_Tool_List_Sorts Interface Reference

Handle list sorting. More...

Inheritance diagram for interface_SD_Meeting_Tool_List_Sorts:

Public Member Functions
	sd_mt_delete_list_sort ($sort)
	sd_mt_get_all_list_sorts ()
	sd_mt_get_list_sort ($id)
	sd_mt_sort_list ($list, $sort)
	sd_mt_update_list_sort ($sort)

Detailed Description

Handle list sorting.

A list sort is as the name implies: a means of sorting lists of participants according to their fields.

A list sort plugin stores the various SD_Meeting_Tool_List_Sort and provides sorting services to the other plugins.

Author

Edward Plainview edwar.nosp@m.d.pl.nosp@m.ainvi.nosp@m.ew@s.nosp@m.verig.nosp@m.edem.nosp@m.okrat.nosp@m.erna.nosp@m..se

Member Function Documentation

interface_SD_Meeting_Tool_List_Sorts::sd_mt_delete_list_sort

(

$sort

)

Deletes a sort.

Wordpress

Filter

Parameters

SD_Meeting_Tool_List_Sort

$sort

List sort order to delete.

Implemented in SD_Meeting_Tool_List_Sorts.

interface_SD_Meeting_Tool_List_Sorts::sd_mt_get_all_list_sorts

(

)

Return an array of all available list sorts.

Wordpress

Filter

Returns

Array of SD_Meeting_Tool_List_Sort objects.

Implemented in SD_Meeting_Tool_List_Sorts.

interface_SD_Meeting_Tool_List_Sorts::sd_mt_get_list_sort

(

$id

)

Return a list sort.

Wordpress

Filter

Parameters

integer

$id

List sort order ID to get.

Returns

SD_Meeting_Tool_list_sort, or false if it doesn't exist.

Implemented in SD_Meeting_Tool_List_Sorts.

interface_SD_Meeting_Tool_List_Sorts::sd_mt_sort_list	(		$list,
			$sort
	)

Sorts a list given a specific List Sort.

Wordpress

Filter

Parameters

SD_Meeting_Tool_List	$list	List to sort.
SD_Meeting_Tool_List_Sort	$sort	$SD_Meeting_Tool_List_Sort

Returns

The sorted SD_Meeting_Tool_List.

Implemented in SD_Meeting_Tool_List_Sorts.

interface_SD_Meeting_Tool_List_Sorts::sd_mt_update_list_sort

(

$sort

)

Creates or updates a list sort.

If the ID is null, a new list sort will be created in the database.

Wordpress

Filter

Parameters

SD_Meeting_Tool_List_Sort

$sort

List sort to create or update.

Returns

The complete list sort.

Implemented in SD_Meeting_Tool_List_Sorts.

---

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

• include/interface_SD_Meeting_Tool_List_Sorts.php