Inheritance diagram for HIPO_Job_Structured_File_Import:

Public Member Functions
	HIPO_Job_Structured_File_Import ($code_name='')

	getCodeName ()

	getHipoName ()

	getInitialStepData ()

	freestyle ()

	processTidying (&$step_data, $prefix)

	processHeadings (&$step_data, $prefix)

	processImages (&$step_data, $prefix)

	processScanning (&$step_data, $prefix)

	scanChildren ($headings, $data)

	processSplitting (&$step_data, $prefix)

	splitData ($page_data, &$parent_asset)

	setPageContent (&$page, $content)

	getPageContent (&$page)

	processAdditional (&$step_data, $prefix)

	_removeHtmlComment (&$html)

	_cleanHeading ($heading)

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 34 of file hipo_job_structured_file_import.inc.

Member Function Documentation

_cleanHeading ( $heading )

It returns the cleaned title of the page.

Parameters

array $heading heading HTML

Returns: string private

Definition at line 1043 of file hipo_job_structured_file_import.inc.

_removeHtmlComment ( & $html )

It removes any HTML comment lines in HTML code except that they locates between <style> tags

Parameters

array &$html HTML to process

Returns: string private

Definition at line 971 of file hipo_job_structured_file_import.inc.

freestyle ( )

Performs the duties of this hipo, without showing any output

Returns: boolean public

Definition at line 170 of file hipo_job_structured_file_import.inc.

getCodeName ( )

Returns a unique id for this job

Returns: string public

Definition at line 57 of file hipo_job_structured_file_import.inc.

getHipoName ( )

Returns the (localised) HIPO name

Returns: string public

Definition at line 70 of file hipo_job_structured_file_import.inc.

getInitialStepData ( )

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

Returns: string public

Definition at line 84 of file hipo_job_structured_file_import.inc.

getPageContent ( & $page )

Creates any additional assets, such as additional linking or Table of Contents

Parameters

array &$page A reference to the page object to isnert content in

Returns: boolean public

Definition at line 863 of file hipo_job_structured_file_import.inc.

HIPO_Job_Structured_File_Import ( $code_name = '' )

Constructor

Parameters

string $code_name a unique codename the HIPO

Definition at line 43 of file hipo_job_structured_file_import.inc.

processAdditional	(	&	$step_data,
			$prefix
	)

Creates any additional assets, such as additional linking or Table of Contents

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 887 of file hipo_job_structured_file_import.inc.

processHeadings	(	&	$step_data,
			$prefix
	)

Removes any newlines or strange data from the headings

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 418 of file hipo_job_structured_file_import.inc.

processImages	(	&	$step_data,
			$prefix
	)

Imports any images and changes their references in the file

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 459 of file hipo_job_structured_file_import.inc.

processScanning	(	&	$step_data,
			$prefix
	)

Scan the file to determine what is required to import it correctly

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 570 of file hipo_job_structured_file_import.inc.

processSplitting	(	&	$step_data,
			$prefix
	)

Splits the file, and creates appropriate assets

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 729 of file hipo_job_structured_file_import.inc.

processTidying	(	&	$step_data,
			$prefix
	)

Scan the file to determine what is required to import it correctly

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 219 of file hipo_job_structured_file_import.inc.

scanChildren	(	$headings,
		$data
	)

Scans and adds the children of a top level heading

Parameters

array	$headings	Array with the top element being the heading to process
string	$data	The string to process

Returns: array public

Definition at line 679 of file hipo_job_structured_file_import.inc.

setPageContent	(	&	$page,
			$content
	)

Creates any additional assets, such as additional linking or Table of Contents

Parameters

array	&$page	A reference to the page object to isnert content in
string	$content	html content for the page

Returns: boolean public

Definition at line 835 of file hipo_job_structured_file_import.inc.

splitData	(		$page_data,
		&	$parent_asset
	)

Recursively checks the file, and splits it on the next heading level

Parameters

array	$page_data	The data for this split
object	&$parent_asset	The parent to link any new assets under

Returns: boolean public

Definition at line 765 of file hipo_job_structured_file_import.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/import_tools/hipo_jobs/hipo_job_structured_file_import.inc

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation