Inheritance diagram for HIPO_Job_Import_Thesaurus_XML:

Public Member Functions
	HIPO_Job_Import_Thesaurus_XML ($code_name='')

	getCodeName ()

	getHipoName ()

	getInitialStepData ()

	freestyle ()

	prepare ()

	processStart (&$step_data, $prefix)

	paintEraseContents (&$step_data, &$o, $prefix)

	processEraseContents (&$step_data, $prefix)

	startElement ($parser, $tag, $attrs)

	cDataHandler ($parser, $data)

	endElement ($parser, $tag)

	processParseXml (&$step_data, $prefix)

	getLockAssetDetails (&$job_type, &$running_vars, &$options)

&	getThesaurusRef ()

Public Member Functions inherited from HIPO_Job
	HIPO_Job ($code_name='')

	getCodeName ()

	getHipoName ()

	getInitialStepData ()

	complete ()

	percentDone ()

&	getRunningVars ()

	setRunningVars (&$vars)

	setOption ($name, $value)

	getOption ($name)

	setHipoVar ($name, $value)

	getHipoVar ($name)

	_addError ($error, $warning=FALSE)

	getErrors ()

	prepare ()

	initialise ($source_code_name=NULL)

	getThreshold ()

	getThresholdPercentageRequired ()

	freestyle ()

	load ($code_name)

	save ($ignore_running_mode=FALSE)

	_updateProgress ()

	_renewLastUpdated ($new_time=NULL)

&	_getSubJob ()

	getInitialiseMode ()

	setRunningMode ($mode, $server_taskid='')

	getRunningMode ()

	autoStep ()

	getNextStep ()

	skipStep ($stepid=0)

	paint (&$o, $nested=FALSE)

	process ()

	processWeb (&$step_data, $prefix)

	processServer (&$step_data, $prefix)

	abort ($abort_source=TRUE, $abort_dependant=TRUE)

	jobAborted ()

	_paintErrorReport ()

	paintStepDefault (&$step_data, &$o, $prefix)

	_errorHandler ($err_no, $err_msg, $err_file, $err_line)

	getDependantHipoJob ()

Public Member Functions inherited from MySource_Object
	MySource_Object ()

	__sleep ()

	__wakeup ()

Additional Inherited Members
Static Public Member Functions inherited from HIPO_Job
static	paintConfig (&$o, $class, $write_access)

static	getConfigVars ()

static	paintProgressBar ($percent_done, $message='', $label_class='sq-hipo-progress-bar-label', $percent_class='sq-hipo-progress-bar-percent', $bar_main_class='sq-hipo-progress-bar-main', $bar_done_class='sq-hipo-progress-bar-done')

Data Fields inherited from HIPO_Job
	$code_name = ''

	$source_code_name = ''

	$userid = 0

	$last_updated = 0

	$hipo_name = ''

	$is_prepared = FALSE

	$uses_trans = TRUE

	$_hipo_vars

	$_options

	$_running_vars = Array()

	$_current_mode = 'web'

	$_steps = Array()

Detailed Description

Definition at line 31 of file hipo_job_import_thesaurus_xml.inc.

Member Function Documentation

cDataHandler	(	$parser,
		$data
	)

Handler of Character Data blocks

Currently being used for notes only

Parameters

object	$parser	the calling xml parser
string	$data	text

Returns: boolean public

Definition at line 392 of file hipo_job_import_thesaurus_xml.inc.

endElement	(	$parser,
		$tag
	)

Process an end element from the XML parser

Parameters

object	$parser	the calling xml parser
string	$tag	tag name

Returns: boolean public

Definition at line 420 of file hipo_job_import_thesaurus_xml.inc.

freestyle ( )

Performs the duties of this hipo, without showing any output on the frontend.

Returns: boolean public

Definition at line 145 of file hipo_job_import_thesaurus_xml.inc.

getCodeName ( )

Returns a unique codename the HIPO can use to ensure it is not being run twice

Returns: string public

Definition at line 54 of file hipo_job_import_thesaurus_xml.inc.

getHipoName ( )

Returns the (localised) HIPO name

Returns: string public

Definition at line 67 of file hipo_job_import_thesaurus_xml.inc.

getInitialStepData ( )

Returns the steps in this hipo, possibly with localised step names and messages

Returns: string public

Definition at line 81 of file hipo_job_import_thesaurus_xml.inc.

getLockAssetDetails	(	&	$job_type,
		&	$running_vars,
		&	$options
	)

This function is used to set-up the details for the locking the assets by the nested HIPO_Job

Parameters

string	&$job_type	job type
array	&$running_vars	running vars
array	&$options	options

Returns: void public

Definition at line 600 of file hipo_job_import_thesaurus_xml.inc.

& getThesaurusRef ( )

Get a reference to the thesaurus assets

Returns: object public

Definition at line 622 of file hipo_job_import_thesaurus_xml.inc.

HIPO_Job_Import_Thesaurus_XML ( $code_name = '' )

Constructor

Parameters

string $code_name a unique codename the HIPO

Definition at line 40 of file hipo_job_import_thesaurus_xml.inc.

paintEraseContents	(	&	$step_data,
		&	$o,
			$prefix
	)

Paints the interface for the 'Erase Thesaurus Contents' step

Parameters

array	&$step_data	step data
object	&$o	outputter
string	$prefix	unique prefix

Returns: boolean public

Definition at line 218 of file hipo_job_import_thesaurus_xml.inc.

prepare ( )

Prepares the running vars and gets the children of the asset in question.

Returns: boolean public

Definition at line 169 of file hipo_job_import_thesaurus_xml.inc.

processEraseContents	(	&	$step_data,
			$prefix
	)

Erase Thesaurus Contents

Parameters

array	&$step_data	step data
string	$prefix	unique prefix

Returns: boolean public

Definition at line 241 of file hipo_job_import_thesaurus_xml.inc.

processParseXml	(	&	$step_data,
			$prefix
	)

Parse the supplied XML file

Parameters

array	&$step_data	step data
string	$prefix	unique prefix

Returns: boolean public

Definition at line 496 of file hipo_job_import_thesaurus_xml.inc.

processStart	(	&	$step_data,
			$prefix
	)

Dummy function that runs an empty step, so that there is no empty screen before the end of the first real step

Parameters

array	&$step_data	step data
string	$prefix	unique prefix

Returns: boolean public

Definition at line 199 of file hipo_job_import_thesaurus_xml.inc.

startElement	(	$parser,
		$tag,
		$attrs
	)

Process a start element from the XML parser

Parameters

object	$parser	the calling xml parser
string	$tag	tag name
array	$attrs	tag attributes

Returns: boolean public

Definition at line 270 of file hipo_job_import_thesaurus_xml.inc.

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

/Users/webmaster/Desktop/squiz_matrix/core/hipo/jobs/hipo_job_import_thesaurus_xml.inc

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation