WebFeedGatewayPlugin Class Reference

Inheritance diagram for WebFeedGatewayPlugin:

Public Member Functions
	__construct ($parentPlugin)
	fetch ($args, $request)
	getDescription ()
	getDisplayName ()
	getEnabled ($contextId=null)
	getHideManagement ()
	getName ()
	getPluginPath ()
Public Member Functions inherited from GatewayPlugin
	getCanDisable ()
	getCanEnable ()
	getCurrentContextId ()
	getEnabled ()
	getPolicies ($request)
	setEnabled ($enabled)
Public Member Functions inherited from Plugin
	__construct ()
	_overridePluginTemplates ($hookName, $args)
	addLocaleData ($locale=null)
	getActions ($request, $actionArgs)
	getCategory ()
	getContextSpecificPluginSettingsFile ()
	getCurrentVersion ()
	getDirName ()
	getInstallControlledVocabFiles ()
	getInstallDataFile ()
	getInstallEmailTemplateDataFile ()
	getInstallEmailTemplatesFile ()
	getInstallFilterConfigFiles ()
	getInstallMigration ()
	getInstallSchemaFile ()
	getInstallSitePluginSettingsFile ()
	getLocaleFilename ($locale)
&	getRequest ()
	getSeq ()
	getSetting ($contextId, $name)
	getTemplatePath ($inCore=false)
	getTemplateResource ($template=null, $inCore=false)
	import ($class)
	installContextSpecificSettings ($hookName, $args)
	installControlledVocabs ($hookName, $args)
	installData ($hookName, $args)
	installEmailTemplateData ($hookName, $args)
	installEmailTemplates ($hookName, $args)
	installFilters ($hookName, $args)
	installLocale ($hookName, $args)
	installSiteSettings ($hookName, $args)
	isSitePlugin ()
	manage ($args, $request)
	register ($category, $path, $mainContextId=null)
	smartyPluginUrl ($params, $smarty)
	updateSchema ($hookName, $args)
	updateSetting ($contextId, $name, $value, $type=null)

Protected Attributes
	$_parentPlugin

Additional Inherited Members
Data Fields inherited from Plugin
	$pluginCategory
	$pluginPath
	$request
Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

Gateway component of web feed plugin.

Definition at line 19 of file WebFeedGatewayPlugin.inc.php.

Constructor & Destructor Documentation

__construct()

WebFeedGatewayPlugin::__construct

(

$parentPlugin

)

Parameters

$parentPlugin

WebFeedPlugin

Definition at line 29 of file WebFeedGatewayPlugin.inc.php.

Member Function Documentation

fetch()

WebFeedGatewayPlugin::fetch	(		$args,
			$request
	)

Handle fetch requests for this plugin.

Parameters

$args	array Arguments.
$request	PKPRequest Request object.

Reimplemented from GatewayPlugin.

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

References Plugin\$request, PKPServices\get(), PKPApplication\get(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), and AppLocale\requireComponents().

getDescription()

WebFeedGatewayPlugin::getDescription

(

)

Get a description of this plugin.

Returns

string

Reimplemented from Plugin.

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

getDisplayName()

WebFeedGatewayPlugin::getDisplayName

(

)

Get the display name for this plugin.

Returns

string

Reimplemented from Plugin.

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

getEnabled()

WebFeedGatewayPlugin::getEnabled

(

$contextId = null

)

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)

Parameters

$contextId

int Context ID (optional)

Returns

boolean

Definition at line 78 of file WebFeedGatewayPlugin.inc.php.

getHideManagement()

WebFeedGatewayPlugin::getHideManagement

(

)

Hide this plugin from the management interface (it's subsidiary)

Reimplemented from Plugin.

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

getName()

WebFeedGatewayPlugin::getName

(

)

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

Returns

String name of plugin

Reimplemented from Plugin.

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

getPluginPath()

WebFeedGatewayPlugin::getPluginPath

(

)

Override the builtin to get the correct plugin path.

Returns

string

Reimplemented from Plugin.

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

Field Documentation

$_parentPlugin

WebFeedPlugin WebFeedGatewayPlugin::$_parentPlugin

protected

Parent plugin

Definition at line 24 of file WebFeedGatewayPlugin.inc.php.

---

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

• WebFeedGatewayPlugin.inc.php