Public Member Functions
	__construct ($plugin, $xmlpsWrapper, $user)

	addFileToSubmissionGalley ($existing_galley_by_labels, $submission, $genreId, $format, $filePath, $params=array())

	addXmlDocumentToSubmissionFileList ($journal, $submission, $filePath, $params)

	getCitationStyleHash ($contextId)

	handleArchiveExtractionAfterGalleyGenerate ($extractionPath, $journal, $submission, $submissionFile, $fileName)

	handleArchiveExtractionAfterXmlConversion ($extractionPath, $journal, $submission, $submissionFile, $fileStage, $fileName)

	retrieveConversionJobArchive ($submissionFile, $jobId, $statusCallbackFn=null, $maxReq=180, $sleep=5)

	triggerConversion ($journal, $submissionFile, $stage, $target, $jobInfoId)

	unzipArchive ($zipFile)

	zipArchiveExtract ($zipFile, $destination, &$message, $validFiles=array())

Static Public Member Functions
static	canUseCredentialsFromConfig ($creds)

static	createConversionJobInfo ($journal, $user, $fileId)

static	getOTSWrapperInstance ($plugin, $journal, $userObject, $reuseCached=true)

static	makeAccessToken ($user)

static	readCredentialsFromConfig ()

static	validateAccessToken ($user, $accessKey)

Protected Member Functions
	_addDependentImageToXmlDocument ($journal, $submission, $filePath, $params)

	_processHtmlMediaFiles ($context, $submission, $submissionFile, $stage, $htmlArchiveFilePath)

	buildSubmissionMetadata ($journal, $submission)

Protected Attributes
	$_params = null

	$_plugin = null

	$_xmlpsWrapper = null

Static Protected Attributes
static	$_otsWrapper = null

Detailed Description

Markup conversion Helper class.

Definition at line 17 of file MarkupConversionHelper.inc.php.

Constructor & Destructor Documentation

◆ __construct()

MarkupConversionHelper::__construct	(	$plugin,
		$xmlpsWrapper,
		$user
	)

Constructor

Parameters

$plugin	MarkupPlugin
$xmlpsWrapper	XMLPSWrapper
$user	User

Definition at line 42 of file MarkupConversionHelper.inc.php.

Member Function Documentation

◆ _addDependentImageToXmlDocument()

MarkupConversionHelper::_addDependentImageToXmlDocument	(	$journal,
		$submission,
		$filePath,
		$params
	)

protected

Add image as dependent file to xml document

Parameters

$journal	Journal
$submission	Submission
$filePath	string Path to file in archive
$params	array Additional parameters (assoc type, assoc id)

Returns: SubmissionFile

Definition at line 356 of file MarkupConversionHelper.inc.php.

References Core\getCurrentDate(), DAORegistry\getDAO(), and AppLocale\getLocale().

Referenced by _processHtmlMediaFiles().

◆ _processHtmlMediaFiles()

MarkupConversionHelper::_processHtmlMediaFiles	(	$context,
		$submission,
		$submissionFile,
		$stage,
		$htmlArchiveFilePath
	)

protected

Extract HTML archive and attach media files to XML document (dependent files)

Parameters

$context	Journal
$submission	Submission
$submissionFile	Submission File
$stage	int stage
$filePath	string Path to HTML archive
$params	array Additional parameters (assoc type, assoc id)

Returns: void

Definition at line 463 of file MarkupConversionHelper.inc.php.

References _addDependentImageToXmlDocument(), fatalError(), and zipArchiveExtract().

Referenced by handleArchiveExtractionAfterXmlConversion().

◆ addFileToSubmissionGalley()

MarkupConversionHelper::addFileToSubmissionGalley	(	$existing_galley_by_labels,
		$submission,
		$genreId,
		$format,
		$filePath,
		$params = `array()`
	)

Add a document as galley file

Parameters

$existing_galley_by_labels	array Array of existing galleys for submission indexed by label
$submission	object Submission object
$genreId	int Genre ID
$format	string Asset format
$fileName	string File to process

Returns: object Submission file object

Definition at line 398 of file MarkupConversionHelper.inc.php.

References Core\getCurrentDate(), DAORegistry\getDAO(), and AppLocale\getLocale().

Referenced by handleArchiveExtractionAfterGalleyGenerate().

◆ addXmlDocumentToSubmissionFileList()

MarkupConversionHelper::addXmlDocumentToSubmissionFileList	(	$journal,
		$submission,
		$filePath,
		$params
	)

Add converted xml document to file list for stage

Parameters

$journal	Journal
$submission	Submission
$filePath	string Path to file in archive
$params	array Additional parameters (file stage, assoc type, assoc id)

Returns: SubmissionFile

Definition at line 317 of file MarkupConversionHelper.inc.php.

