GatewayPlugin Class Reference
[Plugins]

Abstract class for gateway plugins. More...

Inheritance diagram for GatewayPlugin:

Plugin AnnouncementFeedGatewayPlugin List of all members.

Public Member Functions

 fetch ($args)
 GatewayPlugin ()
 getDescription ()
 getDisplayName ()
 getEnabled ()
 getManagementVerbs ()
 getName ()
 manage ($verb, $args)
 setEnabled ($enabled)
 smartyPluginUrl ($params, &$smarty)

Detailed Description

Abstract class for gateway plugins.

Definition at line 17 of file GatewayPlugin.inc.php.


Member Function Documentation

GatewayPlugin.fetch ( args  ) 

Handle fetch requests for this plugin.

Reimplemented in AnnouncementFeedGatewayPlugin.

Definition at line 126 of file GatewayPlugin.inc.php.

GatewayPlugin.getDescription (  ) 

Get a description of the plugin.

Reimplemented in AnnouncementFeedGatewayPlugin.

Definition at line 46 of file GatewayPlugin.inc.php.

GatewayPlugin.getDisplayName (  ) 

Get the display name of this plugin. This name is displayed on the Conference Manager's plugin management page, for example.

Returns:
String

Reimplemented in AnnouncementFeedGatewayPlugin.

Definition at line 37 of file GatewayPlugin.inc.php.

GatewayPlugin.getEnabled (  ) 

Determine whether or not this plugin is enabled.

Definition at line 87 of file GatewayPlugin.inc.php.

References Request.getConference(), and Plugin.getSetting().

Referenced by AnnouncementFeedGatewayPlugin.fetch(), and getManagementVerbs().

GatewayPlugin.getManagementVerbs (  ) 

Display verbs for the management interface.

Definition at line 68 of file GatewayPlugin.inc.php.

References getEnabled().

GatewayPlugin.getName (  ) 

Get the name of this plugin. The name must be unique within its category.

Returns:
String name of plugin

Reimplemented in AnnouncementFeedGatewayPlugin.

Definition at line 27 of file GatewayPlugin.inc.php.

Referenced by smartyPluginUrl().

GatewayPlugin.manage ( verb,
args 
)

Perform management functions

Definition at line 113 of file GatewayPlugin.inc.php.

References setEnabled(), and smartyPluginUrl().

GatewayPlugin.setEnabled ( enabled  ) 

Set the enabled/disabled state of this plugin

Definition at line 96 of file GatewayPlugin.inc.php.

References Request.getConference(), and Plugin.updateSetting().

Referenced by manage().

GatewayPlugin.smartyPluginUrl ( params,
&$  smarty 
)

Extend the {url ...} smarty to support gateway plugins.

Definition at line 53 of file GatewayPlugin.inc.php.

References getName().

Referenced by manage().


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7