BatchConversionTool Class Reference

Inheritance diagram for BatchConversionTool:

Public Member Functions
	__construct ($argv=array())
	execute ()
	usage ()

Protected Member Functions
	initProperties ()
	processAll ()
	processList ()
	processOne ($context)
	processPrint ()

Protected Attributes
	$_context = null
	$_markupBatchConversionHelper = null
	$_markupConversionHelper = null
	$_markupPlugin = null
	$_otsWrapper = null
	$_parameters = null
	$_user = null

Additional Inherited Members
Data Fields inherited from CommandLineTool
	$argv
	$scriptName

Detailed Description

Handles request for articles batch conversion.

CLI tool to perform batch conversion tasks

Definition at line 21 of file batch.php.

Constructor & Destructor Documentation

__construct()

BatchConversionTool::__construct

(

$argv = array()

)

Constructor

Parameters

array

$argv

Reimplemented from CommandLineTool.

Definition at line 68 of file batch.php.

References CommandLineTool\$argv, DAORegistry\registerDAO(), and usage().

Member Function Documentation

execute()

BatchConversionTool::execute

(

)

Execute batch conversion task

Definition at line 122 of file batch.php.

References DAORegistry\getDAO(), processAll(), processList(), processOne(), processPrint(), and usage().

initProperties()

BatchConversionTool::initProperties ( )

protected

Initializes object properties (ps: Make sure $context proprerty is set before calling this method)

Definition at line 91 of file batch.php.

References MarkupConversionHelper\getOTSWrapperInstance().

Referenced by processOne().

processAll()

BatchConversionTool::processAll ( )

protected

Batch convert all enabled journals

Definition at line 174 of file batch.php.

References DAORegistry\getDAO(), and processOne().

Referenced by execute().

processList()

BatchConversionTool::processList ( )

protected

Batch convert a comma separated list of enabled journals

Definition at line 185 of file batch.php.

References DAORegistry\getDAO(), processOne(), and usage().

Referenced by execute().

processOne()

BatchConversionTool::processOne (   $context )

protected

Batch convert a specific journal enabled

Parameters

$context

Context|null

Exceptions

Exception

Definition at line 205 of file batch.php.

References $_otsWrapper, MarkupConversionHelper\createConversionJobInfo(), DAORegistry\getDAO(), initProperties(), and usage().

Referenced by execute(), processAll(), and processList().

processPrint()

BatchConversionTool::processPrint ( )

protected

Prints the list of all enabled journals

Definition at line 162 of file batch.php.

References DAORegistry\getDAO().

Referenced by execute().

usage()

BatchConversionTool::usage

(

)

Print command usage information

Reimplemented from CommandLineTool.

Definition at line 111 of file batch.php.

Referenced by __construct(), execute(), processList(), and processOne().

Field Documentation

$_context

Context BatchConversionTool::$_context = null

protected

Current context object

Definition at line 50 of file batch.php.

$_markupBatchConversionHelper

MarkupBatchConversionHelper BatchConversionTool::$_markupBatchConversionHelper = null

protected

Batch conversion helper class

Definition at line 26 of file batch.php.

$_markupConversionHelper

MarkupConversionHelper BatchConversionTool::$_markupConversionHelper = null

protected

Markup conversion helper object

Definition at line 32 of file batch.php.

$_markupPlugin

MarkupPlugin BatchConversionTool::$_markupPlugin = null

protected

Markup plugin object

Definition at line 38 of file batch.php.

$_otsWrapper

XMLPSWrapper BatchConversionTool::$_otsWrapper = null

protected

OTS wrapper object

Definition at line 56 of file batch.php.

Referenced by processOne().

$_parameters

array BatchConversionTool::$_parameters = null

protected

All the arguments passed to the script

Definition at line 62 of file batch.php.

$_user

User BatchConversionTool::$_user = null

protected

User object

Definition at line 44 of file batch.php.

---

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

• batch.php