References Core\getCurrentDate(), DAORegistry\getDAO(), and AppLocale\getLocale().

Referenced by handleArchiveExtractionAfterGalleyGenerate(), and handleArchiveExtractionAfterXmlConversion().

◆ buildSubmissionMetadata()

MarkupConversionHelper::buildSubmissionMetadata	(	$journal,
		$submission
	)

protected

Build an array of metadata about submitted file

Parameters

$journal	Journal Journal
$submission	Submission Submission

Returns: array

Definition at line 55 of file MarkupConversionHelper.inc.php.

References PKPApplication\getCCLicenseBadge(), DAORegistry\getDAO(), PKPString\regexp_match_get(), and AppLocale\requireComponents().

Referenced by triggerConversion().

◆ canUseCredentialsFromConfig()

static MarkupConversionHelper::canUseCredentialsFromConfig ( $creds )

static

Tells wether the user has specified OTS login credentials in the config file

Parameters

$creds array

Returns: boolean

Definition at line 624 of file MarkupConversionHelper.inc.php.

Referenced by MarkupHandler\_conversion(), MarkupSettingsForm\execute(), MarkupPlugin\getOTSLoginParametersForJournal(), MarkupSettingsForm\initData(), and MarkupSettingsForm\validate().

◆ createConversionJobInfo()

static MarkupConversionHelper::createConversionJobInfo	(	$journal,
		$user,
		$fileId
	)

static

Creates markup job info

Parameters

$journal	Journal
$user	User
$fileId	int

Returns: string

Definition at line 563 of file MarkupConversionHelper.inc.php.

References DAORegistry\getDAO().

Referenced by MarkupBatchGatewayPlugin\fetch(), MarkupPlugin\fetchGateway(), and BatchConversionTool\processOne().

◆ getCitationStyleHash()

MarkupConversionHelper::getCitationStyleHash ( $contextId )

Return the citation hash to use either from config file or settings

Parameters

$contextId int

Returns: mixed

Definition at line 155 of file MarkupConversionHelper.inc.php.

References Config\getVar().

Referenced by triggerConversion().

◆ getOTSWrapperInstance()

static MarkupConversionHelper::getOTSWrapperInstance	(	$plugin,
		$journal,
		$userObject,
		$reuseCached = `true`
	)

static

Return an instance of OTS wrapper

Parameters

$plugin	MarkupPlugin
$journal	Journal
$userObject	User
$useCached	boolean Whether the cached object can be reused.

Returns: XMLPSWrapper

Definition at line 590 of file MarkupConversionHelper.inc.php.

References $_otsWrapper.

Referenced by MarkupGatewayPlugin\_initXMLPSWrapper(), MarkupBatchGatewayPlugin\fetch(), MarkupBatchGatewayPlugin\initMarkupConversionHelper(), and BatchConversionTool\initProperties().

◆ handleArchiveExtractionAfterGalleyGenerate()

MarkupConversionHelper::handleArchiveExtractionAfterGalleyGenerate	(	$extractionPath,
		$journal,
		$submission,
		$submissionFile,
		$fileName
	)

Performs zip extraction after production ready file conversion

Parameters

	$extractionPath	string
	$journal	Journal
	$submission	Submission
	$submissionFile	SubmissionFile
string	$fileName

Returns: boolean

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

References addFileToSubmissionGalley(), addXmlDocumentToSubmissionFileList(), and DAORegistry\getDAO().

◆ handleArchiveExtractionAfterXmlConversion()

MarkupConversionHelper::handleArchiveExtractionAfterXmlConversion	(	$extractionPath,
		$journal,
		$submission,
		$submissionFile,
		$fileStage,
		$fileName
	)

Performs zip extraction after xml job conversion

Parameters

$extractionPath	string
$journal	Journal
$submission	Submission
$submissionFile	SubmissionFile
$fileStage	int
$fileName	string

Returns: boolean

Definition at line 497 of file MarkupConversionHelper.inc.php.

References _processHtmlMediaFiles(), and addXmlDocumentToSubmissionFileList().

◆ makeAccessToken()

static MarkupConversionHelper::makeAccessToken ( $user )

static

Create an access token used for Gateway plugin request validation

Parameters

$user User

Returns: accessKey string The generated passkey

Definition at line 642 of file MarkupConversionHelper.inc.php.

Referenced by MarkupPlugin\fetchGateway(), and MarkupBatchConversionHandler\startConversion().

◆ readCredentialsFromConfig()

static MarkupConversionHelper::readCredentialsFromConfig ( )

static

Read OTS credentials values from config file

Returns: array

Definition at line 611 of file MarkupConversionHelper.inc.php.

References Config\getVar().

