restore_structure_parser_processor Class Reference

helper implementation of grouped_parser_processor that will support the process of all the moodle2 backup files, with complete specs about what to load (grouped or no), dispatching to corresponding methods and basic decoding of contents (NULLs and legacy file.php uses) More...

Inheritance diagram for restore_structure_parser_processor:

Public Member Functions
	__construct ($courseid, $step)
	add_path ($path, $grouped=false)
	add_path ($path)
	after_path ($path)
	The parser fires this each time one path has been parsed.
	before_path ($path)
	The parser fires this each time one path is going to be parsed.
	debug_info ()
	process_cdata ($cdata)
	Provide NULL and legacy file.php uses decoding.
	process_chunk ($data)
	Get one chunk of parsed data and make it simpler adding attributes as tags and delegating to dispatch_chunk() the procesing of the resulting chunk.
	receive_chunk ($data)

Protected Member Functions
	add_missing_sub ($grouped, $path, $tags)
	Add non-existing subarray elements.
	build_currentdata ($grouped, $data)
	This function will accumulate the chunk into the specified grouped element for later dispatching once it is complete.
	dispatch_chunk ($data)
	Get the already simplified chunk and dispatch it.
	get_parent_path ($path)
	Get the parent path using a local cache for performance.
	grouped_child_exists ($path)
	Function that will look for any grouped child for the given path, returning it if found, false if not.
	grouped_parent_exists ($path)
	Function that will look for any grouped parent for the given path, returning it if found, false if not.
	notify_path_end ($path)
	Get one selected path and notify about end.
	notify_path_start ($path)
	Get one selected path and notify about start.
	path_is_grouped ($path)
	path_is_selected ($path)
	path_is_selected_parent ($path)
	postprocess_chunk ($data)
	Override this method so we'll be able to skip dispatching some well-known chunks, like the ones being 100% part of subplugins stuff.
	process_pending_startend_notifications ($path, $action)
	Adjust start/end til finding one match start/end path (included)
	selected_parent_exists ($path)
	Returns the first selected parent if available or false.

Protected Attributes
	$chunks
	$courseid
	$currentdata
array	$groupedparentprefixtree
	Search tree storing the grouped paths.
	$groupedpaths
	$inittime
array	$parentcache = array()
	Keep cache of parent directory paths for XML parsing.
integer	$parentcacheavailablesize = 2048
	Remaining space for parent directory paths.
	$parentpaths
	$parentsinfo
	$paths
	$startendinfo
	$step

Detailed Description

helper implementation of grouped_parser_processor that will support the process of all the moodle2 backup files, with complete specs about what to load (grouped or no), dispatching to corresponding methods and basic decoding of contents (NULLs and legacy file.php uses)

TODO: Complete phpdocs

Member Function Documentation

after_path()

grouped_parser_processor::after_path ( $path )

inherited

The parser fires this each time one path has been parsed.

Parameters

string

$path

xml path which parsing has ended

Reimplemented from simplified_parser_processor.

before_path()

grouped_parser_processor::before_path ( $path )

inherited

The parser fires this each time one path is going to be parsed.

Parameters

string

$path

xml path which parsing has started

Reimplemented from simplified_parser_processor.

dispatch_chunk()

restore_structure_parser_processor::dispatch_chunk ( $data )

protected

Get the already simplified chunk and dispatch it.

Reimplemented from simplified_parser_processor.

get_parent_path()

grouped_parser_processor::get_parent_path ( $path )

protectedinherited

Get the parent path using a local cache for performance.

Parameters

$path

string The pathname you wish to obtain the parent name for.

Return values

string

The parent pathname.

notify_path_end()

restore_structure_parser_processor::notify_path_end ( $path )

protected

Get one selected path and notify about end.

Reimplemented from simplified_parser_processor.

notify_path_start()

restore_structure_parser_processor::notify_path_start ( $path )

protected

Get one selected path and notify about start.

Reimplemented from simplified_parser_processor.

postprocess_chunk()

restore_structure_parser_processor::postprocess_chunk ( $data )

protected

Override this method so we'll be able to skip dispatching some well-known chunks, like the ones being 100% part of subplugins stuff.

Useful for allowing development without having all the possible restore subplugins defined

Reimplemented from grouped_parser_processor.

process_cdata()

restore_structure_parser_processor::process_cdata

(

$cdata

)

Provide NULL and legacy file.php uses decoding.

Reimplemented from progressive_parser_processor.

process_chunk()

simplified_parser_processor::process_chunk ( $data )

inherited

Get one chunk of parsed data and make it simpler adding attributes as tags and delegating to dispatch_chunk() the procesing of the resulting chunk.

Reimplemented from progressive_parser_processor.

process_pending_startend_notifications()

simplified_parser_processor::process_pending_startend_notifications ( $path, $action )

protectedinherited

Adjust start/end til finding one match start/end path (included)

This will trigger all the pending {

See also

notify_path_start} and {

notify_path_end} calls for one given path and action

Parameters

string	path the path to look for as limit
string	action the action to look for as limit

---

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

• backup/util/helper/restore_structure_parser_processor.class.php