grouped_parser_processor Class Reference

Abstract xml parser processor able to group chunks as configured and dispatch them to other arbitrary methods. More...

Inheritance diagram for grouped_parser_processor:

Public Member Functions
	__construct (array $paths=array())
	add_path ($path)
	add_path ($path, $grouped=false)
	after_path ($path)
	The parser fires this each time one path has been parsed. More...
	before_path ($path)
	The parser fires this each time one path is going to be parsed. More...
	debug_info ()
	process_cdata ($cdata)
	Perform custom transformations in the processed cdata. More...
	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. More...
	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. More...
	get_parent_path ($path)
	Get the parent path using a local cache for performance. More...
	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. More...
	notify_path_start ($path)
	Get one selected path and notify about start. More...
	path_is_grouped ($path)
	path_is_selected ($path)
	path_is_selected_parent ($path)
	postprocess_chunk ($data)
	Override this method so grouping will be happening here also deciding between accumulating/dispatching. More...
	process_pending_startend_notifications ($path, $action)
	Adjust start/end til finding one match start/end path (included) More...
	selected_parent_exists ($path)
	Returns the first selected parent if available or false.

Protected Attributes
	$chunks
	$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

Detailed Description

Abstract xml parser processor able to group chunks as configured and dispatch them to other arbitrary methods.

This @progressive_parser_processor handles the requested paths, allowing to group information under any of them, dispatching them to the methods specified

Note memory increases as you group more and more paths, so use it for well-known structures being smaller enough (never to group MBs into one in-memory structure)

TODO: Complete phpdocs

Constructor & Destructor Documentation

__construct()

grouped_parser_processor::__construct

(

array

$paths = array()

)

Reimplemented from simplified_parser_processor.

Member Function Documentation

after_path()

grouped_parser_processor::after_path

(

$path

)

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

)

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

simplified_parser_processor::dispatch_chunk (   $data )

abstractprotectedinherited

Get the already simplified chunk and dispatch it.

Reimplemented in moodle1_parser_processor, restore_inforef_parser_processor, restore_moodlexml_parser_processor, restore_questions_parser_processor, restore_roles_parser_processor, restore_structure_parser_processor, and restore_users_parser_processor.

get_parent_path()

grouped_parser_processor::get_parent_path (   $path )

protected

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

simplified_parser_processor::notify_path_end (   $path )

abstractprotectedinherited

Get one selected path and notify about end.

Reimplemented in moodle1_parser_processor, restore_inforef_parser_processor, restore_moodlexml_parser_processor, restore_questions_parser_processor, restore_roles_parser_processor, restore_structure_parser_processor, and restore_users_parser_processor.

notify_path_start()

simplified_parser_processor::notify_path_start (   $path )

abstractprotectedinherited

Get one selected path and notify about start.

Reimplemented in moodle1_parser_processor, restore_inforef_parser_processor, restore_moodlexml_parser_processor, restore_questions_parser_processor, restore_roles_parser_processor, restore_structure_parser_processor, and restore_users_parser_processor.

postprocess_chunk()

grouped_parser_processor::postprocess_chunk (   $data )

protected

Override this method so grouping will be happening here also deciding between accumulating/dispatching.

Reimplemented from simplified_parser_processor.

Reimplemented in restore_structure_parser_processor.

process_cdata()

progressive_parser_processor::process_cdata (   $cdata )

inherited

Perform custom transformations in the processed cdata.

Reimplemented in moodle1_parser_processor, restore_questions_parser_processor, restore_roles_parser_processor, restore_structure_parser_processor, and restore_users_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/xml/parser/processors/grouped_parser_processor.class.php