moodle1_submod_handler Class Reference

Base class for the activity modules' subplugins. More...

Inheritance diagram for moodle1_submod_handler:

Public Member Functions
	__construct (moodle1_mod_handler $parenthandler, $subplugintype, $subpluginname)
	get_component_name ()
	Returns the normalized name of the plugin, eg mod_workshop.
	get_converter ()
	get_paths ()
	Activity module subplugins can't declare any paths to handle.
	log ($message, $level, $a=null, $depth=null, $display=false)
	This function will be responsible for handling the params, and to call to the corresponding logger->process() once all modifications in params have been performed.

Protected Member Functions
	close_xml_writer ()
	Close the XML writer.
	has_xml_writer ()
	Checks if the XML writer has been opened by self::open_xml_writer().
	make_sure_xml_exists ($filename, $rootelement=false, $content=array())
	Makes sure that a new XML file exists, or creates it itself.
	open_xml_writer ($filename)
	Opens the XML writer - after calling, one is free to use $xmlwriter.
	write_xml ($element, array $data, array $attribs=array(), $parent='/')
	Writes the given XML tree data into the currently opened file.

Protected Attributes
moodle1_converter	$converter
moodle1_mod_handler	$parenthandler
string	$pluginname
string	$plugintype
null string	$xmlfilename
	the name of file we are writing to
null xml_writer	$xmlwriter

Detailed Description

Base class for the activity modules' subplugins.

Constructor & Destructor Documentation

__construct()

moodle1_submod_handler::__construct	(	moodle1_mod_handler	$parenthandler,
			$subplugintype,
			$subpluginname )

Parameters

moodle1_mod_handler	$parenthandler	the handler of a module we are subplugin of
string	$subplugintype	the type of the subplugin
string	$subpluginname	the name of the subplugin

Member Function Documentation

close_xml_writer()

moodle1_xml_handler::close_xml_writer ( )

protectedinherited

Close the XML writer.

At the moment, the caller must close all tags before calling

Return values

void

Reimplemented in moodle1_qtype_handler.

get_component_name()

moodle1_plugin_handler::get_component_name ( )

inherited

Returns the normalized name of the plugin, eg mod_workshop.

Return values

string

get_converter()

moodle1_handler::get_converter ( )

inherited

Return values

moodle1_converter

the converter that required this handler

get_paths()

moodle1_submod_handler::get_paths ( )

final

Activity module subplugins can't declare any paths to handle.

The paths must be registered by the parent module and then re-dispatched to the relevant subplugins for eventual processing.

Return values

array

empty array

has_xml_writer()

moodle1_xml_handler::has_xml_writer ( )

protectedinherited

Checks if the XML writer has been opened by self::open_xml_writer().

Return values

bool

log()

moodle1_handler::log ( $message, $level, $a = null, $depth = null, $display = false )

inherited

This function will be responsible for handling the params, and to call to the corresponding logger->process() once all modifications in params have been performed.

Implements loggable.

make_sure_xml_exists()

moodle1_xml_handler::make_sure_xml_exists ( $filename, $rootelement = false, $content = array() )

protectedinherited

Makes sure that a new XML file exists, or creates it itself.

This is here so we can check that all XML files that the restore process relies on have been created by an executed handler. If the file is not found, this method can create it using the given $rootelement as an empty root container in the file.

Parameters

string	$filename	relative file name like 'course/course.xml'
string | bool	$rootelement	root element to use, false to not create the file
array	$content	content of the root element

Return values

bool	true is the file existed, false if it did not

open_xml_writer()

moodle1_xml_handler::open_xml_writer ( $filename )

protectedinherited

Opens the XML writer - after calling, one is free to use $xmlwriter.

Parameters

string

$filename

XML file name to write into

Return values

void

Reimplemented in moodle1_qtype_handler.

write_xml()

moodle1_xml_handler::write_xml ( $element, array $data, array $attribs = array(), $parent = '/' )

protectedinherited

Writes the given XML tree data into the currently opened file.

Parameters

string	$element	the name of the root element of the tree
array	$data	the associative array of data to write
array	$attribs	list of additional fields written as attributes instead of nested elements
string	$parent	used internally during the recursion, do not set yourself

---

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

• backup/converter/moodle1/handlerlib.php