interface_SD_Meeting_Tool_Actions Interface Reference

Interface for Action plugins. More...

Inheritance diagram for interface_SD_Meeting_Tool_Actions:

Public Member Functions
	sd_mt_delete_action ($action)
	sd_mt_get_action ($action_id)
	sd_mt_get_all_actions ()
	sd_mt_get_action_item ($item_id)
	sd_mt_trigger_action ($trigger)
	sd_mt_update_action ($action)
	sd_mt_update_action_item ($item)

Detailed Description

Interface for Action plugins.

Provides storage and editing services for {SD_Meeting_Tool_Action}s and allows triggering / firing of said actions.

Other modules are encouraged to use the following filters:

filter: sd_mt_configure_action_item

Ask the plugins to configure an action item, as per SD_Meeting_Tool_Actions.

filter: sd_mt_get_action_item_types

Return a list all item types, which is an array of SD_Meeting_Tool_Action_Item. See SD_Meeting_Tool_Lists.

filter: sd_mt_get_action_item_description

Asks the plugins to properly describe the item. Used when the item has configured data and other plugins would like to tell the user more specifically what the item is going to to. See SD_Meeting_Tool_Lists.

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_Actions::sd_mt_delete_action

(

$action

)

Delete an action.

Wordpress

Filter

Parameters

SD_Meeting_Tool_Action

$action

SD_Meeting_Tool_Action object to delete.

Implemented in SD_Meeting_Tool_Actions.

interface_SD_Meeting_Tool_Actions::sd_mt_get_action

(

$action_id

)

Return an action.

Wordpress

Filter

Parameters

int

$action_id

Action ID to get.

Returns

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

Implemented in SD_Meeting_Tool_Actions.

interface_SD_Meeting_Tool_Actions::sd_mt_get_action_item

(

$item_id

)

Returns an action item.

Wordpress

Filter

Parameters

int

$item_id

Item ID to get.

Returns

Returned SD_Meeting_Tool_Action_Item item, else false if it doesn't exist.

Implemented in SD_Meeting_Tool_Actions.

interface_SD_Meeting_Tool_Actions::sd_mt_get_all_actions

(

)

Return a list of all available actions.

Wordpress

Filter

Returns

Array of SD_Meeting_Tool_Action.

Implemented in SD_Meeting_Tool_Actions.

interface_SD_Meeting_Tool_Actions::sd_mt_trigger_action

(

$trigger

)

Action: Triggers an action.

Given an SD_Meeting_Tool_Action_Trigger it will go through the action's items and call each item action.

Wordpress

Action

Parameters

SD_Meeting_Tool_Action_Trigger

$trigger

Action trigger to distribute amonst the plugins.

Implemented in SD_Meeting_Tool_Actions.

interface_SD_Meeting_Tool_Actions::sd_mt_update_action

(

$action

)

Creates or updates an action.

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

Wordpress

Filter

Parameters

SD_Meeting_Tool_Action

$action

Action to create or update.

Returns

The complete action.

Implemented in SD_Meeting_Tool_Actions.

interface_SD_Meeting_Tool_Actions::sd_mt_update_action_item

(

$item

)

Updates an action item.

If the item does not have an ID, a new item will be created and the ID will be returned.

Wordpress

Filter

Parameters

SD_Meeting_Tool_Action_Item

$item

The item to update.

Returns

Updated SD_Meeting_Tool_Action_Item item.

Implemented in SD_Meeting_Tool_Actions.

---

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

• include/interface_SD_Meeting_Tool_Actions.php