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

Public Member Functions

 HIPO_Job_Export_Assets_To_Xml ($code_name='')
 
 getCodeName ()
 
 getHipoName ()
 
 getInitialStepData ()
 
 freestyle ()
 
 prepare ()
 
 processExportAsset (&$step_data, $prefix)
 
 printCreateXML ($asset_id, $parent, $link_type, $value='', $is_dependant=0, $is_exclusive=0)
 
 printLinkXML ($parent, $link_info, $action_code)
 
 printAttributeXML ($asset_id)
 
 printNoticeLinksXML ($asset_id)
 
 printPermissionXML ($asset_id)
 
 printMetadataXML ($asset_id)
 
 _parseValue ($value)
 
 getAssetType (&$asset)
 
 replace_system_assetid ($assetid)
 
 isSerialized ($str)
 
- 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 ()
 

Data Fields

 $import_action_outputs = Array()
 
- 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()
 
- Data Fields inherited from MySource_Object
 $_tmp
 

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')
 

Detailed Description

Definition at line 35 of file hipo_job_export_assets_to_xml.inc.

Member Function Documentation

_parseValue (   $value)

process the attribute value for reference of asset ids. e.g ?a=xx links should be replaced if the referred the asset is exported together

Parameters
string$valuethe attribute value to process
Returns
void private

Definition at line 745 of file hipo_job_export_assets_to_xml.inc.

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_export_assets_to_xml.inc.

getAssetType ( $asset)

Returns the asset type that this management class is working for Borrowed from asset_management.inc, but modified for our purposes

Returns
string public

Definition at line 783 of file hipo_job_export_assets_to_xml.inc.

getCodeName ( )

Returns a unique id for this job

Returns
string public

Definition at line 60 of file hipo_job_export_assets_to_xml.inc.

getHipoName ( )

Returns the (localised) HIPO name

Returns
string public

Definition at line 73 of file hipo_job_export_assets_to_xml.inc.

getInitialStepData ( )

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

Returns
string public

Definition at line 87 of file hipo_job_export_assets_to_xml.inc.

HIPO_Job_Export_Assets_To_Xml (   $code_name = '')

Constructor

Parameters
string$code_namea unique codename the HIPO

Definition at line 46 of file hipo_job_export_assets_to_xml.inc.

isSerialized (   $str)

Test if a string is serialized

Parameters
string
Returns
boolean public

Definition at line 817 of file hipo_job_export_assets_to_xml.inc.

prepare ( )

Prepares the running vars

Returns
boolean public

Definition at line 134 of file hipo_job_export_assets_to_xml.inc.

printAttributeXML (   $asset_id)

create the attrbute XML

Parameters
string$asset_idasset id to export attribute
Returns
void public

Definition at line 371 of file hipo_job_export_assets_to_xml.inc.

printCreateXML (   $asset_id,
  $parent,
  $link_type,
  $value = '',
  $is_dependant = 0,
  $is_exclusive = 0 
)

Lovely recursing function to create the XML

Parameters
string$asset_idid of the asset to create
string$parentparent id to create underneath
string$link_typelink type of the new link
string$valuelink value
string$is_dependantis dependant
string$is_exclusiveis exclusive
Returns
void public

Definition at line 242 of file hipo_job_export_assets_to_xml.inc.

printLinkXML (   $parent,
  $link_info,
  $action_code 
)

create the link XML

Parameters
string$parentparent asset id
array$link_infoan array of the link info including link type, value etc
string$action_codeactions code
Returns
void public

Definition at line 335 of file hipo_job_export_assets_to_xml.inc.

printMetadataXML (   $asset_id)

recursively create the metadata XML for export

Parameters
string$asset_idasset id to export metadata
Returns
void public

Definition at line 646 of file hipo_job_export_assets_to_xml.inc.

printNoticeLinksXML (   $asset_id)

create the notice link XML

Parameters
string$parentasset id to export notice links
Returns
void public

Definition at line 437 of file hipo_job_export_assets_to_xml.inc.

printPermissionXML (   $asset_id)

create the permision XML

Parameters
string$asset_idasset id to export permission
Returns
void public

Definition at line 495 of file hipo_job_export_assets_to_xml.inc.

processExportAsset ( $step_data,
  $prefix 
)

Export assets to xml

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 155 of file hipo_job_export_assets_to_xml.inc.

replace_system_assetid (   $assetid)

Replace a current system asset's id with its name, because new system might have different asset id. a name will be safer

Parameters
string$sassetid
Returns
void|String public

Definition at line 799 of file hipo_job_export_assets_to_xml.inc.


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