interface_SD_Meeting_Tool_Display_Formats Interface Reference

Handles how a participant is displayed internally. More...

Inheritance diagram for interface_SD_Meeting_Tool_Display_Formats:

Public Member Functions
	sd_mt_delete_display_format ($format)
	sd_mt_display_participant ($participant, $format)
	sd_mt_get_all_display_formats ()
	sd_mt_get_display_format ($id)
	sd_mt_update_display_format ($format)

Detailed Description

Handles how a participant is displayed internally.

When a plugin needs to display a participant to the admin, it can ask the Display Format plugin to display the participant in the way the admin chooses.

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_Display_Formats::sd_mt_delete_display_format

(

$format

)

Delete a display format.

Wordpress

Filter

Parameters

SD_Meeting_Tool_Display_Format

$format

Display format to delete.

Implemented in SD_Meeting_Tool_Display_Formats.

interface_SD_Meeting_Tool_Display_Formats::sd_mt_display_participant	(		$participant,
			$format
	)

Displays a participant using a specific display format.

Wordpress

Filter

Parameters

SD_Meeting_Tool_Participant	$participant	Participant to display.
SD_Meeting_Tool_Display_Format	$format	Display format to use.

Returns

Participant as a string.

Implemented in SD_Meeting_Tool_Display_Formats.

interface_SD_Meeting_Tool_Display_Formats::sd_mt_get_all_display_formats

(

)

Returns an array of SD_Meeting_Tool_Display_Format that decide how to display the participants.

Wordpress

Filter

Returns

Array of SD_Meeting_Tool_Display_Format.

Implemented in SD_Meeting_Tool_Display_Formats.

interface_SD_Meeting_Tool_Display_Formats::sd_mt_get_display_format

(

$id

)

Returns a display format.

Wordpress

Filter

Parameters

int

$id

ID of a display format.

Returns

SD_Meeting_Tool_Display_Format or false.

Implemented in SD_Meeting_Tool_Display_Formats.

interface_SD_Meeting_Tool_Display_Formats::sd_mt_update_display_format

(

$format

)

Creates or updates a display format.

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

Wordpress

Filter

Parameters

SD_Meeting_Tool_Display_Format

$format

Display format to create or update.

Returns

The complete display format.

Implemented in SD_Meeting_Tool_Display_Formats.

---

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

• include/interface_SD_Meeting_Tool_Display_Formats.php