Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
HIPO_Job_Edit_Roles Class Reference
Inheritance diagram for HIPO_Job_Edit_Roles:
HIPO_Job MySource_Object

Public Member Functions

 HIPO_Job_Edit_Roles ($code_name='')
 
 getCodeName ()
 
 getHipoName ()
 
 getInitialStepData ()
 
 getThresholdPercentageRequired ()
 
 freestyle ()
 
 prepare ()
 
 processRoles (&$step_data, $prefix)
 
 getLockAssetDetails (&$job_type, &$running_vars, &$options)
 
 releaseLocks (&$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 45 of file hipo_job_edit_roles.inc.

Member Function Documentation

freestyle ( )

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

Returns
boolean public

Definition at line 190 of file hipo_job_edit_roles.inc.

getCodeName ( )

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

Returns
string public

Definition at line 107 of file hipo_job_edit_roles.inc.

static getConfigVars ( )
static

Sets some info about thresholds that this hipo requires.

Returns
array public

Definition at line 92 of file hipo_job_edit_roles.inc.

getHipoName ( )

Returns the (localised) HIPO name

Returns
string public

Definition at line 120 of file hipo_job_edit_roles.inc.

getInitialStepData ( )

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

Returns
string public

Definition at line 134 of file hipo_job_edit_roles.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_typethe hipo job type
array&$running_varsarray contains the information for the hipo to run
array&$optionsoptions
Returns
void public

Definition at line 332 of file hipo_job_edit_roles.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 162 of file hipo_job_edit_roles.inc.

HIPO_Job_Edit_Roles (   $code_name = '')

Constructor

Parameters
string$code_namea unique codename the HIPO

Definition at line 54 of file hipo_job_edit_roles.inc.

static paintConfig ( $o,
  $class,
  $write_access 
)
static

Paints backend of this job

Parameters
object&$oreference to the backend outputter
string$classcalling class name
Returns
void private

Definition at line 70 of file hipo_job_edit_roles.inc.

prepare ( )

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

Returns
boolean public

Definition at line 208 of file hipo_job_edit_roles.inc.

processRoles ( $step_data,
  $prefix 
)

Edit roles for a single asset in the to-do list

Parameters
array&$step_dataa reference to the array of information about the current step
string$prefixprefix for form vars
Returns
boolean public

Definition at line 258 of file hipo_job_edit_roles.inc.

releaseLocks ( $step_data,
  $prefix 
)

Release the locks we acquired while setting the roles

Parameters
array&$step_dataa reference to the array of information about the current step
string$prefixprefix for form vars
Returns
boolean public

Definition at line 356 of file hipo_job_edit_roles.inc.


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