Inheritance diagram for HIPO_Job_Purge_Trash:

Public Member Functions
	HIPO_Job_Purge_Trash ($code_name='')

	getHipoName ()

	getInitialStepData ()

	getThresholdPercentageRequired ()

	prepare ()

	freestyle ()

	buildListToDelete (&$step_data, $prefix)

	purgeAsset (&$step_data, $prefix)

	deleteRemainingTrashLinks (&$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 ()

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 32 of file hipo_job_purge_trash.inc.

Member Function Documentation

buildListToDelete	(	&	$step_data,
			$prefix
	)

Puts assets in the trash into a list of assets to delete iff they are linked only in the part of the trash being purged

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 274 of file hipo_job_purge_trash.inc.

deleteRemainingTrashLinks	(	&	$step_data,
			$prefix
	)

Delete all remaining links to the trash

Links that remain at this point are to assets that are linked elsewhere.

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 428 of file hipo_job_purge_trash.inc.

freestyle ( )

Performs the duties of this hipo, without showing any output

Returns: boolean public

Definition at line 242 of file hipo_job_purge_trash.inc.

static getConfigVars ( )

static

Sets some info about thresholds that this hipo requires.

Returns: array public

Definition at line 83 of file hipo_job_purge_trash.inc.

getHipoName ( )

Returns the (localised) HIPO name

Returns: string public

Definition at line 98 of file hipo_job_purge_trash.inc.

getInitialStepData ( )

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

Returns: string public

Definition at line 112 of file hipo_job_purge_trash.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 165 of file hipo_job_purge_trash.inc.

HIPO_Job_Purge_Trash ( $code_name = '' )

Constructor

Parameters

string $code_name a unique codename the HIPO

Definition at line 41 of file hipo_job_purge_trash.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 60 of file hipo_job_purge_trash.inc.

prepare ( )

Prepares the running vars and gets the children of the trash folder

Returns: boolean public

Definition at line 182 of file hipo_job_purge_trash.inc.

purgeAsset	(	&	$step_data,
			$prefix
	)

Purge a single asset in the to-delete list from the trash

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 334 of file hipo_job_purge_trash.inc.

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation