Open Journal Systems  2.4.8
 All Classes Namespaces Functions Variables Groups Pages
DOAJPlugin Class Reference
Inheritance diagram for DOAJPlugin:
ImportExportPlugin Plugin PKPPlugin

Public Member Functions

 _displayArticleList ($templateMgr, $journal, $unregistered=false)
 
 _displayIssueList ($templateMgr, $journal)
 
 _exportJournal ($journal, $selectedObjects, $outputFile=null)
 
 _getAdditionalFieldNames ($hookName, $args)
 
 _getAllObjectTypes ()
 
 _getAllPublishedArticles ($journal)
 
 _getArticleIssue ($article, $journal)
 
 _markRegistered ($request, $selectedObjects)
 
 _prepareArticleData ($article, $journal)
 
 _process ($request, $journal)
 
 _retrieveArticlesByIssueId ($issueId)
 
 _sendNotification ($request, $message, $notificationType, $param=null)
 
 display ($args, $request)
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
 getTemplatePath ()
 
 register ($category, $path)
 
 registerDaoHook ($daoName)
 
- Public Member Functions inherited from ImportExportPlugin
 display (&$args, $request)
 
 executeCLI ($scriptName, &$args)
 
 getDescription ()
 
 getDisplayName ()
 
 getManagementVerbs ()
 
 getName ()
 
 ImportExportPlugin ()
 
 manage ($verb, $args, $message, $messageParams=null, $request=null)
 
 setBreadcrumbs ($crumbs=array(), $isSubclass=false)
 
 smartyPluginUrl ($params, &$smarty)
 
 usage ($scriptName)
 
- 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

DOAJ import/export plugin.

Definition at line 27 of file DOAJPlugin.inc.php.

Member Function Documentation

DOAJPlugin::_displayArticleList (   $templateMgr,
  $journal,
  $unregistered = false 
)

Display a list of articles for export.

Parameters
$templateMgrTemplateManager
$journalJournal
$unregisteredboolean

Definition at line 251 of file DOAJPlugin.inc.php.

References _getAllPublishedArticles(), PKPHandler\getRangeInfo(), getTemplatePath(), and ImportExportPlugin\setBreadcrumbs().

Referenced by display().

DOAJPlugin::_displayIssueList (   $templateMgr,
  $journal 
)

Display a list of issues for export.

Parameters
$templateMgrTemplateManager
$journalJournal

Definition at line 207 of file DOAJPlugin.inc.php.

References _retrieveArticlesByIssueId(), DAORegistry\getDAO(), PKPHandler\getRangeInfo(), getTemplatePath(), AppLocale\requireComponents(), and ImportExportPlugin\setBreadcrumbs().

Referenced by display().

DOAJPlugin::_exportJournal (   $journal,
  $selectedObjects,
  $outputFile = null 
)

Export a journal's content

Parameters
$journalobject
$selectedObjectsarray
$outputFilestring

Definition at line 126 of file DOAJPlugin.inc.php.

References XMLCustomWriter\createDocument(), and DOAJExportDom\generateJournalDom().

Referenced by _process().

DOAJPlugin::_getAdditionalFieldNames (   $hookName,
  $args 
)

Hook callback that returns the "daoj:registered" flag

Parameters
$hookNamestring
$argsarray

Definition at line 442 of file DOAJPlugin.inc.php.

DOAJPlugin::_getAllObjectTypes ( )

Return the object types supported by this plug-in.

Returns
array An array with object names and the corresponding export types.

Definition at line 383 of file DOAJPlugin.inc.php.

Referenced by _process().

DOAJPlugin::_getAllPublishedArticles (   $journal)

Retrieve all published articles.

Parameters
$journalJournal
Returns
array

Definition at line 283 of file DOAJPlugin.inc.php.

References _prepareArticleData(), and DAORegistry\getDAO().

Referenced by _displayArticleList().

DOAJPlugin::_getArticleIssue (   $article,
  $journal 
)

Return the issue of an article.

The issue will be cached if it is not yet cached.

Parameters
$articleArticle
$journalJournal
Returns
Issue

Definition at line 308 of file DOAJPlugin.inc.php.

References DAORegistry\getDAO().

Referenced by _prepareArticleData().

DOAJPlugin::_markRegistered (   $request,
  $selectedObjects 
)

Label articles (on article or issue level) with a 'doaj::registered' flag

Parameters
$requestPKPRequest
$selectedObjectsarray

Definition at line 153 of file DOAJPlugin.inc.php.

References _retrieveArticlesByIssueId(), _sendNotification(), DAORegistry\getDAO(), getName(), and registerDaoHook().

Referenced by _process().

DOAJPlugin::_prepareArticleData (   $article,
  $journal 
)

Identify the issue of the given article.

Parameters
$articlePublishedArticle
$journalJournal
Returns
array|null Return prepared article data or null if the article is not from a published issue.

Definition at line 357 of file DOAJPlugin.inc.php.

References _getArticleIssue().

Referenced by _getAllPublishedArticles().

DOAJPlugin::_process (   $request,
  $journal 
)

Process a request.

Parameters
$requestPKPRequest
$journalJournal

Definition at line 395 of file DOAJPlugin.inc.php.

References _exportJournal(), _getAllObjectTypes(), _markRegistered(), and getName().

Referenced by display().

DOAJPlugin::_retrieveArticlesByIssueId (   $issueId)

Retrieve all articles for the given issue and commit them to the cache.

Parameters
$issueIssue
Returns
array

Definition at line 331 of file DOAJPlugin.inc.php.

References DAORegistry\getDAO().

Referenced by _displayIssueList(), and _markRegistered().

DOAJPlugin::_sendNotification (   $request,
  $message,
  $notificationType,
  $param = null 
)

Add a notification.

Parameters
$requestRequest
$messagestring An i18n key.
$notificationTypeinteger One of the NOTIFICATION_TYPE_* constants.
$paramstring An additional parameter for the message.

Definition at line 456 of file DOAJPlugin.inc.php.

Referenced by _markRegistered().

DOAJPlugin::display (   $args,
  $request 
)

Display the plugin

Parameters
$argsarray

This supports the following actions:

  • unregistered, issues, articles: lists with exportable objects
  • markRegistered: mark a single object (article, issue) as registered
  • export: export a single object (article, issue)

Definition at line 96 of file DOAJPlugin.inc.php.

References _displayArticleList(), _displayIssueList(), _process(), getTemplatePath(), and ImportExportPlugin\setBreadcrumbs().

DOAJPlugin::getDescription ( )

Get the description of this plugin

Returns
string

Definition at line 83 of file DOAJPlugin.inc.php.

DOAJPlugin::getDisplayName ( )

Get the display name for this plugin

Returns
string

Definition at line 75 of file DOAJPlugin.inc.php.

DOAJPlugin::getName ( )

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

Returns
String name of plugin

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

Referenced by _markRegistered(), and _process().

DOAJPlugin::getTemplatePath ( )
DOAJPlugin::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 49 of file DOAJPlugin.inc.php.

References PKPPlugin\addLocaleData().

DOAJPlugin::registerDaoHook (   $daoName)

Register the hook that adds an additional field name to objects.

Parameters
$daoNamestring

Definition at line 433 of file DOAJPlugin.inc.php.

References HookRegistry\register().

Referenced by _markRegistered().


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