interface_SD_Meeting_Tool_Lists Interface Reference

Provides services for handling {SD_Meeting_Tool_List}s. More...

Inheritance diagram for interface_SD_Meeting_Tool_Lists:

Public Member Functions
	sd_mt_add_list_participant ($list, $participant)
	sd_mt_add_list_participants ($SD_Meeting_Tool_List, $SD_Meeting_Tool_Participants)
	sd_mt_clone_list ($list)
	sd_mt_delete_list ($list)
	sd_mt_get_all_lists ()
	sd_mt_get_list ($list_id)
	sd_mt_remove_list_participant ($list, $participant)
	sd_mt_remove_list_participants ($list)
	sd_mt_list_participants ($list)
	sd_mt_update_list ($list)

Detailed Description

Provides services for handling {SD_Meeting_Tool_List}s.

Lists are the basic communication builing blocks for inter-plugin communication and actions.

Participants are placed in lists and the lists are then used to decide: who gets to register, who has registered, who gets to vote, etc.

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_Lists::sd_mt_add_list_participant	(		$list,
			$participant
	)

Add a participant to a list.

Wordpress

Filter

Parameters

SD_Meeting_Tool_List	$list	List to add to.
SD_Meeting_Tool_Participant	$participant	A SD_Meeting_Tool_Participant or participant id (int) to add to the list.

Implemented in SD_Meeting_Tool_Lists.

interface_SD_Meeting_Tool_Lists::sd_mt_add_list_participants	(		$SD_Meeting_Tool_List,
			$SD_Meeting_Tool_Participants
	)

Adds an array of participants to a list.

Wordpress

Filter

Parameters

SD_Meeting_Tool_List	$SD_Meeting_Tool_List	List to add to.
array	$SD_Meeting_Tool_Participants	An array of SD_Meeting_Tool_Participant or participant ids (int) to add to the list.

Implemented in SD_Meeting_Tool_Lists.

interface_SD_Meeting_Tool_Lists::sd_mt_clone_list

(

$list

)

Clones a list completely.

Wordpress

Filter

Parameters

SD_Meeting_Tool_List

$list

An existing list to clone.

Returns

New list.

Implemented in SD_Meeting_Tool_Lists.

interface_SD_Meeting_Tool_Lists::sd_mt_delete_list

(

$list

)

Delete a list.

Wordpress

Filter

Parameters

SD_Meeting_Tool_List

$list

List object to delete.

Implemented in SD_Meeting_Tool_Lists.

interface_SD_Meeting_Tool_Lists::sd_mt_get_all_lists

(

)

Return an array of all available lists.

Wordpress

Filter

Returns

Array of SD_Meeting_Tool_List objects.

Implemented in SD_Meeting_Tool_Lists.

interface_SD_Meeting_Tool_Lists::sd_mt_get_list

(

$list_id

)

Return a list.

Wordpress

Filter

Parameters

int

$list_id

List ID to get.

Returns

Returned SD_Meeting_Tool_List, or false if it doesn't exist.

Implemented in SD_Meeting_Tool_Lists.

interface_SD_Meeting_Tool_Lists::sd_mt_list_participants

(

$list

)

Lists the participants in a list.

Assembles the list from all the includes and excludes.

Wordpress

Filter

Parameters

SD_Meeting_Tool_List

$list

List to assemble.

Returns

Array of SD_Meeting_Tool_Participant objects.

Implemented in SD_Meeting_Tool_Lists.

interface_SD_Meeting_Tool_Lists::sd_mt_remove_list_participant	(		$list,
			$participant
	)

Remove a participant from a list.

Wordpress

Filter

Parameters

SD_Meeting_Tool_List	$list	List to remove from.
SD_Meeting_Tool_Participant	$participant	Participant to remove.

Implemented in SD_Meeting_Tool_Lists.

interface_SD_Meeting_Tool_Lists::sd_mt_remove_list_participants

(

$list

)

Remove all participants from a list.

Wordpress

Filter

Parameters

SD_Meeting_Tool_List

$list

List to remove from.

Implemented in SD_Meeting_Tool_Lists.

interface_SD_Meeting_Tool_Lists::sd_mt_update_list

(

$list

)

Creates or updates a list.

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

Wordpress

Filter

Parameters

SD_Meeting_Tool_List

$list

List to create or update.

Returns

The complete list.

Implemented in SD_Meeting_Tool_Lists.

---

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

• include/interface_SD_Meeting_Tool_Lists.php