PluginRegistry Class Reference
[Plugins]

Registry class for managing plugins. More...

List of all members.

Public Member Functions
&	getAllPlugins ()
	getCategories ()
&	getPlugin ($category, $name)
&	getPlugins ($category=null)
&	loadAllPlugins ()
&	loadCategory ($category, $forceLoad=false)
&	loadPlugin ($category, $pathName)
	register ($category, &$plugin, $path)

---

Detailed Description

Registry class for managing plugins.

See also:

Plugin

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

---

Member Function Documentation

& PluginRegistry.getAllPlugins

(

)

Get all plugins in a single array.

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

References getPlugins().

Referenced by loadAllPlugins().

PluginRegistry.getCategories

(

)

Get a list of the various plugin categories available.

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

References HookRegistry.call().

Referenced by loadAllPlugins(), and PluginHandler.plugins().

& PluginRegistry.getPlugin	(	$	category,
		$	name
	)

Get a plugin by name.

Parameters:

	$category	String category name
	$name	String plugin name

Definition at line 77 of file PluginRegistry.inc.php.

References getPlugins().

Referenced by ArticleXMLGalleyDAO._getXMLGalleyFromId(), ThesisDAO._returnThesisFromRow(), ArticleXMLGalley._xsltCacheMiss(), ArticleXMLGalleyDAO.appendXMLGalleys(), ThesisForm.display(), StudentThesisForm.display(), importExport.execute(), ThesisForm.execute(), StudentThesisForm.execute(), ThesisDAO.getActiveThesesByJournalId(), AnnouncementFeedGatewayPlugin.getAnnouncementFeedPlugin(), AnnouncementFeedBlockPlugin.getAnnouncementFeedPlugin(), CmsRssPlugin.getCmsPlugin(), CmsBlockPlugin.getCmsPlugin(), ArticleXMLGalley.getHTMLContents(), OpenAdsBlockPlugin.getOpenAdsPlugin(), ThesisFeedGatewayPlugin.getThesisFeedPlugin(), ThesisFeedBlockPlugin.getThesisFeedPlugin(), ThesisFeedGatewayPlugin.getThesisPlugin(), ThesisFeedBlockPlugin.getThesisPlugin(), WebFeedGatewayPlugin.getWebFeedPlugin(), WebFeedBlockPlugin.getWebFeedPlugin(), ThesisHandler.index(), ArticleXMLGalleyDAO.insertXMLGalleys(), ThesisDAO.isThesisActive(), ThesisHandler.save(), CmsPlugin.setEnabled(), StudentThesisForm.StudentThesisForm(), ThesisHandler.submit(), ThesisForm.ThesisForm(), ThesisHandler.view(), and ArticleXMLGalley.viewFileContents().

& PluginRegistry.getPlugins

(

$

category = null

)

Return all plugins in the given category as an array, or, if the category is not specified, all plugins in an associative array of arrays by category.

Parameters:

$category

String the name of the category to retrieve

Definition at line 30 of file PluginRegistry.inc.php.

References Registry.get().

Referenced by JournalSetupStep5Form.display(), getAllPlugins(), getPlugin(), loadCategory(), and register().

& PluginRegistry.loadAllPlugins

(

)

Load all plugins in the system and return them in a single array.

Definition at line 170 of file PluginRegistry.inc.php.

References getAllPlugins(), getCategories(), and loadCategory().

Referenced by localeCheck.execute(), Installer.Installer(), and Locale.testLocale().

& PluginRegistry.loadCategory	(	$	category,
		$	forceLoad = false
	)

Load all plugins for a given category.

Parameters:

	$category	String The name of the category to load
	$forceLoad	boolean Whether or not to force loading of the category (since if e.g. a single plugin is already registered, the current set will be returned rather than attempting to load others)

Definition at line 90 of file PluginRegistry.inc.php.

References HookRegistry.call(), getPlugins(), and register().

Referenced by AuthSourcesHandler.auth(), AuthSourceDAO.AuthSourceDAO(), RTHandler.captureCite(), JournalSetupStep5Form.display(), importExport.execute(), JournalSetupStep5Form.execute(), OJSPaymentManager.getPaymentPlugin(), loadAllPlugins(), Validation.login(), PayMethodSettingsForm.PayMethodSettingsForm(), PaymentHandler.plugin(), PluginHandler.plugin(), GatewayHandler.plugin(), PluginHandler.plugins(), StatisticsHandler.statistics(), and AdminJournalHandler.updateJournal().

& PluginRegistry.loadPlugin	(	$	category,
		$	pathName
	)

Load a specific plugin from a category by path name. Similar to loadCategory, except that it only loads a single plugin within a category rather than loading all.

Parameters:

	$category	string
	$pathName	string

Returns:

object

Definition at line 135 of file PluginRegistry.inc.php.

References register().

Referenced by TemplateManager.TemplateManager().

PluginRegistry.register	(	$	category,
		&$	plugin,
		$	path
	)

Register a plugin with the registry in the given category.

Parameters:

	$category	String the name of the category to extend
	$plugin	The instantiated plugin to add
	$path	The path the plugin was found in

Returns:

boolean True IFF the plugin was registered successfully

Definition at line 55 of file PluginRegistry.inc.php.

References getPlugins(), and Registry.set().

Referenced by loadCategory(), and loadPlugin().

---

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

• classes/plugins/PluginRegistry.inc.php