Inheritance diagram for HIPO_Job_ReIndex:

Public Member Functions
	HIPO_Job_ReIndex ($code_name='')

	getThresholdPercentageRequired ()

	getCodeName ()

	getHipoName ()

	getInitialStepData ()

	freestyle ()

	prepare ()

	processReIndex (&$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 31 of file hipo_job_reindex.inc.

Member Function Documentation

freestyle ( )

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

Returns: boolean public

Definition at line 173 of file hipo_job_reindex.inc.

getCodeName ( )

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

The Regenerate Metdata HIPO appends the ID of the schema that was updated so that any other regeneration jobs for this schema do not start while it is running.

Returns: string public

Definition at line 120 of file hipo_job_reindex.inc.

static getConfigVars ( )

static

Sets some info about thresholds that this hipo requires.

Returns: array public

Definition at line 81 of file hipo_job_reindex.inc.

getHipoName ( )

Returns the (localised) HIPO name

Returns: string public

Definition at line 133 of file hipo_job_reindex.inc.

getInitialStepData ( )

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

Returns: string public

Definition at line 147 of file hipo_job_reindex.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 99 of file hipo_job_reindex.inc.

HIPO_Job_ReIndex ( $code_name = '' )

Constructor

Parameters

string $code_name a unique codename the HIPO

Definition at line 40 of file hipo_job_reindex.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 59 of file hipo_job_reindex.inc.

prepare ( )

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

Returns: boolean public

Definition at line 196 of file hipo_job_reindex.inc.

processReIndex	(	&	$step_data,
			$prefix
	)

Re-index asset keydata for a single asset in the todo 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 250 of file hipo_job_reindex.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/search/hipo_jobs/hipo_job_reindex.inc

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation