PHP Class PubObjectsExportPlugin, ojs

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

Public Properties

Property Type Description
$_cache PubObjectCache

Public Methods

Method Description
__construct ( ) Constructor
_instantiateExportDeployment ( $context ) : PKPImportExportDeployment Instantiate the export deployment.
_sendNotification ( $user, $message, $notificationType, $param = null ) Add a notification.
display ( $args, $request )
executeCLI ( $scriptName, &$args )
executeCLICommand ( $scriptName, $command, $context, $outputFile, $objects, $filter, $objectsFileNamePart ) Execute the CLI command
executeExportAction ( $request, $objects, $filter, $tab, $objectsFileNamePart ) Execute export action.
exportXML ( $objects, $filter, $context ) : string Get the XML for selected objects.
getAdditionalFieldNames ( $hookName, $args ) Hook callback that returns the setting's name prefixed with the plug-in's id to avoid name collisions.
getArticleGalleys ( $galleyIds, $context ) : array Get article galleys from gallley IDs.
getCache ( ) : PubObjectCache Get the plugin cache
getDepositStatusSettingName ( ) : string Get deposit status setting name.
getExportActionNames ( ) : array Get action names.
getExportActions ( $context ) : array Get actions.
getExportDeploymentClassName ( ) : string Return the name of the plugin's deployment class.
getIssueFilter ( ) : string | null Get the issue filter.
getPublishedArticles ( $submissionIds, $context ) : array Get published articles from submission IDs.
getPublishedIssues ( $issueIds, $context ) : array Get published issues from issue IDs.
getRepresentationFilter ( ) : string | null Get the representation filter.
getStatusActions ( $pubObject ) : array Get status actions for the display to the user, i.e. links to a web site with more information about the status.
getStatusNames ( ) : array Get status names for the filter search option.
getSubmissionFilter ( ) : string | null Get the submission filter.
getTemplatePath ( $inCore = false )
isTestMode ( $context ) : boolean Check whether we are in test mode.
manage ( $args, $request )
markRegistered ( $context, $objects ) Mark selected submissions or issues as registered.
register ( $category, $path )
registerDaoHook ( $daoName ) Register the hook that adds an additional field name to objects.
updateObject ( $object ) Update the given object.
usage ( $scriptName )

Method Details

__construct() public method

Constructor
public __construct ( )

_instantiateExportDeployment() public method

Instantiate the export deployment.
public _instantiateExportDeployment ( $context ) : PKPImportExportDeployment
$context Context
return PKPImportExportDeployment

_sendNotification() public method

Add a notification.
public _sendNotification ( $user, $message, $notificationType, $param = null )
$user User
$message string An i18n key.
$notificationType integer One of the NOTIFICATION_TYPE_* constants.
$param string An additional parameter for the message.

display() public method

public display ( $args, $request )

executeCLI() public method

public executeCLI ( $scriptName, &$args )

executeCLICommand() public method

Execute the CLI command
public executeCLICommand ( $scriptName, $command, $context, $outputFile, $objects, $filter, $objectsFileNamePart )
$scriptName The name of the command-line script (displayed as usage info)
$command string (export or register)
$context Context
$outputFile string Path to the file where the exported XML should be saved
$objects array Objects to be exported or registered
$filter string Filter to use
$objectsFileNamePart string Export file name part for this kind of objects

executeExportAction() public method

Execute export action.
public executeExportAction ( $request, $objects, $filter, $tab, $objectsFileNamePart )
$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

exportXML() public method

Get the XML for selected objects.
public exportXML ( $objects, $filter, $context ) : string
$objects mixed Array of or single published article, issue or galley
$filter string
$context Context
return string XML document.

getAdditionalFieldNames() public method

Hook callback that returns the 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 from gallley IDs.
public getArticleGalleys ( $galleyIds, $context ) : array
$galleyIds array
$context Context
return array

getCache() public method

Get the plugin cache
public getCache ( ) : PubObjectCache
return PubObjectCache

getDepositStatusSettingName() public method

Get deposit status setting name.
public getDepositStatusSettingName ( ) : string
return string

getExportActionNames() public method

Get action names.
public getExportActionNames ( ) : array
return array (string action => string text)

getExportActions() public method

Get actions.
public getExportActions ( $context ) : array
$context Context
return array

getExportDeploymentClassName() abstract public method

Return the name of the plugin's deployment class.
abstract public getExportDeploymentClassName ( ) : string
return string

getIssueFilter() public method

Get the issue filter.
public getIssueFilter ( ) : string | null
return string | null

getPublishedArticles() public method

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

getPublishedIssues() public method

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

getRepresentationFilter() public method

Get the representation filter.
public getRepresentationFilter ( ) : string | null
return string | null

getStatusActions() public method

Get status actions for the display to the user, i.e. links to a web site with more information about the status.
public getStatusActions ( $pubObject ) : array
$pubObject
return array (string status => link)

getStatusNames() public method

Get status names for the filter search option.
public getStatusNames ( ) : array
return array (string status => string text)

getSubmissionFilter() public method

Get the submission filter.
public getSubmissionFilter ( ) : string | null
return string | null

getTemplatePath() public method

public getTemplatePath ( $inCore = false )

isTestMode() public method

Check whether we are in test mode.
public isTestMode ( $context ) : boolean
$context Context
return boolean

manage() public method

public manage ( $args, $request )

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 )

registerDaoHook() public method

Register the hook that adds an additional field name to objects.
public registerDaoHook ( $daoName )
$daoName string

updateObject() public method

Update the given object.
public updateObject ( $object )
$object Issue|PublishedArticle|ArticleGAlley

usage() public method

public usage ( $scriptName )

Property Details

$_cache public_oe property

public PubObjectCache $_cache
return PubObjectCache