SD_Meeting_Tool_Display_Formats Class Reference

Plugin providing participant display formats for internal (admin) use. More...

Inheritance diagram for SD_Meeting_Tool_Display_Formats:

Public Member Functions
	__construct ()
	activate ()
	uninstall ()
	sd_mt_admin_menu ($menus)
	admin ()
	admin_overview ()
	admin_edit ()
	sd_mt_delete_display_format ($format)
	sd_mt_display_participant ($SD_Meeting_Tool_Participant, $SD_Meeting_Tool_Display_Format)
	sd_mt_get_display_format ($display_format_id)
	sd_mt_get_all_display_formats ()
	sd_mt_update_display_format ($SD_Meeting_Tool_Display_Format)

Private Member Functions
	display_format_sql_to_object ($sql)
	parse_display_format_string ($string)
	parse_display_format_array ($array)

Private Attributes
	$cache = array()

Additional Inherited Members
Public Attributes inherited from SD_Meeting_Tool_Base
	$paths = array()
Protected Member Functions inherited from SD_Meeting_Tool_0
	cache_directory ()
	Return the cache directory for the plugin.
	cache_file ($id)
	Returns the name of the cache file for this session.
	cache_url ()
	Returns the complete URL to the cache directory.
	check_cache_directory ()
	Check whether the cache directory is OK.
Protected Attributes inherited from SD_Meeting_Tool_0
	$language_domain = 'SD_Meeting_Tool'

Detailed Description

Plugin providing participant display formats for internal (admin) use.

Display Format plugin for SD Meeting Tool.

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

Changelog

1.1

• Version bump.

Constructor & Destructor Documentation

SD_Meeting_Tool_Display_Formats::__construct

(

)

Member Function Documentation

SD_Meeting_Tool_Display_Formats::activate

(

)

Overridable activation function.

It's here in case plugins need a common activation method in the future.

Reimplemented from SD_Meeting_Tool_Base.

SD_Meeting_Tool_Display_Formats::admin

(

)

SD_Meeting_Tool_Display_Formats::admin_edit

(

)

SD_Meeting_Tool_Display_Formats::admin_overview

(

)

SD_Meeting_Tool_Display_Formats::display_format_sql_to_object (   $sql )

private

Convert a list row from SQL to an SD_Meeting_Tool_Display_Format.

Parameters

$sql	Row from the database as an array.

Returns

A complete SD_Meeting_Tool_Display_Format object.

SD_Meeting_Tool_Display_Formats::parse_display_format_array (   $array )

private

Converts a display format array back into a human readable string.

Parameters

$array

Array to convert to a string.

Returns

A human-readable string.

SD_Meeting_Tool_Display_Formats::parse_display_format_string (   $string )

private

Breaks up a string into an array of keywords / strings, dependant on the current participant fields.

Parameters

$string

String to parse

Returns

An array of arrays.

SD_Meeting_Tool_Display_Formats::sd_mt_admin_menu

(

$menus

)

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.

Implements interface_SD_Meeting_Tool_Display_Formats.

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.

Implements interface_SD_Meeting_Tool_Display_Formats.

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.

Implements interface_SD_Meeting_Tool_Display_Formats.

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.

Implements interface_SD_Meeting_Tool_Display_Formats.

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.

Implements interface_SD_Meeting_Tool_Display_Formats.

SD_Meeting_Tool_Display_Formats::uninstall

(

)

Overridable uninstall method.

Reimplemented from SD_Meeting_Tool_Base.

Member Data Documentation

SD_Meeting_Tool_Display_Formats::$cache = array()

private

---

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

• SD_Meeting_Tool_Display_Formats.php