HIPO_Job_Quick_HIPO Class Reference

Inheritance diagram for HIPO_Job_Quick_HIPO:

Public Member Functions
	HIPO_Job_Quick_HIPO ($code_name='')
	getCodeName ()
	getHipoName ()
	getInitialStepData ()
	freestyle ()
&	_getCallbackAsset ()
	prepare ()
	processQuickHipo (&$step_data, $prefix)
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 35 of file hipo_job_quick_hipo.inc.

Member Function Documentation

& _getCallbackAsset

(

)

Returns the callback asset if the asset and callback function are valid

Returns

mixed object|NULL private

Definition at line 138 of file hipo_job_quick_hipo.inc.

freestyle

(

)

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

Returns

boolean public

Definition at line 120 of file hipo_job_quick_hipo.inc.

getCodeName

(

)

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

The Acquire Lock HIPO appends the ID of the asset that the lock is being acquired on (the top most parent) so that any other locking jobs on this asset do not start while it is running. Due to locking of the interface, nobody should be allowed to run this HIPO at the same time on the same parent asset.

Returns

string public

Definition at line 62 of file hipo_job_quick_hipo.inc.

getHipoName

(

)

Returns the (localised) HIPO name

Returns

string public

Definition at line 80 of file hipo_job_quick_hipo.inc.

getInitialStepData

(

)

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

Returns

string public

Definition at line 94 of file hipo_job_quick_hipo.inc.

HIPO_Job_Quick_HIPO

(

$code_name = ''

)

Constructor

Parameters

string

$code_name

a unique codename the HIPO

Definition at line 44 of file hipo_job_quick_hipo.inc.

prepare

(

)

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

Returns

boolean public

Definition at line 165 of file hipo_job_quick_hipo.inc.

processQuickHipo	(	&	$step_data,
			$prefix
	)

Acquire a lock on a single asset in the to-do list

Parameters

array	&$step_data	a reference to the array of information about the current step
string	$prefix	prefix for form vars

Returns

boolean public

Definition at line 195 of file hipo_job_quick_hipo.inc.

---

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

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