HIPO_Job_Tool_Clear_Squid_Cache Class Reference

Inheritance diagram for HIPO_Job_Tool_Clear_Squid_Cache:

Public Member Functions
	__construct ($code_name='')
	getCodeName ()
	getHipoName ()
	getInitialStepData ()
	freestyle ()
	prepare ()
	processClearCache (Array &$step_data, $prefix)
	requestPage ($url, $host, $port)
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 33 of file hipo_job_tool_clear_squid_cache.inc.

Constructor & Destructor Documentation

__construct

(

$code_name = ''

)

Constructor

Parameters

string

$code_name

a unique codename the HIPO

Definition at line 43 of file hipo_job_tool_clear_squid_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 114 of file hipo_job_tool_clear_squid_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 61 of file hipo_job_tool_clear_squid_cache.inc.

getHipoName

(

)

Returns the (localised) HIPO name

Returns

string public

Definition at line 74 of file hipo_job_tool_clear_squid_cache.inc.

getInitialStepData

(

)

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

Returns

string public

Definition at line 88 of file hipo_job_tool_clear_squid_cache.inc.

prepare

(

)

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

Returns

boolean public

Definition at line 132 of file hipo_job_tool_clear_squid_cache.inc.

processClearCache	(	Array &	$step_data,
			$prefix
	)

Clears the Squid cache for all URLs applied to the selected asset

Parameters

array	&$step_data	a reference to the array of information about the current step
string	$prefix	prefix for form vars

Returns

boolean public

Definition at line 178 of file hipo_job_tool_clear_squid_cache.inc.

requestPage	(		$url,
			$host,
			$port
	)

Repopulate Squid cache using CURL request

Parameters

string	$url	the URL of the page that we are processing
string	$host	the host of the proxy
string	$port	the port used by the proxy

Returns

void public

Definition at line 305 of file hipo_job_tool_clear_squid_cache.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/squid/hipo_jobs/hipo_job_tool_clear_squid_cache.inc