HIPO_Job_Tool_Export_Files Class Reference

Inheritance diagram for HIPO_Job_Tool_Export_Files:

Public Member Functions
	__construct ($code_name='')
	getCodeName ()
	getHipoName ()
	getInitialStepData ()
	freestyle ()
	prepare ()
	processExport (&$step_data, $prefix)
	processExportNode ($root_node, $save_name, $save_location, $keep_structure=TRUE)
	_findPath ($list, $file, $path='')
	_getFiles ($root_node, $filetypes=Array(), &$depth)
	_processFiles ($links, $filetypes, &$depth)
	_cleanup ($base)
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 32 of file hipo_job_tool_export_files.inc.

Constructor & Destructor Documentation

__construct

(

$code_name = ''

)

Constructor

Parameters

string

$code_name

a unique codename the HIPO

Definition at line 41 of file hipo_job_tool_export_files.inc.

Member Function Documentation

_cleanup

(

$base

)

Cleanup

Parameters

string

$base

The base location from where to cleanup from

Returns

boolean private

Definition at line 501 of file hipo_job_tool_export_files.inc.

_findPath	(		$list,
			$file,
			$path = ''
	)

Find the path to the current file

Parameters

array	$list	The list of the current files
array	$file	The current file
string	$path	The current path

Returns

string private

Definition at line 371 of file hipo_job_tool_export_files.inc.

_getFiles	(		$root_node,
			$filetypes = Array(),
		&	$depth
	)

Get a list of files based on the root node

Parameters

array	$root_node	The root node or the location to start searching from
array	$filetypes	The allowed filetypes to match (blank to match all)
int	&$depth	A count showing the depth

Returns

array private

Definition at line 407 of file hipo_job_tool_export_files.inc.

_processFiles	(		$links,
			$filetypes,
		&	$depth
	)

Process the list of files based on the links returned

Parameters

array	$links	An array of links of the files
array	$filetypes	The allowed filetypes to match (blank to match all)
int	&$depth	A count showing the depth

Returns

array private

Definition at line 434 of file hipo_job_tool_export_files.inc.

freestyle

(

)

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

Returns

boolean public

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

getHipoName

(

)

Returns the (localised) HIPO name

Returns

string public

Definition at line 72 of file hipo_job_tool_export_files.inc.

getInitialStepData

(

)

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

Returns

string public

Definition at line 86 of file hipo_job_tool_export_files.inc.

prepare

(

)

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

Returns

boolean public

Definition at line 130 of file hipo_job_tool_export_files.inc.

processExport	(	&	$step_data,
			$prefix
	)

Export files from a root node to a tar ball

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 167 of file hipo_job_tool_export_files.inc.

processExportNode	(		$root_node,
			$save_name,
			$save_location,
			$keep_structure = TRUE
	)

Export files from a root node to a tar ball

Parameters

string	$root_node	The root node where the files and folders are going to come from
string	$save_name	The file name of the exported file (ie. the tar ball)
string	$save_location	The location to save the exported file (ie. the tar ball)
boolean	$keep_structure	Do we keep the structure or not

Returns

boolean public

Definition at line 226 of file hipo_job_tool_export_files.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/cms/hipo_jobs/hipo_job_tool_export_files.inc