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

Public Member Functions

 HIPO_Job_Rebuild_Cache ($code_name='')
 
 getThresholdPercentageRequired ()
 
 getCodeName ()
 
 getHipoName ()
 
 getInitialStepData ()
 
 freestyle ()
 
 prepare ()
 
 processFlushTable (&$step_data, $prefix)
 
 processRebuild (&$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_funnelback_rebuild_cache.inc.

Member Function Documentation

freestyle ( )

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

Returns
boolean public

Definition at line 179 of file hipo_job_funnelback_rebuild_cache.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 114 of file hipo_job_funnelback_rebuild_cache.inc.

static getConfigVars ( )
static

Sets some info about thresholds that this hipo requires.

Returns
array public

Definition at line 80 of file hipo_job_funnelback_rebuild_cache.inc.

getHipoName ( )

Returns the (localised) HIPO name

Returns
string public

Definition at line 127 of file hipo_job_funnelback_rebuild_cache.inc.

getInitialStepData ( )

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

Returns
string public

Definition at line 141 of file hipo_job_funnelback_rebuild_cache.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 98 of file hipo_job_funnelback_rebuild_cache.inc.

HIPO_Job_Rebuild_Cache (   $code_name = '')

Constructor

Parameters
string$code_namea unique codename the HIPO

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

prepare ( )

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

Returns
boolean public

Definition at line 206 of file hipo_job_funnelback_rebuild_cache.inc.

processFlushTable ( $step_data,
  $prefix 
)

Flush the table only on the root folder. This will clean any assets not existing anymore

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 253 of file hipo_job_funnelback_rebuild_cache.inc.

processRebuild ( $step_data,
  $prefix 
)

Rebuild the cache table for the sitemap/secmap in funnelback

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 283 of file hipo_job_funnelback_rebuild_cache.inc.


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