Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
restore_users_parser_processor Class Reference

helper implementation of grouped_parser_processor that will load all the contents of one users.xml file to the backup_ids table storing the whole structure there for later processing. More...

Inheritance diagram for restore_users_parser_processor:
grouped_parser_processor simplified_parser_processor progressive_parser_processor

Public Member Functions

 __construct ($restoreid)
 
 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)
 Provide NULL 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. 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.
 
 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 grouping will be happening here also deciding between accumulating/dispatching.
 
 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
 
 $restoreid
 
 $startendinfo
 

Detailed Description

helper implementation of grouped_parser_processor that will load all the contents of one users.xml file to the backup_ids table storing the whole structure there for later processing.

Note: only "needed" users are loaded (must have userref record in backup_ids) Note: parentitemid will contain the user->contextid Note: althought included in backup, we don't restore user context ras/caps in same site they will be already there and it doesn't seem a good idea to make them "transportable" arround sites.

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$pathxml 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$pathxml path which parsing has started

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
$pathstring The pathname you wish to obtain the parent name for.
Return values
stringThe parent pathname.

◆ 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
stringpath the path to look for as limit
stringaction the action to look for as limit

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