AnnouncementFeedPlugin Class Reference
[Plugins_generic_announcementFeed]

Annoucement Feed plugin class. More...

Inheritance diagram for AnnouncementFeedPlugin:

List of all members.

Public Member Functions
	callbackLoadCategory ($hookName, $args)
	getDescription ()
	getDisplayName ()
	getEnabled ()
	getManagementVerbs ()
	getName ()
	manage ($verb, $args)
	register ($category, $path)

---

Detailed Description

Annoucement Feed plugin class.

Definition at line 20 of file AnnouncementFeedPlugin.inc.php.

---

Member Function Documentation

AnnouncementFeedPlugin.callbackLoadCategory	(	$	hookName,
		$	args
	)

Register as a block and gateway plugin, even though this is a generic plugin. This will allow the plugin to behave as a block and gateway plugin

Parameters:

	$hookName	string
	$args	array

Definition at line 73 of file AnnouncementFeedPlugin.inc.php.

AnnouncementFeedPlugin.getDescription

(

)

Get the description of this plugin

Returns:

string

Reimplemented from Plugin.

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

References Locale.translate().

AnnouncementFeedPlugin.getDisplayName

(

)

Get the display name of this plugin

Returns:

string

Reimplemented from Plugin.

Definition at line 45 of file AnnouncementFeedPlugin.inc.php.

References Locale.translate().

AnnouncementFeedPlugin.getEnabled

(

)

Check whether or not this plugin is enabled

Returns:

boolean

Definition at line 61 of file AnnouncementFeedPlugin.inc.php.

References Request.getJournal().

Referenced by getManagementVerbs(), and register().

AnnouncementFeedPlugin.getManagementVerbs

(

)

Display verbs for the management interface.

Reimplemented from Plugin.

Definition at line 118 of file AnnouncementFeedPlugin.inc.php.

References getEnabled(), and Locale.translate().

AnnouncementFeedPlugin.getName

(

)

Get the symbolic name of this plugin

Returns:

string

Reimplemented from Plugin.

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

AnnouncementFeedPlugin.manage	(	$	verb,
		$	args
	)

Perform management functions

Reimplemented from Plugin.

Definition at line 141 of file AnnouncementFeedPlugin.inc.php.

References Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), and Plugin.updateSetting().

AnnouncementFeedPlugin.register	(	$	category,
		$	path
	)

Called as a plugin is registered to the registry. Subclasses over- riding this method should call the parent method first.

Parameters:

	$category	String Name of category plugin was registered to
	$path	String The path the plugin was found in

Returns:

boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

Reimplemented from Plugin.

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

References Plugin.addLocaleData(), getEnabled(), and HookRegistry.register().

---

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

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