Inheritance diagram for HIPO_Job_Tool_Delete_Bmail_Users:

Public Member Functions
	__construct ($code_name='')

	getCodeName ()

	getHipoName ()

	getInitialStepData ()

	freestyle ()

	prepare ()

	processDelete (&$step_data, $prefix)

&	_getExistingBmailUser ($email)

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 31 of file hipo_job_tool_delete_bmail_users.inc.

Constructor & Destructor Documentation

__construct ( $code_name = '' )

Constructor

Parameters

string $code_name a unique codename the HIPO

Definition at line 40 of file hipo_job_tool_delete_bmail_users.inc.

Member Function Documentation

& _getExistingBmailUser ( $email )

Find existing bmail user with the same email address.

Returns the bmail user or null if not found.

Parameters

string $email the email address we are finding

Returns: mixed object|NULL private

Definition at line 322 of file hipo_job_tool_delete_bmail_users.inc.

freestyle ( )

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

Returns: boolean public

Definition at line 111 of file hipo_job_tool_delete_bmail_users.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.