Referenced by MarkupHandler\_conversion(), MarkupSettingsForm\execute(), MarkupPlugin\getOTSLoginParametersForJournal(), MarkupSettingsForm\initData(), and MarkupSettingsForm\validate().

◆ retrieveConversionJobArchive()

MarkupConversionHelper::retrieveConversionJobArchive	(	$submissionFile,
		$jobId,
		$statusCallbackFn = `null`,
		$maxReq = `180`,
		$sleep = `5`
	)

Retrieves conversion archive from OTS server

Parameters

$submissionFile	mixed SubmissionFile
$jobId	int XML job ID
$statusCallbackFn	Closure
$maxReq	int max number of requests to perform
$sleep	int number of seconds to pause between requests

Returns: boolean|string

Definition at line 205 of file MarkupConversionHelper.inc.php.

References DAORegistry\getDAO(), XMLPSWrapper\JOB_STATUS_COMPLETED, XMLPSWrapper\JOB_STATUS_PENDING, and XMLPSWrapper\JOB_STATUS_PROCESSING.

◆ triggerConversion()

MarkupConversionHelper::triggerConversion	(	$journal,
		$submissionFile,
		$stage,
		$target,
		$jobInfoId
	)

Kicks off a submission file conversion on OTS server

Parameters

$journal	Journal Journal
$submissionFile	mixed SubmissionFile
$stage	int Submission stage ID
$target	string Job target (xml-conversion or galley-generate)
$jobInfoId	int OTS job ID

Returns: $jobId int

Definition at line 172 of file MarkupConversionHelper.inc.php.

References buildSubmissionMetadata(), getCitationStyleHash(), and DAORegistry\getDAO().

◆ unzipArchive()

MarkupConversionHelper::unzipArchive ( $zipFile )

Extract archive file.

Parameters

$zipFile string Path to zip archive

Returns: mixed path to extraction directory or false if extraction was not successful

Definition at line 239 of file MarkupConversionHelper.inc.php.

References zipArchiveExtract().

◆ validateAccessToken()

static MarkupConversionHelper::validateAccessToken	(	$user,
		$accessKey
	)

static

Validates access key supplied to a gateway plugin

Parameters

$user	User
$accessKey	string

Returns: accessKey string The generated passkey

Definition at line 655 of file MarkupConversionHelper.inc.php.

References AccessKeyManager\generateKeyHash().

Referenced by MarkupBatchGatewayPlugin\fetch(), and MarkupGatewayPlugin\fetch().

◆ zipArchiveExtract()

MarkupConversionHelper::zipArchiveExtract	(		$zipFile,
			$destination,
		&	$message,
			$validFiles = `array()`
	)

Extract zip a archive

Parameters

$zipFile	string File to extract
$validFiles	mixed Array with file names to extract
$destination	string Destination folder
$message	string Reference to status message from ZipArchive

Returns: bool Whether or not the extraction was successful

Definition at line 275 of file MarkupConversionHelper.inc.php.

Referenced by _processHtmlMediaFiles(), and unzipArchive().

Field Documentation

◆ $_otsWrapper

MarkupConversionHelper::$_otsWrapper = null

staticprotected

Definition at line 34 of file MarkupConversionHelper.inc.php.

Referenced by getOTSWrapperInstance().

◆ $_params

$params MarkupConversionHelper::$_params = null

protected

array extra parameters

Definition at line 32 of file MarkupConversionHelper.inc.php.

◆ $_plugin

$plugin MarkupConversionHelper::$_plugin = null

protected

MarkupPlugin Reference to markup plugin

Definition at line 27 of file MarkupConversionHelper.inc.php.

◆ $_xmlpsWrapper

$xmlpsWrapper MarkupConversionHelper::$_xmlpsWrapper = null

protected

XMLPSWrapper Reference to wrapper class for OTS Service

Definition at line 22 of file MarkupConversionHelper.inc.php.

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

MarkupConversionHelper.inc.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addDependentImageToXmlDocument()

◆ _processHtmlMediaFiles()

◆ addFileToSubmissionGalley()

◆ addXmlDocumentToSubmissionFileList()

◆ buildSubmissionMetadata()

◆ canUseCredentialsFromConfig()

◆ createConversionJobInfo()

◆ getCitationStyleHash()

◆ getOTSWrapperInstance()

◆ handleArchiveExtractionAfterGalleyGenerate()

◆ handleArchiveExtractionAfterXmlConversion()

◆ makeAccessToken()

◆ readCredentialsFromConfig()

◆ retrieveConversionJobArchive()

◆ triggerConversion()

◆ unzipArchive()

◆ validateAccessToken()

◆ zipArchiveExtract()

Field Documentation

◆ $_otsWrapper

◆ $_params

◆ $_plugin

◆ $_xmlpsWrapper