Squiz Matrix
4.12.2
|
Public Member Functions | |
HIPO_Job_Generate_Report ($code_name='') | |
getThresholdPercentageRequired () | |
getCodeName () | |
getHipoName () | |
getInitialStepData () | |
freestyle () | |
prepare () | |
processReport (&$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() | |
Definition at line 32 of file hipo_job_generate_report.inc.
freestyle | ( | ) |
Performs the duties of this hipo, without showing any output on the frontend.
Definition at line 171 of file hipo_job_generate_report.inc.
getCodeName | ( | ) |
Returns a unique codename the HIPO can use to ensure it is not being run twice
The Acquire Lock HIPO appends the ID of the asset that the lock is being acquired on (the top most parent) so that any other locking 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.
Definition at line 118 of file hipo_job_generate_report.inc.
|
static |
Sets some info about thresholds that this hipo requires.
Definition at line 80 of file hipo_job_generate_report.inc.
getHipoName | ( | ) |
Returns the (localised) HIPO name
Definition at line 131 of file hipo_job_generate_report.inc.
getInitialStepData | ( | ) |
Returns the steps in this hipo, possibly with localised step names and messages
Definition at line 145 of file hipo_job_generate_report.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.
Definition at line 97 of file hipo_job_generate_report.inc.
HIPO_Job_Generate_Report | ( | $code_name = '' | ) |
Constructor
string | $code_name | a unique codename the HIPO |
Definition at line 41 of file hipo_job_generate_report.inc.
|
static |
Paints backend of this job
object | &$o | reference to the backend outputter |
string | $class | calling class name |
Definition at line 57 of file hipo_job_generate_report.inc.
prepare | ( | ) |
Prepares the running vars
Definition at line 189 of file hipo_job_generate_report.inc.
processReport | ( | & | $step_data, |
$prefix | |||
) |
Generate the report
We pass the work off to the report asset to do for us
array | &$step_data | a reference to the array of information about the current step |
string | $prefix | prefix for form vars |
Definition at line 215 of file hipo_job_generate_report.inc.