SD_Meeting_Tool_Speakers Class Reference

Extends agendas with speaker services. More...

Inheritance diagram for SD_Meeting_Tool_Speakers:

Public Member Functions
	__construct ()
	activate ()
	uninstall ()
	sd_mt_admin_menu ($menus)
	admin ()
	admin_overview ()
	admin_view_log ()
	admin_edit ()
	admin_manage ()
	admin_displays_overview ()
	admin_display_edit ()
	admin_display_shortcodes ()
	ajax_admin ()
	ajax_user ()
	sd_mt_create_speaker ($SD_Meeting_Tool_Speaker)
	sd_mt_create_speaker_list ($SD_Meeting_Tool_Speaker_List)
	sd_mt_delete_speaker ($SD_Meeting_Tool_Speaker)
	sd_mt_delete_speaker_display ($SD_Meeting_Tool_Speaker_Display)
	sd_mt_delete_speaker_list ($SD_Meeting_Tool_Speaker_List)
	sd_mt_empty_speaker_list ($SD_Meeting_Tool_Speaker_List)
	sd_mt_get_all_speaker_displays ()
	sd_mt_get_all_speaker_lists ()
	sd_mt_get_speaker ($SD_Meeting_Tool_Speaker_id)
	sd_mt_get_speaker_display ($SD_Meeting_Tool_Speaker_Display)
	sd_mt_get_speaker_list ($SD_Meeting_Tool_Speaker_List)
	sd_mt_get_speakers ($SD_Meeting_Tool_Speaker_List, $agenda_item_id)
	sd_mt_update_speaker_display ($SD_Meeting_Tool_Speaker_Display)
	sd_mt_update_speaker_list ($SD_Meeting_Tool_Speaker_List)
	sd_mt_update_speaker ($SD_Meeting_Tool_Speaker)
	get_speaker_list_log ($speaker_list)
	Returns the speaker list log of a speaker list.
	shortcode_current_speaker ($attr)
	shortcode_current_speaker_list ($attr)
	shortcode_speaker_list_log ($attr)
	Shows a speaker list log for a speaker list.

Private Member Functions
	delete_cache ($SD_MT_Speaker_List)
	time_to_seconds ($string)
	Converts a time string, [HH:]MM:SS, to a bunch of seconds.
	seconds_to_time ($seconds)
	sql_to_speaker ($sql)
	sql_to_speaker_display ($sql)
	sql_to_speaker_list ($sql)
	speakers_to_html ($speaker_list, $speakers)
	display_speakers ($options)
	display_speaker ($speaker_list, $speaker)
	get_admin_agenda ($speaker_list)
	get_preferred_display_format ($SD_Speaker_List, $list=null)
	get_sorted_speaker_list ($SD_Meeting_Tool_Speaker_List, $agenda_item_id, $SD_Meeting_Tool_Display_Format)
	display_current_speaker ($options)
	display_current_speaker_list ($options)
	display_current_speakers (&$options)
	display_logged_speakers ($options)
	write_cache ($SD_MT_Speaker_List)

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

Extends agendas with speaker services.

Speakers 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

• New: Restop: updates the time the user stopped speaking to the current time.
• New: Delete button follows current speaker.
• New: Added first setting: default speaker time.
• New: Able to change current agenda item using a button.
• New: Cursor keys can be used to select agenda item (after first selecting the select box).
• Fix: Speaker list can be editing by several people simultaneously.
• Fix: Size of management panel should be maximized without becoming too big.
• Fix: Speaker log shortcode no longer returns description of log.
• Fix: Prevent speaker from expanding when dragging.

Constructor & Destructor Documentation

SD_Meeting_Tool_Speakers::__construct

(

)

Member Function Documentation

SD_Meeting_Tool_Speakers::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_Speakers::admin

(

)

SD_Meeting_Tool_Speakers::admin_display_edit

(

)

SD_Meeting_Tool_Speakers::admin_display_shortcodes

(

)

SD_Meeting_Tool_Speakers::admin_displays_overview

(

)

SD_Meeting_Tool_Speakers::admin_edit

(

)

SD_Meeting_Tool_Speakers::admin_manage

(

)

SD_Meeting_Tool_Speakers::admin_overview

(

)

SD_Meeting_Tool_Speakers::admin_view_log

(

)

SD_Meeting_Tool_Speakers::ajax_admin

(

)

SD_Meeting_Tool_Speakers::ajax_user

(

)

SD_Meeting_Tool_Speakers::delete_cache (   $SD_MT_Speaker_List )

private

SD_Meeting_Tool_Speakers::display_current_speaker (   $options )

private

SD_Meeting_Tool_Speakers::display_current_speaker_list (   $options )

private

Returns the current speaker list as HTML.

The options are:

• display_format The ID of the display format to use.
• speaker_list The ID of the speaker list.

Parameters

$options

Array of options.

Returns

The speaker list as HTMl.

SD_Meeting_Tool_Speakers::display_current_speakers ( &  $options )

private

SD_Meeting_Tool_Speakers::display_logged_speakers (   $options )

private

SD_Meeting_Tool_Speakers::display_speaker (   $speaker_list,   $speaker  )

private

SD_Meeting_Tool_Speakers::display_speakers (   $options )

private

