Inheritance diagram for HIPO_Job_Edit_Status:

Public Member Functions
	HIPO_Job_Edit_Status ($code_name='')

	getCodeName ()

	getHipoName ()

	getInitialStepData ()

	getThresholdPercentageRequired ()

	prepare ()

	load ($code_name)

	paint (&$o, $nested=FALSE)

	freestyle ()

	processServer (&$step_data, $prefix)

	processStatus (&$step_data, $prefix, $freestyle=FALSE)

	spawnDependantStatusHipo ($assetid, $new_status, $messages)

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 ()

Static Public Member Functions
static	paintConfig (&$o, $class, $write_access)

static	getConfigVars ()

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')

Additional Inherited Members
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 27 of file hipo_job_edit_status.inc.

Member Function Documentation

freestyle ( )

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

Returns: boolean public

Definition at line 291 of file hipo_job_edit_status.inc.

getCodeName ( )

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

The Edit Status HIPO appends the ID of the asset that the status is being edited for (the top most parent) so that any other status 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 95 of file hipo_job_edit_status.inc.

static getConfigVars ( )

static

Sets some info about thresholds that this hipo requires.

Returns: array public

Definition at line 75 of file hipo_job_edit_status.inc.

getHipoName ( )

Returns the (localised) HIPO name

Returns: string public

Definition at line 112 of file hipo_job_edit_status.inc.

getInitialStepData ( )

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

Returns: string public

Definition at line 126 of file hipo_job_edit_status.inc.

getThresholdPercentageRequired ( )

Returns the current Threshold.

Returns a value that represents the total percentage that this hipo would run in freestyle mode in its current state.

Returns: float public

Definition at line 154 of file hipo_job_edit_status.inc.

HIPO_Job_Edit_Status ( $code_name = '' )

Constructor

Parameters

string $code_name a unique codename for the HIPO

Definition at line 36 of file hipo_job_edit_status.inc.

load ( $code_name )

Load the HIPO vars from the database

Parameters

string $code_name a unique code_name the HIPO

Returns: boolean public

Definition at line 245 of file hipo_job_edit_status.inc.

paint	(	&	$o,
			$nested = `FALSE`
	)

Paint information about the process of the HIPO

This function calls the paint function for the step currently being run and also outputs a progress bar to indicate to the user where they are in the HIPO process

Parameters

object	&$o	Backend_Outputter, reference to the backend outputter
boolean	$nested	true if the steps are nested

Returns: void public

Definition at line 267 of file hipo_job_edit_status.inc.

static paintConfig	(	&	$o,
			$class,
			$write_access
	)

static

Paints backend of this job

Parameters

object	&$o	reference to the backend outputter
string	$class	calling class name

Returns: void private

Definition at line 52 of file hipo_job_edit_status.inc.

prepare ( )

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

Returns: boolean public

Definition at line 172 of file hipo_job_edit_status.inc.

processServer	(	&	$step_data,
			$prefix
	)

Process the current step of a HIPO in a server environment

This function manages the message queue during the status changes

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 314 of file hipo_job_edit_status.inc.

processStatus	(	&	$step_data,
			$prefix,
			$freestyle = `FALSE`
	)

Edit the status of 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
boolean	$freestyle	if this function is being freestyled or not

Returns: boolean public

Definition at line 345 of file hipo_job_edit_status.inc.

spawnDependantStatusHipo	(	$assetid,
		$new_status,
		$messages
	)

Starts another Hipo_Job_Edit_Status to process dependants of given asset

Parameters

string	$assetid	The ID of the asset to process dependants of
int	$new_status	The status to change dependants to
array	$messages	The current message queue

Returns: string private

Definition at line 516 of file hipo_job_edit_status.inc.

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation