Open Journal Systems  3.3.0
AnnouncementFeedGatewayPlugin Class Reference
Inheritance diagram for AnnouncementFeedGatewayPlugin:
GatewayPlugin Plugin

Public Member Functions

 __construct ($parentPlugin)
 
 fetch ($args, $request)
 
 getDescription ()
 
 getDisplayName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getName ()
 
 getPluginPath ()
 
- Public Member Functions inherited from GatewayPlugin
 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 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 announcement feed plugin.

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

Constructor & Destructor Documentation

◆ __construct()

AnnouncementFeedGatewayPlugin::__construct (   $parentPlugin)

Constructor

Parameters
$parentPluginAnnouncementFeedPlugin

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

Member Function Documentation

◆ fetch()

AnnouncementFeedGatewayPlugin::fetch (   $args,
  $request 
)

Handle fetch requests for this plugin.

Parameters
$argsarray
$requestPKPRequest

Reimplemented from GatewayPlugin.

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

References Plugin\$request, Core\getCurrentDate(), DAORegistry\getDAO(), and PKPTemplateManager\getManager().

◆ getDescription()

AnnouncementFeedGatewayPlugin::getDescription ( )

Get a description of this plugin.

Returns
string

Reimplemented from Plugin.

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

◆ getDisplayName()

AnnouncementFeedGatewayPlugin::getDisplayName ( )

Get the display name for this plugin.

Returns
string

Reimplemented from Plugin.

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

◆ getEnabled()

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 73 of file AnnouncementFeedGatewayPlugin.inc.php.

◆ getHideManagement()

AnnouncementFeedGatewayPlugin::getHideManagement ( )

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

Reimplemented from Plugin.

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

◆ getName()

AnnouncementFeedGatewayPlugin::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 36 of file AnnouncementFeedGatewayPlugin.inc.php.

◆ getPluginPath()

AnnouncementFeedGatewayPlugin::getPluginPath ( )

Override the builtin to get the correct plugin path.

Reimplemented from Plugin.

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

Field Documentation

◆ $_parentPlugin

AnnouncementFeedGatewayPlugin::$_parentPlugin
protected

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


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