CmsRssPlugin Class Reference

CmsRss plugin class. More...

Inheritance diagram for CmsRssPlugin:

List of all members.

Public Member Functions
&	getCmsPlugin ()
	getDescription ()
	getDisplayName ()
	getEnabled ()
	getManagementVerbs ()
	getName ()
	isCmsInstalled ()
	manage ($verb, $args)
	register ($category, $path)
	setBreadcrumbs ()
	setEnabled ($enabled)

---

Detailed Description

CmsRss plugin class.

Definition at line 18 of file CmsRssPlugin.inc.php.

---

Member Function Documentation

& CmsRssPlugin.getCmsPlugin

(

)

Get the CMS plugin object

Returns:

object

Definition at line 50 of file CmsRssPlugin.inc.php.

References PluginRegistry.getPlugin().

Referenced by isCmsInstalled().

CmsRssPlugin.getDescription

(

)

Get the description of this plugin

Returns:

string

Reimplemented from Plugin.

Definition at line 39 of file CmsRssPlugin.inc.php.

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

CmsRssPlugin.getDisplayName

(

)

Get the display name of this plugin

Returns:

string

Reimplemented from Plugin.

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

References Locale.translate().

CmsRssPlugin.getEnabled

(

)

Determine whether or not this plugin is enabled.

Definition at line 150 of file CmsRssPlugin.inc.php.

References Request.getJournal().

Referenced by getManagementVerbs(), and isCmsInstalled().

CmsRssPlugin.getManagementVerbs

(

)

Display verbs for the management interface.

Reimplemented from Plugin.

Definition at line 172 of file CmsRssPlugin.inc.php.

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

CmsRssPlugin.getName

(

)

Get the symbolic name of this plugin

Returns:

string

Reimplemented from Plugin.

Definition at line 23 of file CmsRssPlugin.inc.php.

CmsRssPlugin.isCmsInstalled

(

)

Determine whether or not the CMS plugin is properly installed

Definition at line 58 of file CmsRssPlugin.inc.php.

References getCmsPlugin(), and getEnabled().

Referenced by getDescription(), and getManagementVerbs().

CmsRssPlugin.manage	(	$	verb,
		$	args
	)

Perform management functions

Reimplemented from Plugin.

Definition at line 223 of file CmsRssPlugin.inc.php.

References Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), setBreadcrumbs(), and setEnabled().

CmsRssPlugin.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 63 of file CmsRssPlugin.inc.php.

References Plugin.addLocaleData(), Config.getVar(), and HookRegistry.register().

CmsRssPlugin.setBreadcrumbs

(

)

Set the page's breadcrumbs, given the plugin's tree of items to append.

Parameters:

$subclass

boolean

Definition at line 200 of file CmsRssPlugin.inc.php.

References TemplateManager.getManager(), and Request.url().

Referenced by manage().

CmsRssPlugin.setEnabled

(

$

enabled

)

Set the enabled/disabled state of this plugin

Definition at line 159 of file CmsRssPlugin.inc.php.

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

Referenced by manage().

---

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

• plugins/generic/cmsRSS/CmsRssPlugin.inc.php