SD_Meeting_Tool_Agendas Class Reference

Provides agenda services for SD Meeting Tool. More...

Inheritance diagram for SD_Meeting_Tool_Agendas:

Public Member Functions
	__construct ()
	sd_mt_admin_menu ($menus)
	activate ()
	uninstall ()
	admin ()
	admin_overview ()
	admin_edit ()
	admin_edit_item ()
	ajax_admin ()
	ajax_user ()
	sd_mt_delete_agenda ($SD_Meeting_Tool_Agenda)
	sd_mt_get_agenda ($id)
	sd_mt_get_all_agendas ()
	sd_mt_update_agenda ($SD_Meeting_Tool_Agenda)
	sd_mt_update_agenda_item ($SD_Meeting_Tool_Agenda_Item)
	shortcode_show_agenda ($attr)
	Shows an agenda.
	shortcode_current_agenda_item ($attr)
	Shows the current agenda item.

Private Member Functions
	agenda_sql_to_object ($sql)
	Convert a row from SQL to an SD_Meeting_Tool_Agenda.
	agenda_item_sql_to_object ($sql)
	Convert a row from SQL to an SD_Meeting_Tool_Agenda_Item.
	delete_cache ($agenda)
	Delete the cache for this agenda.
	make_back_link_to_agenda_editor ()
	Makes a link back to the agenda editor.
	display_agenda ($options)
	Displays an agenda to the user.
	display_agenda_item ($options)
	write_cache ($SD_MT_Agenda)
	Write the current agenda and current_agenda_item to the cache.

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

Provides agenda services 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_Agendas::__construct

(

)

Member Function Documentation

SD_Meeting_Tool_Agendas::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_Agendas::admin

(

)

SD_Meeting_Tool_Agendas::admin_edit

(

)

Edit an agenda.

SD_Meeting_Tool_Agendas::admin_edit_item

(

)

SD_Meeting_Tool_Agendas::admin_overview

(

)

SD_Meeting_Tool_Agendas::agenda_item_sql_to_object (   $sql )

private

Convert a row from SQL to an SD_Meeting_Tool_Agenda_Item.

Parameters

array

$sql

Row from the database as an array.

Returns

An SD_Meeting_Tool_Agenda_Item object.

SD_Meeting_Tool_Agendas::agenda_sql_to_object (   $sql )

private

Convert a row from SQL to an SD_Meeting_Tool_Agenda.

Parameters

array

$sql

Row from the database as an array.

Returns

An SD_Meeting_Tool_Agenda object.

SD_Meeting_Tool_Agendas::ajax_admin

(

)

SD_Meeting_Tool_Agendas::ajax_user

(

)

SD_Meeting_Tool_Agendas::delete_cache (   $agenda )

private

Delete the cache for this agenda.

Parameters

SD_Meeting_Tool_Agenda

$agenda

Agenda whose cache must be deleted.

SD_Meeting_Tool_Agendas::display_agenda (   $options )

private

Displays an agenda to the user.

Options array:

• agenda The SD_Meeting_Tool_Agenda to display.

Parameters

array

$options

SD_Meeting_Tool_Agendas::display_agenda_item (   $options )

private

SD_Meeting_Tool_Agendas::make_back_link_to_agenda_editor ( )

private

Makes a link back to the agenda editor.

Returns

Back link string.

SD_Meeting_Tool_Agendas::sd_mt_admin_menu

(

$menus

)

SD_Meeting_Tool_Agendas::sd_mt_delete_agenda

(

$agenda

)

Delete an agenda.

Wordpress

Filter

Parameters

SD_Meeting_Tool_Agenda

$agenda

Agenda object to delete.

Implements interface_SD_Meeting_Tool_Agendas.

SD_Meeting_Tool_Agendas::sd_mt_get_agenda

(

$id

)

Return a specific agenda.

Wordpress

Filter

Parameters

int

$id

ID of agenda to get.

Returns

SD_Meeting_Tool_Agenda.

Implements interface_SD_Meeting_Tool_Agendas.

SD_Meeting_Tool_Agendas::sd_mt_get_all_agendas

(

)

Return a list of all agendas.

They are sorted by name.

Wordpress

Filter

Returns

Array of SD_Meeting_Tool_Agenda.

Implements interface_SD_Meeting_Tool_Agendas.

SD_Meeting_Tool_Agendas::sd_mt_update_agenda

(

$agenda

)

Creates or updates an agenda.

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

Wordpress

Filter

Parameters

SD_Meeting_Tool_Agenda

$agenda

Agenda to create or update.

Returns

The complete agenda.

Implements interface_SD_Meeting_Tool_Agendas.

SD_Meeting_Tool_Agendas::sd_mt_update_agenda_item

(

$item

)

Updates a specific agenda item.

Wordpress

Filter

Parameters

SD_Meeting_Tool_Agenda_Item

$item

The item to update.

Returns

Updated item.

Implements interface_SD_Meeting_Tool_Agendas.

SD_Meeting_Tool_Agendas::shortcode_current_agenda_item

(

$attr

)

Shows the current agenda item.

Attributes

• autorefresh Refresh the agenda item automatically using javacsript. Default "no".
• id Agenda ID. Required.
• link Show the agenda item link, or make the text linked. Default "no".
• number Put a number in front of the agenda item, according to its position in the agenda. Default "no".
• text Show the agenda item text. Default "no".

Parameters

array

$attr

Attributes array.

Returns

Agenda item HTML string to display.

SD_Meeting_Tool_Agendas::shortcode_show_agenda

(

$attr

)

Shows an agenda.

The agenda is shown as an ordered list. Multiple agendas can be shown at the same time.

Attributes

• autorefresh Refresh the agenda automatically using javacsript. Default "no".
• id Agenda ID. Required.

Parameters

array

$attr

Attributes array.

Returns

Agenda HTML string to display.

SD_Meeting_Tool_Agendas::uninstall

(

)

Overridable uninstall method.

Reimplemented from SD_Meeting_Tool_Base.

SD_Meeting_Tool_Agendas::write_cache (   $SD_MT_Agenda )

private

Write the current agenda and current_agenda_item to the cache.

Parameters

SD_Meeting_Tool_Agenda

$SD_MT_Agenda

Agenda data to write.

---

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

• SD_Meeting_Tool_Agendas.php