SD_Meeting_Tool_Speakers::get_admin_agenda (   $speaker_list )

private

SD_Meeting_Tool_Speakers::get_preferred_display_format (   $SD_Speaker_List,   $list = null  )

private

SD_Meeting_Tool_Speakers::get_sorted_speaker_list (   $SD_Meeting_Tool_Speaker_List,   $agenda_item_id,   $SD_Meeting_Tool_Display_Format  )

private

SD_Meeting_Tool_Speakers::get_speaker_list_log

(

$speaker_list

)

Returns the speaker list log of a speaker list.

Parameters

$speaker_list

The speaker list object, whose log we will display.

Returns

The speaker list log, in HTML format.

SD_Meeting_Tool_Speakers::sd_mt_admin_menu

(

$menus

)

SD_Meeting_Tool_Speakers::sd_mt_create_speaker

(

$SD_Meeting_Tool_Speaker

)

SD_Meeting_Tool_Speakers::sd_mt_create_speaker_list

(

$SD_Meeting_Tool_Speaker_List

)

SD_Meeting_Tool_Speakers::sd_mt_delete_speaker

(

$SD_Meeting_Tool_Speaker

)

SD_Meeting_Tool_Speakers::sd_mt_delete_speaker_display

(

$SD_Meeting_Tool_Speaker_Display

)

SD_Meeting_Tool_Speakers::sd_mt_delete_speaker_list

(

$SD_Meeting_Tool_Speaker_List

)

SD_Meeting_Tool_Speakers::sd_mt_empty_speaker_list

(

$SD_Meeting_Tool_Speaker_List

)

SD_Meeting_Tool_Speakers::sd_mt_get_all_speaker_displays

(

)

SD_Meeting_Tool_Speakers::sd_mt_get_all_speaker_lists

(

)

SD_Meeting_Tool_Speakers::sd_mt_get_speaker

(

$SD_Meeting_Tool_Speaker_id

)

SD_Meeting_Tool_Speakers::sd_mt_get_speaker_display

(

$SD_Meeting_Tool_Speaker_Display

)

SD_Meeting_Tool_Speakers::sd_mt_get_speaker_list

(

$SD_Meeting_Tool_Speaker_List

)

SD_Meeting_Tool_Speakers::sd_mt_get_speakers	(		$SD_Meeting_Tool_Speaker_List,
			$agenda_item_id
	)

SD_Meeting_Tool_Speakers::sd_mt_update_speaker

(

$SD_Meeting_Tool_Speaker

)

SD_Meeting_Tool_Speakers::sd_mt_update_speaker_display

(

$SD_Meeting_Tool_Speaker_Display

)

SD_Meeting_Tool_Speakers::sd_mt_update_speaker_list

(

$SD_Meeting_Tool_Speaker_List

)

SD_Meeting_Tool_Speakers::seconds_to_time (   $seconds )

private

Converts a bunch of seconds to a [HH:]MM:SS time.

Parameters

$seconds

Seconds to convert.

Returns

A string in [HH:]MM:SS format.

SD_Meeting_Tool_Speakers::shortcode_current_speaker

(

$attr

)

Shows the current speaker.

Attributes

• speaker_list Speaker list ID from which to get the current speaker. Required.
• autorefresh Refresh the agenda automatically using javacsript. Default "yes".

Parameters

$attr

Attributes array.

Returns

Speaker HTML string to display.

SD_Meeting_Tool_Speakers::shortcode_current_speaker_list

(

$attr

)

Shows the current speaker list.

Attributes

• speaker_list Speaker list ID from which to get the current speaker. Required.

Parameters

$attr

Attributes array.

Returns

Speaker list HTML string to display.

SD_Meeting_Tool_Speakers::shortcode_speaker_list_log

(

$attr

)

Shows a speaker list log for a speaker list.

Attributes

• speaker_list_id ID of speaker list.

Parameters

$attr

Attributes array.

Returns

Speaker list log HTML.

SD_Meeting_Tool_Speakers::speakers_to_html (   $speaker_list,   $speakers  )

private

Convert an array of speakers to html.

Parameters

$speaker_list	A speaker list object.
$speakers	Array of {SD_Meeting_Tool_Speaker}s to be convert into a html list.

Returns

A HTML string containing the list of speakers.

SD_Meeting_Tool_Speakers::sql_to_speaker (   $sql )

private

SD_Meeting_Tool_Speakers::sql_to_speaker_display (   $sql )

private

SD_Meeting_Tool_Speakers::sql_to_speaker_list (   $sql )

private

SD_Meeting_Tool_Speakers::time_to_seconds (   $string )

private

Converts a time string, [HH:]MM:SS, to a bunch of seconds.

If the time cannot be parse, a default value of 30 will be returned.

Parameters

string

$string

String to be converted.

Returns

Number of seconds in that string.

SD_Meeting_Tool_Speakers::uninstall

(

)

Overridable uninstall method.

Reimplemented from SD_Meeting_Tool_Base.

SD_Meeting_Tool_Speakers::write_cache (   $SD_MT_Speaker_List )

private

Write the current speaker list and speaker to the cache.

Parameters

$SD_MT_Speaker_List

Speaker list data to write.

---

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

• SD_Meeting_Tool_Speakers.php