PHP Class DOIPubIdExportPlugin, ojs

Inheritance: extends ImportExportPlugin
Exibir arquivo Open project: pkp/ojs Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor
_instantiateSettingsForm ( $context ) : CrossRefSettingsForm Instantiate the settings form.
callbackParseCronTab ( $hookName, $args )
depositXML ( $objects, $context, $filename ) : boolean Deposit XML document.
display ( $args, $request )
executeExportAction ( $request, $objects, $filter, $tab, $objectsFileNamePart )
getAdditionalFieldNames ( $hookName, $args ) Hook callback that returns the "registeredDoi" setting's name prefixed with the plug-in's id to avoid name collisions.
getArticleGalleys ( $galleyIds, $context ) : array Get article galleys with a DOI assigned from gallley IDs.
getDepositSuccessNotificationMessageKey ( ) Get the locale key used in the notification for the successful deposit.
getPubIdDisplayType ( ) : string Get pub ID display type
getPubIdType ( ) : string Get pub ID type
getPublishedArticles ( $submissionIds, $context ) : array Get published articles with a DOI asigned from submission IDs.
getPublishedIssues ( $issueIds, $context ) : array Get published issues with a DOI asigned from issue IDs.
getUnregisteredArticles ( $context ) : array Retrieve all unregistered articles.
getUnregisteredGalleys ( $context ) : array Retrieve all unregistered articles.
getUnregisteredIssues ( $context ) : array Retrieve all unregistered issues.
markRegistered ( $context, $objects ) Mark selected submissions or issues as registered.
register ( $category, $path )
saveRegisteredDoi ( $context, $object, $testPrefix = '10.1234' ) Saving object's DOI to the object's "registeredDoi" setting.

Method Details

__construct() public method

Constructor
public __construct ( )

_instantiateSettingsForm() public method

Instantiate the settings form.
public _instantiateSettingsForm ( $context ) : CrossRefSettingsForm
$context Context
return CrossRefSettingsForm

callbackParseCronTab() public method

public callbackParseCronTab ( $hookName, $args )

depositXML() abstract public method

This must be implemented in the subclasses, if the action is supported.
abstract public depositXML ( $objects, $context, $filename ) : boolean
$objects mixed Array of or single published article, issue or galley
$context Context
$filename Export XML filename
return boolean Whether the XML document has been registered

display() public method

public display ( $args, $request )

executeExportAction() public method

public executeExportAction ( $request, $objects, $filter, $tab, $objectsFileNamePart )

getAdditionalFieldNames() public method

Hook callback that returns the "registeredDoi" setting's name prefixed with the plug-in's id to avoid name collisions.
See also: DAO::getAdditionalFieldNames()
public getAdditionalFieldNames ( $hookName, $args )
$hookName string
$args array

getArticleGalleys() public method

Get article galleys with a DOI assigned from gallley IDs.
public getArticleGalleys ( $galleyIds, $context ) : array
$galleyIds array
$context Context
return array

getDepositSuccessNotificationMessageKey() public method

Get the locale key used in the notification for the successful deposit.
public getDepositSuccessNotificationMessageKey ( )

getPubIdDisplayType() public method

Get pub ID display type
public getPubIdDisplayType ( ) : string
return string

getPubIdType() public method

Get pub ID type
public getPubIdType ( ) : string
return string

getPublishedArticles() public method

Get published articles with a DOI asigned from submission IDs.
public getPublishedArticles ( $submissionIds, $context ) : array
$submissionIds array
$context Context
return array

getPublishedIssues() public method

Get published issues with a DOI asigned from issue IDs.
public getPublishedIssues ( $issueIds, $context ) : array
$issueIds array
$context Context
return array

getUnregisteredArticles() public method

Retrieve all unregistered articles.
public getUnregisteredArticles ( $context ) : array
$context Context
return array

getUnregisteredGalleys() public method

Retrieve all unregistered articles.
public getUnregisteredGalleys ( $context ) : array
$context Context
return array

getUnregisteredIssues() public method

Retrieve all unregistered issues.
public getUnregisteredIssues ( $context ) : array
$context Context
return array

markRegistered() public method

Mark selected submissions or issues as registered.
public markRegistered ( $context, $objects )
$context Context
$objects array Array of published articles, issues or galleys

register() public method

public register ( $category, $path )

saveRegisteredDoi() public method

We prefix the setting with the plugin's id so that we do not get name clashes when several DOI registration plug-ins are active at the same time.
public saveRegisteredDoi ( $context, $object, $testPrefix = '10.1234' )
$context Context
$object Issue|PublishedArticle|ArticleGalley
$testPrefix string