Open Journal Systems  3.3.0
DRIVERPlugin Class Reference
Inheritance diagram for DRIVERPlugin:
GenericPlugin LazyLoadPlugin Plugin

Public Member Functions

 addSet ($hookName, $params)
 
 getDescription ()
 
 getDisplayName ()
 
 insertDRIVERArticleTombstone ($hookName, $params)
 
 isDRIVERArticle ($journalId, $articleId)
 
 isDRIVERRecord ($row)
 
 recordsOrIdentifiers ($hookName, $params)
 
 register ($category, $path, $mainContextId=null)
 
 sets ($hookName, $params)
 
- Public Member Functions inherited from LazyLoadPlugin
 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 getEnabled ($contextId=null)
 
 getName ()
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getActions ($request, $actionArgs)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDirName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getPluginPath ()
 
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)
 
 smartyPluginUrl ($params, $smarty)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Additional Inherited Members

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

Detailed Description

DRIVER plugin class.

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

Member Function Documentation

◆ addSet()

DRIVERPlugin::addSet (   $hookName,
  $params 
)

Change OAI record or identifier to consider the DRIVER set

Definition at line 102 of file DRIVERPlugin.inc.php.

References isDRIVERRecord().

◆ getDescription()

DRIVERPlugin::getDescription ( )

Get a description of this plugin.

Returns
string

Reimplemented from Plugin.

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

◆ getDisplayName()

DRIVERPlugin::getDisplayName ( )

Get the display name for this plugin.

Returns
string

Reimplemented from Plugin.

Definition at line 49 of file DRIVERPlugin.inc.php.

◆ insertDRIVERArticleTombstone()

DRIVERPlugin::insertDRIVERArticleTombstone (   $hookName,
  $params 
)

Consider the DRIVER article in the article tombstone

Definition at line 115 of file DRIVERPlugin.inc.php.

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

◆ isDRIVERArticle()

DRIVERPlugin::isDRIVERArticle (   $journalId,
  $articleId 
)

Check if it's a DRIVER article.

Parameters
$row...
Returns
boolean

Definition at line 184 of file DRIVERPlugin.inc.php.

References PKPServices\get(), and DAORegistry\getDAO().

Referenced by insertDRIVERArticleTombstone().

◆ isDRIVERRecord()

DRIVERPlugin::isDRIVERRecord (   $row)

Check if it's a DRIVER record.

Parameters
$rowarray of database fields
Returns
boolean

Definition at line 130 of file DRIVERPlugin.inc.php.

References PKPServices\get(), and DAORegistry\getDAO().

Referenced by addSet().

◆ recordsOrIdentifiers()

DRIVERPlugin::recordsOrIdentifiers (   $hookName,
  $params 
)

Get DRIVER records or identifiers

Definition at line 73 of file DRIVERPlugin.inc.php.

References DAORegistry\getDAO().

◆ register()

DRIVERPlugin::register (   $category,
  $path,
  $mainContextId = null 
)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters
$categoryString Name of category plugin was registered to
$pathString The path the plugin was found in
$mainContextIdinteger To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.
Returns
boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from LazyLoadPlugin.

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

References Plugin\getEnabled(), HookRegistry\register(), and DAORegistry\registerDAO().

◆ sets()

DRIVERPlugin::sets (   $hookName,
  $params 
)

Add DRIVER set

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


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