moodle1_mod_chat_handler Class Reference

Chat conversion handler. More...

Inheritance diagram for moodle1_mod_chat_handler:

Public Member Functions
	get_component_name ()
	Returns the normalized name of the plugin, eg mod_workshop.
	get_converter ()
	get_modname ()
	Returns the name of the module, eg.
	get_paths ()
	Declare the paths in moodle.xml we are able to convert.
	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.
	on_chat_end ()
	This is executed when we reach the closing </MOD> tag of our 'chat' path.
	process_chat ($data)
	This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/CHAT data available.
	process_chat_message ($data)
	This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/CHAT/MESSAGES/MESSAGE data available.

Protected Member Functions
	close_xml_writer ()
	Close the XML writer.
	get_cminfo ($instance, $modname=null)
	Returns course module information for the given instance id.
	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_file_manager	$fileman = null
int	$moduleid = null
	cmid
string	$pluginname
string	$plugintype
null string	$xmlfilename
	the name of file we are writing to
null xml_writer	$xmlwriter

Detailed Description

Chat conversion handler.

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

moodle1_mod_handler::get_cminfo ( $instance, $modname = null )

protectedinherited

Returns course module information for the given instance id.

The information for this instance id has been stashed by moodle1_course_outline_handler::process_course_module()

Parameters

int	$instance	the module instance id
string	$modname	the module type, defaults to $this->pluginname

Return values

int

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

moodle1_mod_handler::get_modname ( )

inherited

Returns the name of the module, eg.

'forum'

Return values

string

get_paths()

moodle1_mod_chat_handler::get_paths

(

)

Declare the paths in moodle.xml we are able to convert.

The method returns list of convert_path instances. For each path returned, the corresponding conversion method must be defined.

Note that the path /MOODLE_BACKUP/COURSE/MODULES/MOD/CHAT does not actually exist in the file. The last element with the module name was appended by the moodle1_converter class.

Return values

array

of convert_path instances

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:

• mod/chat/backup/moodle1/lib.php