Inheritance diagram for DOAJExportPlugin:

Public Member Functions
	depositXML ($objects, $context, $jsonString)

	display ($args, $request)

	executeExportAction ($request, $objects, $filter, $tab, $objectsFileNamePart, $noValidation=null)

	exportJSON ($object, $filter, $context)

	getDescription ()

	getDisplayName ()

	getExportActions ($context)

	getExportDeploymentClassName ()

	getName ()

	getPluginSettingsPrefix ()

	getSettingsFormClassName ()

	getSubmissionFilter ()

Public Member Functions inherited from PubObjectsExportPlugin
	_instantiateExportDeployment ($context)

	_instantiateSettingsForm ($context)

	_sendNotification ($user, $message, $notificationType, $param=null)

	addToSchema ($hookName, $params)

	callbackParseCronTab ($hookName, $args)

	executeCLI ($scriptName, &$args)

	executeCLICommand ($scriptName, $command, $context, $outputFile, $objects, $filter, $objectsFileNamePart)

	exportXML ($objects, $filter, $context, $noValidation=null)

	getAdditionalFieldNames ($hookName, $args)

	getArticleGalleys ($galleyIds)

	getCache ()

	getDepositStatusSettingName ()

	getDepositSuccessNotificationMessageKey ()

	getExportActionNames ()

	getIssueFilter ()

	getPublishedIssues ($issueIds, $context)

	getPublishedSubmissions ($submissionIds, $context)

	getRepresentationFilter ()

	getStatusActions ($pubObject)

	getStatusMessage ($request)

	getStatusNames ()

	getUnregisteredArticles ($context)

	isTestMode ($context)

	manage ($args, $request)

	markRegistered ($context, $objects)

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

	usage ($scriptName)

Public Member Functions inherited from ImportExportPlugin
	displayXMLValidationErrors ($errors, $xml)

	getActions ($request, $actionArgs)

	getExportFileName ($basePath, $objectsFileNamePart, $context, $extension='.xml')

	getExportPath ()

	isAllowedMethod ($url)

	isRelativePath ($url)

	pluginUrl ($params, $smarty)

Public Member Functions inherited from Plugin
	__construct ()

	_overridePluginTemplates ($hookName, $args)

	addLocaleData ($locale=null)

	getCanDisable ()

	getCanEnable ()

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

	smartyPluginUrl ($params, $smarty)

	updateSchema ($hookName, $args)

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

Additional Inherited Members
Data Fields inherited from PubObjectsExportPlugin
	$_cache

Data Fields inherited from ImportExportPlugin
	$_request

Data Fields inherited from Plugin
	$pluginCategory

	$pluginPath

	$request

Protected Member Functions inherited from PubObjectsExportPlugin
	_getDAOs ()

	_getObjectAdditionalSettings ()

	updateObject ($object)

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

Detailed Description

DOAJ export plugin.

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

Member Function Documentation

◆ depositXML()

DOAJExportPlugin::depositXML	(	$objects,
		$context,
		$jsonString
	)

See also: PubObjectsExportPlugin::depositXML()

Parameters

$objects	Submission
$context	Context
$jsonString	string Export JSON string

Returns: boolean Whether the JSON string has been registered

Reimplemented from PubObjectsExportPlugin.

Definition at line 108 of file DOAJExportPlugin.inc.php.

References PKPCurlHelper\getCurlObject(), PubObjectsExportPlugin\getDepositStatusSettingName(), Plugin\getSetting(), PubObjectsExportPlugin\isTestMode(), and PubObjectsExportPlugin\updateObject().

Referenced by executeExportAction().

◆ display()

DOAJExportPlugin::display	(	$args,
		$request
	)

Display the import/export plugin.

Parameters

$args	array
$request	PKPRequest

Reimplemented from PubObjectsExportPlugin.

Definition at line 51 of file DOAJExportPlugin.inc.php.

References Plugin\$request, PKPTemplateManager\getManager(), and Plugin\getTemplateResource().

◆ executeExportAction()

DOAJExportPlugin::executeExportAction	(	$request,
		$objects,
		$filter,
		$tab,
		$objectsFileNamePart,
		$noValidation = `null`
	)

Execute export action.

Parameters

$request	Request
$objects	array Array of objects to be exported
$filter	string Filter to use
$tab	string Tab to return to
$objectsFileNamePart	string Export file name part for this kind of objects
$noValidation	boolean If set to true no XML validation will be done

Reimplemented from PubObjectsExportPlugin.

Definition at line 150 of file DOAJExportPlugin.inc.php.

References Plugin\$request, PubObjectsExportPlugin\_sendNotification(), depositXML(), exportJSON(), and getName().

◆ exportJSON()

DOAJExportPlugin::exportJSON	(	$object,
		$filter,
		$context
	)

Get the JSON for selected objects.

Parameters

$object	Submission
$filter	string
$context	Context

Returns: string JSON variable.

Definition at line 201 of file DOAJExportPlugin.inc.php.

References PubObjectsExportPlugin\_instantiateExportDeployment(), and DAORegistry\getDAO().

Referenced by executeExportAction().

◆ getDescription()

DOAJExportPlugin::getDescription ( )

Get a description of this plugin.

Returns: string

Reimplemented from Plugin.

Definition at line 44 of file DOAJExportPlugin.inc.php.

◆ getDisplayName()

DOAJExportPlugin::getDisplayName ( )

Get the display name for this plugin.

Returns: string

Reimplemented from Plugin.

Definition at line 37 of file DOAJExportPlugin.inc.php.

◆ getExportActions()

DOAJExportPlugin::getExportActions ( $context )

Get actions.

Parameters

$context Context

Returns: array

Reimplemented from PubObjectsExportPlugin.

Definition at line 79 of file DOAJExportPlugin.inc.php.

References Plugin\getSetting().

◆ getExportDeploymentClassName()

DOAJExportPlugin::getExportDeploymentClassName ( )

Return the name of the plugin's deployment class.

Returns: string

Reimplemented from PubObjectsExportPlugin.

Definition at line 90 of file DOAJExportPlugin.inc.php.

◆ getName()

DOAJExportPlugin::getName ( )

Protected methods (may be overridden by custom plugins) Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).

Returns: string name of plugin

Reimplemented from Plugin.

Definition at line 30 of file DOAJExportPlugin.inc.php.

Referenced by executeExportAction().

◆ getPluginSettingsPrefix()

DOAJExportPlugin::getPluginSettingsPrefix ( )

Get the plugin ID used as plugin settings prefix.

Returns: string

Reimplemented from ImportExportPlugin.

Definition at line 65 of file DOAJExportPlugin.inc.php.

◆ getSettingsFormClassName()

DOAJExportPlugin::getSettingsFormClassName ( )

Definition at line 97 of file DOAJExportPlugin.inc.php.

◆ getSubmissionFilter()

DOAJExportPlugin::getSubmissionFilter ( )

Get the submission filter.

Returns: string|null

Reimplemented from PubObjectsExportPlugin.

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

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

DOAJExportPlugin.inc.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ depositXML()

◆ display()

◆ executeExportAction()

◆ exportJSON()

◆ getDescription()

◆ getDisplayName()

◆ getExportActions()

◆ getExportDeploymentClassName()

◆ getName()

◆ getPluginSettingsPrefix()

◆ getSettingsFormClassName()

◆ getSubmissionFilter()