HIPO_Job_Export_Thesaurus_XML Class Reference

Inheritance diagram for HIPO_Job_Export_Thesaurus_XML:

Public Member Functions
	HIPO_Job_Export_Thesaurus_XML ($code_name='')
	getCodeName ()
	getHipoName ()
	getInitialStepData ()
	prepare ()
	processStart (&$step_data, $prefix)
	processFinish (&$step_data, $prefix)
	freestyle ()
	processCreateXML (&$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 33 of file hipo_job_export_thesaurus_xml.inc.

Member Function Documentation

freestyle

(

)

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

Returns

boolean public

Definition at line 214 of file hipo_job_export_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 56 of file hipo_job_export_thesaurus_xml.inc.

getHipoName

(

)

Returns the (localised) HIPO name

Returns

string public

Definition at line 69 of file hipo_job_export_thesaurus_xml.inc.

getInitialStepData

(

)

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

Returns

string public

Definition at line 83 of file hipo_job_export_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 364 of file hipo_job_export_thesaurus_xml.inc.

getThesaurusRef

(

)

Get a reference to the thesaurus asset

Returns

object public

Definition at line 386 of file hipo_job_export_thesaurus_xml.inc.

HIPO_Job_Export_Thesaurus_XML

(

$code_name = ''

)

Constructor

Parameters

string

$code_name

a unique codename the HIPO

Definition at line 42 of file hipo_job_export_thesaurus_xml.inc.

prepare

(

)

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

Returns

boolean public

Definition at line 147 of file hipo_job_export_thesaurus_xml.inc.

processCreateXML	(	&	$step_data,
			$prefix
	)

Create an XML representation of the term table and output it to file

Parameters

array	&$step_data	step data
string	$prefix	unique prefix

Returns

boolean public

Definition at line 251 of file hipo_job_export_thesaurus_xml.inc.

processFinish	(	&	$step_data,
			$prefix
	)

Mark the contents changed attribute as false now that a new file has been generated

Parameters

array	&$step_data	step data
string	$prefix	unique prefix

Returns

boolean public

Definition at line 195 of file hipo_job_export_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 177 of file hipo_job_export_thesaurus_xml.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/core/hipo/jobs/hipo_job_export_thesaurus_xml.inc