Inheritance diagram for PLNPlugin:

Public Member Functions
	callbackDeleteJournalById ($hookName, $params)

	callbackLoadCategory ($hookName, $args)

	callbackLoadHandler ($hookName, $args)

	callbackNotificationContents ($hookName, $args)

	callbackParseCronTab ($hookName, $args)

	createJournalManagerNotification ($contextId, $notificationType)

	cronEnabled ()

	curlGet ($url, $headers=[])

	curlPostFile ($url, $filename)

	curlPutFile ($url, $filename)

	getActions ($request, $verb)

	getContextSpecificPluginSettingsFile ()

	getDescription ()

	getDisplayName ()

	getHandlerPath ()

	getInstallDataFile ()

	getInstallSchemaFile ()

	getManagementVerbs ()

	getServiceDocument ($contextId)

	getSetting ($journalId, $settingName)

	manage ($args, $request)

	newUUID ()

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

	registerDAOs ()

	setupComponentHandlers ($hookName, $params)

	tarInstalled ()

	termsAgreed ($journalId)

	zipInstalled ()

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)

	getCategory ()

	getCurrentVersion ()

	getDirName ()

	getEnabled ()

	getHideManagement ()

	getInstallControlledVocabFiles ()

	getInstallEmailTemplateDataFile ()

	getInstallEmailTemplatesFile ()

	getInstallFilterConfigFiles ()

	getInstallMigration ()

	getInstallSitePluginSettingsFile ()

	getLocaleFilename ($locale)

	getPluginPath ()

&	getRequest ()

	getSeq ()

	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 ()

	smartyPluginUrl ($params, $smarty)

	updateSchema ($hookName, $args)

	updateSetting ($contextId, $name, $value, $type=null)

Protected Member Functions
	_sendFile ($method, $url, $filename)

Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Additional Inherited Members
Data Fields inherited from Plugin
	$pluginCategory

	$pluginPath

	$request

Detailed Description

PLN plugin class.

Definition at line 72 of file PLNPlugin.inc.php.

Member Function Documentation

◆ _sendFile()

PLNPlugin::_sendFile	(	$method,
		$url,
		$filename
	)

protected

Transfer a file to a resource.

Parameters

$method	string PUT or POST
$url	string
$headers	array

Returns: array

Definition at line 618 of file PLNPlugin.inc.php.

References PKPApplication\get().

Referenced by curlPostFile(), and curlPutFile().

◆ callbackDeleteJournalById()

PLNPlugin::callbackDeleteJournalById	(	$hookName,
		$params
	)

Delete all plug-in data for a journal when the journal is deleted

Parameters

$hookName	string (JournalDAO::deleteJournalById)
$args	array (JournalDAO, journalId)

Returns: boolean false to continue processing subsequent hooks

Definition at line 255 of file PLNPlugin.inc.php.

References DAORegistry\getDAO().

◆ callbackLoadCategory()

PLNPlugin::callbackLoadCategory	(	$hookName,
		$args
	)

Register as a gateway plugin.

Parameters

$hookName	string
$args	array

Definition at line 235 of file PLNPlugin.inc.php.

References LazyLoadPlugin\getName().

◆ callbackLoadHandler()

PLNPlugin::callbackLoadHandler	(	$hookName,
		$args
	)

Callback for the LoadHandler hook

Definition at line 301 of file PLNPlugin.inc.php.

References $op, getHandlerPath(), and AppLocale\requireComponents().

◆ callbackNotificationContents()

PLNPlugin::callbackNotificationContents	(	$hookName,
		$args
	)

Hook registry function to provide notification messages

Parameters

$hookName	string (NotificationManager::getNotificationContents)
$args	array ($notification, $message)

Returns: boolean false to continue processing subsequent hooks

Definition at line 279 of file PLNPlugin.inc.php.

◆ callbackParseCronTab()

PLNPlugin::callbackParseCronTab	(	$hookName,
		$args
	)

Definition at line 267 of file PLNPlugin.inc.php.

References Plugin\getPluginPath().

◆ createJournalManagerNotification()

PLNPlugin::createJournalManagerNotification	(	$contextId,
		$notificationType
	)

Create notification for all journal managers

Parameters

$contextId	int
$notificationType	int

Definition at line 519 of file PLNPlugin.inc.php.

References DAORegistry\getDAO().

Referenced by getServiceDocument().

◆ cronEnabled()

PLNPlugin::cronEnabled ( )

Check if acron is enabled, or if the scheduled_tasks config var is set. The plugin needs to run periodically through one of those systems.

Returns: boolean

Definition at line 556 of file PLNPlugin.inc.php.

References $application, PKPApplication\getApplication(), and Config\getVar().

◆ curlGet()

PLNPlugin::curlGet	(	$url,
		$headers = `[]`
	)

Get resource

Parameters

$url	string
$headers	array

Returns: array

Definition at line 568 of file PLNPlugin.inc.php.

References PKPApplication\get().

Referenced by getServiceDocument().

◆ curlPostFile()

PLNPlugin::curlPostFile	(	$url,
		$filename
	)

Post a file to a resource

Parameters

$url	string
$headers	array

Returns: array

Definition at line 589 of file PLNPlugin.inc.php.

References _sendFile().

◆ curlPutFile()

PLNPlugin::curlPutFile	(	$url,
		$filename
	)

Put a file to a resource

Parameters

$url	string
$filename	string

Returns: array

Definition at line 599 of file PLNPlugin.inc.php.

References _sendFile().

◆ getActions()

PLNPlugin::getActions	(	$request,
		$verb
	)

Get a list of link actions for plugin management.

Parameters

request	PKPRequest
$actionArgs	array The list of action args to be included in request URLs.

Returns: array List of LinkActions

Reimplemented from Plugin.

Definition at line 117 of file PLNPlugin.inc.php.

References Plugin\$request, getDisplayName(), Plugin\getEnabled(), and LazyLoadPlugin\getName().

◆ getContextSpecificPluginSettingsFile()

PLNPlugin::getContextSpecificPluginSettingsFile ( )

Reimplemented from Plugin.

Definition at line 198 of file PLNPlugin.inc.php.

References Plugin\getPluginPath().

◆ getDescription()

PLNPlugin::getDescription ( )

Reimplemented from Plugin.

Definition at line 170 of file PLNPlugin.inc.php.

◆ getDisplayName()

PLNPlugin::getDisplayName ( )

Reimplemented from Plugin.

Definition at line 163 of file PLNPlugin.inc.php.

Referenced by getActions().

◆ getHandlerPath()

PLNPlugin::getHandlerPath ( )

Definition at line 191 of file PLNPlugin.inc.php.

References Plugin\getPluginPath().

Referenced by callbackLoadHandler().

◆ getInstallDataFile()

PLNPlugin::getInstallDataFile ( )

Reimplemented from Plugin.

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

References Plugin\getPluginPath().

◆ getInstallSchemaFile()

PLNPlugin::getInstallSchemaFile ( )

Reimplemented from Plugin.

Definition at line 177 of file PLNPlugin.inc.php.

References Plugin\getPluginPath().

◆ getManagementVerbs()

PLNPlugin::getManagementVerbs ( )

Definition at line 406 of file PLNPlugin.inc.php.

References Plugin\getEnabled().

◆ getServiceDocument()

PLNPlugin::getServiceDocument ( $contextId )

Request service document at specified URL

Parameters

$contextId int The journal id for the service document we wish to fetch

Returns: int The HTTP response status or FALSE for a network error.

Definition at line 439 of file PLNPlugin.inc.php.

References $application, Plugin\$request, createJournalManagerNotification(), curlGet(), PKPApplication\getApplication(), Application\getContextDAO(), getSetting(), and Plugin\updateSetting().

Referenced by manage().

◆ getSetting()

PLNPlugin::getSetting	(	$journalId,
		$settingName
	)

See also: PKPPlugin::getSetting()

Parameters

$journalId	int
$settingName	string

Reimplemented from Plugin.

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

References Config\getVar(), newUUID(), and Plugin\updateSetting().

Referenced by getServiceDocument(), and termsAgreed().

◆ manage()

PLNPlugin::manage	(	$args,
		$request
	)

Reimplemented from Plugin.

Definition at line 319 of file PLNPlugin.inc.php.

References Plugin\$request, DAORegistry\getDAO(), getServiceDocument(), AppLocale\requireComponents(), tarInstalled(), Plugin\updateSetting(), and zipInstalled().

◆ newUUID()

PLNPlugin::newUUID ( )

Create a new UUID

Returns: string

Definition at line 607 of file PLNPlugin.inc.php.

References PKPString\generateUUID().

Referenced by getSetting().

◆ register()

PLNPlugin::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

$category	String Name of category plugin was registered to
$path	String The path the plugin was found in
$mainContextId	integer 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 76 of file PLNPlugin.inc.php.

References Plugin\getEnabled(), HookRegistry\register(), and registerDAOs().

◆ registerDAOs()

PLNPlugin::registerDAOs ( )

Register this plugin's DAOs with the application

Definition at line 148 of file PLNPlugin.inc.php.

References DAORegistry\registerDAO().

Referenced by register().

◆ setupComponentHandlers()

PLNPlugin::setupComponentHandlers	(	$hookName,
		$params
	)

Permit requests to the static pages grid handler

Parameters

$hookName	string The name of the hook being invoked
$args	array The parameters to the invoked hook

Definition at line 100 of file PLNPlugin.inc.php.

◆ tarInstalled()

PLNPlugin::tarInstalled ( )

Check if the Archive_Tar extension is installed and available. BagIt requires it, and will not function without it.

Returns: boolean

Definition at line 545 of file PLNPlugin.inc.php.

Referenced by manage().

◆ termsAgreed()

PLNPlugin::termsAgreed ( $journalId )

Check to see whether the PLN's terms have been agreed to to append.

Parameters

$journalId int

Returns: boolean

Definition at line 421 of file PLNPlugin.inc.php.

References getSetting().

◆ zipInstalled()

PLNPlugin::zipInstalled ( )

Get whether zip archive support is present

Returns: boolean

Definition at line 535 of file PLNPlugin.inc.php.

Referenced by manage().

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

PLNPlugin.inc.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _sendFile()

◆ callbackDeleteJournalById()

◆ callbackLoadCategory()

◆ callbackLoadHandler()

◆ callbackNotificationContents()

◆ callbackParseCronTab()

◆ createJournalManagerNotification()

◆ cronEnabled()

◆ curlGet()

◆ curlPostFile()

◆ curlPutFile()

◆ getActions()

◆ getContextSpecificPluginSettingsFile()

◆ getDescription()

◆ getDisplayName()

◆ getHandlerPath()

◆ getInstallDataFile()

◆ getInstallSchemaFile()

◆ getManagementVerbs()

◆ getServiceDocument()

◆ getSetting()

◆ manage()

◆ newUUID()

◆ register()

◆ registerDAOs()

◆ setupComponentHandlers()

◆ tarInstalled()

◆ termsAgreed()

◆ zipInstalled()