HIPO_Job_Clone_Assets Class Reference

Inheritance diagram for HIPO_Job_Clone_Assets:

Public Member Functions
	HIPO_Job_Clone_Assets ($code_name='')
	getCodeName ()
	getHipoName ()
	getInitialStepData ()
	getThresholdPercentageRequired ()
	freestyle ()
	prepare ()
	getLockAssetDetails (&$job_type, &$running_vars, &$options)
	releaseLocks (&$step_data, $prefix)
	paintCloneOptions (&$step_data, &$o, $prefix)
	processCloneOptions (&$step_data, $prefix)
	processCloneAssets (&$step_data, $prefix)
	processRemap (&$step_data, $prefix)
	paintInterface (&$step_data, &$o, $prefix)
	paintRefresh (&$step_data, &$o, $prefix)
	processRefresh (&$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 29 of file hipo_job_clone_assets.inc.

Member Function Documentation

freestyle

(

)

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

Returns

boolean public

Definition at line 237 of file hipo_job_clone_assets.inc.

getCodeName

(

)

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

The Update Lookups HIPO appends the ID of the asset that the lookups are being updated at (the top most parent) so that any other update lookup 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 97 of file hipo_job_clone_assets.inc.

static getConfigVars ( )

static

Sets some info about thresholds that this hipo requires.

Returns

array public

Definition at line 77 of file hipo_job_clone_assets.inc.

getHipoName

(

)

Returns the (localised) HIPO name

Returns

string public

Definition at line 110 of file hipo_job_clone_assets.inc.

getInitialStepData

(

)

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

Returns

string public

Definition at line 124 of file hipo_job_clone_assets.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	the hipo job type
array	&$running_vars	array contains the information for the hipo to run
array	&$options	options

Returns

void public

Definition at line 318 of file hipo_job_clone_assets.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 220 of file hipo_job_clone_assets.inc.

HIPO_Job_Clone_Assets

(

$code_name = ''

)

Constructor

Parameters

string

$code_name

a unique codename the HIPO

Definition at line 38 of file hipo_job_clone_assets.inc.

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

Paints some option for the user to specify what assets are to be cloned

All dependant asset will be automatically cloned, so no interface will be supplied for duping dependant assets which should save some space.

Parameters

array	&$step_data	a reference to the step data for this step
object	&$o	the hipo backend outputter object
string	$prefix	a string for prefixing form variables

Returns

boolean public

Definition at line 393 of file hipo_job_clone_assets.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 54 of file hipo_job_clone_assets.inc.

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

Paint the interface for accepting user input on what to cascade (permissions/metadata/workflow)

Parameters

array	&$step_data	a reference to the array of information about the current step
object	&$o	the backend outputter class
string	$prefix	prefix for form vars

Returns

boolean public

Definition at line 707 of file hipo_job_clone_assets.inc.

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

Refreshes the asset map to reflect cloned assets that were added

Parameters

array	&$step_data	a reference to the array of information about the current step
object	&$o	the backend outputter class
string	$prefix	prefix for form vars

Returns

boolean public

Definition at line 797 of file hipo_job_clone_assets.inc.

prepare

(

)

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

Returns

boolean public

Definition at line 285 of file hipo_job_clone_assets.inc.

processCloneAssets	(	&	$step_data,
			$prefix
	)

Processes the assets that need to be cloned, and clones them

Parameters

array	&$step_data	a reference to the step data for this step
string	$prefix	a string for prefixing form vairables

Returns

boolean public

Definition at line 502 of file hipo_job_clone_assets.inc.

processCloneOptions	(	&	$step_data,
			$prefix
	)

Processes the name changes if requested

Parameters

array	&$step_data	a reference to the step data for this step
string	$prefix	a string for prefixing form variables

Returns

boolean public

Definition at line 468 of file hipo_job_clone_assets.inc.

processRefresh	(	&	$step_data,
			$prefix
	)

Does nothing

Parameters

array	&$step_data	the step data for this job
string	$prefix	prefix to be used with this job

Returns

boolean public

Definition at line 818 of file hipo_job_clone_assets.inc.

processRemap	(	&	$step_data,
			$prefix
	)

Remaps the new assets from their old assetid to their new assetid

Uses a map returned from the clone() function in asset.inc

Parameters

array	&$step_data	a reference to the step data for this step
string	$prefix	a string for prefixing form vairables

Returns

boolean public

Definition at line 664 of file hipo_job_clone_assets.inc.

releaseLocks	(	&	$step_data,
			$prefix
	)

Release the locks that were acquired while cloning assets

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 343 of file hipo_job_clone_assets.inc.

---

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

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