AnnouncementFeedGatewayPlugin Class Reference
[Plugins_generic_announcementFeed]

Gateway component of announcement feed plugin. More...

Inheritance diagram for AnnouncementFeedGatewayPlugin:

List of all members.

Public Member Functions
	fetch ($args)
&	getAnnouncementFeedPlugin ()
	getDescription ()
	getDisplayName ()
	getEnabled ()
	getManagementVerbs ()
	getName ()
	getPluginPath ()
	getTemplatePath ()

---

Detailed Description

Gateway component of announcement feed plugin.

Definition at line 21 of file AnnouncementFeedGatewayPlugin.inc.php.

---

Member Function Documentation

AnnouncementFeedGatewayPlugin.fetch

(

$

args

)

Handle fetch requests for this plugin.

Reimplemented from GatewayPlugin.

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

References getAnnouncementFeedPlugin(), Request.getCompleteUrl(), Core.getCurrentDate(), DAORegistry.getDAO(), getEnabled(), Request.getJournal(), TemplateManager.getManager(), and getTemplatePath().

& AnnouncementFeedGatewayPlugin.getAnnouncementFeedPlugin

(

)

Get the web feed plugin

Returns:

object

Definition at line 43 of file AnnouncementFeedGatewayPlugin.inc.php.

References PluginRegistry.getPlugin().

Referenced by fetch(), getEnabled(), getPluginPath(), and getTemplatePath().

AnnouncementFeedGatewayPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented from GatewayPlugin.

Definition at line 35 of file AnnouncementFeedGatewayPlugin.inc.php.

References Locale.translate().

AnnouncementFeedGatewayPlugin.getDisplayName

(

)

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

Returns:

String

Reimplemented from GatewayPlugin.

Definition at line 31 of file AnnouncementFeedGatewayPlugin.inc.php.

References Locale.translate().

AnnouncementFeedGatewayPlugin.getEnabled

(

)

Get whether or not this plugin is enabled. (Should always return true, as the parent plugin will take care of loading this one when needed)

Returns:

boolean

Reimplemented from GatewayPlugin.

Definition at line 70 of file AnnouncementFeedGatewayPlugin.inc.php.

References getAnnouncementFeedPlugin().

Referenced by fetch().

AnnouncementFeedGatewayPlugin.getManagementVerbs

(

)

Get the management verbs for this plugin (override to none so that the parent plugin can handle this)

Returns:

array

Reimplemented from GatewayPlugin.

Definition at line 80 of file AnnouncementFeedGatewayPlugin.inc.php.

AnnouncementFeedGatewayPlugin.getName

(

)

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

Returns:

String name of plugin

Reimplemented from GatewayPlugin.

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

AnnouncementFeedGatewayPlugin.getPluginPath

(

)

Override the builtin to get the correct plugin path.

Reimplemented from Plugin.

Definition at line 51 of file AnnouncementFeedGatewayPlugin.inc.php.

References getAnnouncementFeedPlugin().

AnnouncementFeedGatewayPlugin.getTemplatePath

(

)

Override the builtin to get the correct template path.

Returns:

string

Reimplemented from Plugin.

Definition at line 60 of file AnnouncementFeedGatewayPlugin.inc.php.

References getAnnouncementFeedPlugin().

Referenced by fetch().

---

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

• plugins/generic/announcementFeed/AnnouncementFeedGatewayPlugin.inc.php