Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
ExternalFeedPlugin Class Reference
Inheritance diagram for ExternalFeedPlugin:
GenericPlugin

Public Member Functions

 callbackLoadCategory ($hookName, $args)
 
 displayHomepage ($hookName, $args)
 
 displayManagerLink ($hookName, $params)
 
 getDefaultStyleSheetFile ()
 
 getInstallSchemaFile ()
 
 getManagementVerbs ()
 
 getStyleSheetFile ()
 
 manage ($verb, $args, &$message, &$messageParams)
 
 register ($category, $path)
 
 setBreadcrumbs ($isSubclass=false)
 
 smartyPluginUrl ($params, &$smarty)
 
- Public Member Functions inherited from GenericPlugin
 GenericPlugin ()
 
 getManagementVerbs ($verbs=array())
 
 manage ($verb, $args, &$message, &$messageParams)
 
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 
 getName ()
 
 LazyLoadPlugin ()
 
 register ($category, $path)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 
 getNewJournalPluginSettingsFile ()
 
 getSetting ($journalId, $name)
 
 Plugin ()
 
 updateSetting ($journalId, $name, $value, $type=null)
 
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 
 addHelpData ($locale=null)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHelpMappingFilename ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
 getSeq ()
 
 getSettingMainContext ()
 
 getTemplatePath ()
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 
 PKPPlugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 

Detailed Description

ExternalFeed plugin class.

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

Member Function Documentation

ExternalFeedPlugin::callbackLoadCategory (   $hookName,
  $args 
)

Register as a block plugin, even though this is a generic plugin. This will allow the plugin to behave as a block plugin, i.e. to have layout tasks performed on it.

Parameters
$hookNamestring
$argsarray

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

References PKPPlugin\getName().

ExternalFeedPlugin::displayHomepage (   $hookName,
  $args 
)

Display external feed content on journal homepage.

Parameters
$hookNamestring
$argsarray

Definition at line 171 of file ExternalFeedPlugin.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), and PKPRequest\getRequestedPage().

ExternalFeedPlugin::displayManagerLink (   $hookName,
  $params 
)

Display management link for JM.

Parameters
$hookNamestring
$paramsarray

Definition at line 249 of file ExternalFeedPlugin.inc.php.

References smartyPluginUrl().

ExternalFeedPlugin::getDefaultStyleSheetFile ( )

Get the filename of the default CSS stylesheet for this plugin.

Definition at line 67 of file ExternalFeedPlugin.inc.php.

References PKPPlugin\getPluginPath().

Referenced by getStyleSheetFile().

ExternalFeedPlugin::getInstallSchemaFile ( )

Get the filename of the ADODB schema for this plugin.

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

References PKPPlugin\getPluginPath().

ExternalFeedPlugin::getManagementVerbs ( )

Display verbs for the management interface.

Definition at line 157 of file ExternalFeedPlugin.inc.php.

ExternalFeedPlugin::getStyleSheetFile ( )

Get the filename of the CSS stylesheet for this plugin.

Definition at line 74 of file ExternalFeedPlugin.inc.php.

References getDefaultStyleSheetFile(), Request\getJournal(), and Plugin\getSetting().

Referenced by register().

ExternalFeedPlugin::manage (   $verb,
  $args,
$message,
$messageParams 
)

Execute a management verb on this plugin

Parameters
$verbstring
$argsarray
$messagestring Result status message
$messageParamsarray Parameters for the message key
Returns
boolean

Definition at line 266 of file ExternalFeedPlugin.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), PKPPlugin\getName(), PKPHandler\getRangeInfo(), PKPPlugin\getTemplatePath(), PKPRequest\getUserVar(), PKPRequest\redirect(), and AppLocale\requireComponents().

ExternalFeedPlugin::register (   $category,
  $path 
)

Called as a plugin is registered to the registry

Parameters
$categoryString Name of category plugin was registered to
Returns
boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

Definition at line 25 of file ExternalFeedPlugin.inc.php.

References PKPRequest\getBaseUrl(), PKPPlugin\getName(), getStyleSheetFile(), HookRegistry\register(), and DAORegistry\registerDAO().

ExternalFeedPlugin::setBreadcrumbs (   $isSubclass = false)

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

Parameters
$subclassboolean

Definition at line 113 of file ExternalFeedPlugin.inc.php.

References PKPPlugin\getName(), and Request\url().

ExternalFeedPlugin::smartyPluginUrl (   $params,
$smarty 
)

Extend the {url ...} smarty to support externalFeed plugin.

Definition at line 91 of file ExternalFeedPlugin.inc.php.

References PKPPlugin\getCategory(), and PKPPlugin\getName().

Referenced by displayManagerLink().


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