MarkupBatchConversionHelper Class Reference

Public Member Functions
	__construct ()
	buildSubmissionMetadataByContext ($contextId)
	createOutFile ($data)
	deleteOutFile ()
	errorHandler ($errno, $errstr, $errfile, $errline)
	isRunning ()
	readOutFile ()
	updateOutFile ($data)

Protected Attributes
	$_outFile = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

MarkupBatchConversionHelper::__construct

(

)

Constructor

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

Member Function Documentation

buildSubmissionMetadataByContext()

MarkupBatchConversionHelper::buildSubmissionMetadataByContext

(

$contextId

)

Build an array of submissions metadata to process

Parameters

$contextId

int

Returns

array

Definition at line 101 of file MarkupBatchConversionHelper.inc.php.

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

createOutFile()

MarkupBatchConversionHelper::createOutFile

(

$data

)

Helper function to create a temporary file containing some data

Parameters

$data

array

Exceptions

Exception

Definition at line 43 of file MarkupBatchConversionHelper.inc.php.

deleteOutFile()

MarkupBatchConversionHelper::deleteOutFile

(

)

Helper function to delete the temporary file

Definition at line 75 of file MarkupBatchConversionHelper.inc.php.

Referenced by errorHandler().

errorHandler()

MarkupBatchConversionHelper::errorHandler	(		$errno,
			$errstr,
			$errfile,
			$errline
	)

Custom error handler callback to cleanup in case of runtime error

Parameters

$errno	int
$errstr	string
$errfile	string
$errline	int

Returns

boolean

Definition at line 89 of file MarkupBatchConversionHelper.inc.php.

References deleteOutFile().

isRunning()

MarkupBatchConversionHelper::isRunning

(

)

Determines whether a conversion is already running

Returns

boolean

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

Referenced by readOutFile().

readOutFile()

MarkupBatchConversionHelper::readOutFile

(

)

Read the file content

Returns

array|null

Definition at line 64 of file MarkupBatchConversionHelper.inc.php.

References isRunning().

updateOutFile()

MarkupBatchConversionHelper::updateOutFile

(

$data

)

Update file content

Parameters

array

$data

Definition at line 56 of file MarkupBatchConversionHelper.inc.php.

Field Documentation

$_outFile

$outFile MarkupBatchConversionHelper::$_outFile = null

protected

string Path to file used for inter process communication

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

---

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

• MarkupBatchConversionHelper.inc.php