Squiz Matrix
4.12.2
|
Public Member Functions | |
HIPO_Job_Trigger_Batch_Events ($code_name='') | |
getCodeName () | |
getHipoName () | |
getInitialStepData () | |
getThresholdPercentageRequired () | |
freestyle () | |
prepare () | |
processAssets (&$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 37 of file hipo_job_trigger_batch_events.inc.
freestyle | ( | ) |
Performs the duties of this hipo, without showing any output on the frontend.
Definition at line 178 of file hipo_job_trigger_batch_events.inc.
getCodeName | ( | ) |
Returns a unique codename the HIPO can use to ensure it is not being run twice
The Trigger Batch Events HIPO appends the current user, the ID of the target, and whether the 'include children' flag is set, so that any other batching jobs on the selected assets do not start while it is running
Definition at line 103 of file hipo_job_trigger_batch_events.inc.
|
static |
Sets some info about thresholds that this hipo requires.
Definition at line 84 of file hipo_job_trigger_batch_events.inc.
getHipoName | ( | ) |
Returns the (localised) HIPO name
Definition at line 116 of file hipo_job_trigger_batch_events.inc.
getInitialStepData | ( | ) |
Returns the steps in this hipo, possibly with localised step names and messages
Definition at line 130 of file hipo_job_trigger_batch_events.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 159 of file hipo_job_trigger_batch_events.inc.
HIPO_Job_Trigger_Batch_Events | ( | $code_name = '' | ) |
Constructor
string | $code_name | a unique codename the HIPO |
Definition at line 46 of file hipo_job_trigger_batch_events.inc.
|
static |
Paints backend of this job
object | Backend_Outputter &$o reference to the backend outputter | |
string | $class | calling class name |
Definition at line 62 of file hipo_job_trigger_batch_events.inc.
prepare | ( | ) |
Prepares the running vars.
Definition at line 196 of file hipo_job_trigger_batch_events.inc.
processAssets | ( | & | $step_data, |
$prefix | |||
) |
Broadcast an event on a single asset in the to-do list
array() | &$step_data a reference to the array of information about the current step | |
string | $prefix | prefix for form vars |
Definition at line 224 of file hipo_job_trigger_batch_events.inc.