Importer for Moodle XML question format. More...

Inheritance diagram for qformat_xml:

Public Member Functions
	can_import_file ($file)
	Check if the given file is capable of being imported by this plugin.

	clean_question_name ($name)
	Ensure that a question name does not contain anything nasty, and will fit in the DB field.

	clean_question_name ($name)
	Ensure that a question name does not contain anything nasty, and will fit in the DB field.

	create_default_question_name ($questiontext, $default)
	Construct a reasonable default question name, based on the start of the question text.

	create_default_question_name ($questiontext, $default)
	Construct a reasonable default question name, based on the start of the question text.

	export_file_extension ()

	exportpreprocess ()
	Do any pre-processing that may be required.

	exportprocess ($checkcapabilities=true)
	Perform the export.

	format ($format)

	get_format ($id)
	Convert internal Moodle text format code into human readable form.

	get_single ($id)
	Convert internal single question code into human readable form.

	getpath ($xml, $path, $default, $istext=false, $error='')
	return the value of a node, given a path to the node if it doesn't exist return the default value

	import_answer ($answer, $withanswerfiles=false, $defaultformat='html')
	Import the common parts of a single answer.

	import_calculated ($question)
	Import a calculated question.

	import_combined_feedback ($qo, $questionxml, $withshownumpartscorrect=false)
	Import the common overall feedback fields.

	import_description ($question)
	Import description type question.

	import_essay ($question)
	Import essay type question.

	import_files ($xml)
	Import files from a node in the XML.

	import_files_as_draft ($xml)

	import_headers ($question)
	import parts of question common to all types

	import_hint ($hintxml, $defaultformat)
	Import a question hint.

	import_hints ($qo, $questionxml, $withparts=false, $withoptions=false, $defaultformat='html')
	Import all the question hints.

	import_match ($question)
	Import matching type question.

	import_multianswer ($question)
	Import cloze type question.

	import_multichoice ($question)
	import multiple choice question

	import_numerical ($question)
	Import numerical type question.

	import_question_tags ($qo, $questionxml)
	Import all the question tags.

	import_questions ($xml)

	import_shortanswer ($question)
	Import short answer type question.

	import_text ($text)
	process text string from xml file

	import_text_with_files ($data, $path, $defaultvalue='', $defaultformat='html')

	import_truefalse ($question)
	Import true/false type question.

	importpostprocess ()

	importpostprocess ()
	Override if any post-processing is required.

	importpreprocess ()

	importpreprocess ()
	Perform any required pre-processing.

	importprocess ($filename, $lesson, $pageid)

	importprocess ()
	Process the file This method should not normally be overidden.

	mime_type ()
	The string mime-type of the files that this plugin reads or writes.

	provide_export ()

	provide_import ()

	readdata ($filename)

	readquestions ($lines)
	Parse the array of lines into an array of questions this could burn memory - but it won't happen that much so fingers crossed!

	set_can_access_backupdata ($canaccess)

	set_display_progress ($displayprogress)
	Change whether to display progress messages.

	set_importcontext ($context)

	setCategory ($category)
	set the category

	setCatfromfile ($catfromfile)
	set catfromfile

	setCattofile ($cattofile)
	set cattofile

	setContextfromfile ($contextfromfile)
	set contextfromfile

	setContexts ($contexts)
	set an array of contexts.

	setContexttofile ($contexttofile)
	set contexttofile

	setCourse ($course)
	set the course class variable

	setFilename ($filename)
	set the filename

	setMatchgrades ($matchgrades)
	set matchgrades

	setQuestions ($questions)
	Set the specific questions to export.

	setRealfilename ($realfilename)
	set the "real" filename (this is what the user typed, regardless of wha happened next)

	setStoponerror ($stoponerror)
	set stoponerror

	trans_format ($name)
	Translate human readable format name into internal Moodle code number Note the reverse function is called get_format.

	trans_single ($name)
	Translate human readable single answer option to internal code number.

	try_importing_using_qtypes ($data, $question=null, $extra=null, $qtypehint='')
	Import for questiontype plugins.

	try_importing_using_qtypes ($data, $question=null, $extra=null, $qtypehint='')
	Import for questiontype plugins Do not override.

	validate_file (stored_file $file)
	Validate the given file.

	write_answer ($answer, $extra='')

	write_answers ($answers)

	write_combined_feedback ($questionoptions, $questionid, $contextid)
	Output the combined feedback fields.

	write_files ($files)
	Generte the XML to represent some files.

	write_hint ($hint, $contextid)

	write_hints ($question)
	Write out the hints.

	writequestion ($question)
	Turns question into an xml segment.

	writetext ($raw, $indent=0, $short=true)
	Generates <text></text> tags, processing raw text therein.

	xml_escape ($string)
	Take a string, and wrap it in a CDATA secion, if that is required to make the output XML valid.

Public Attributes
	$canaccessbackupdata = true

	$category = null

	$catfromfile = 0

	$cattofile = 0

	$contextfromfile = 0

context[]	$contexts

	$contexttofile = 0

	$course = null

	$displayerrors = true

bool	$displayprogress = true
	$displayprogress Whether to display progress.

	$filename = ''

	$importerrors = 0

	$matchgrades = 'error'

	$qtypeconvert

	$questionids = array()

	$questions = array()

	$realfilename = ''

	$stoponerror = true

	$translator = null

Protected Member Functions
	add_blank_combined_feedback ($question)
	Since the lesson module tries to re-use the question bank import classes in a crazy way, this is necessary to stop things breaking.

	add_blank_combined_feedback ($question)
	Add a blank combined feedback to a question object.

	assemble_category_path ($names)
	Convert a list of category names, possibly preceeded by one of the context tokens like $course$, into a string representation of the category path.

	count_questions ($questions)
	Count all non-category questions in the questions array.

	count_questions ($questions)
	Count all non-category questions in the questions array.

	create_category_path ($catpath, $lastcategoryinfo=null)
	find and/or create the category described by a delimited list e.g.

	create_dummy_question_representing_category (string $categoryname, $categoryinfo)
	Create 'dummy' question for category export.

	defaultquestion ()
	return an "empty" question Somewhere to specify question parameters that are not handled by import but are required db fields.

	defaultquestion ()
	return an "empty" question Somewhere to specify question parameters that are not handled by import but are required db fields.

	error ($message, $text='', $questionname='')
	Handle parsing error.

	error ($message, $text='', $questionname='')
	Handle parsing error.

	exportpostprocess ()
	Do an post-processing that may be required.

	format_question_text ($question)
	Convert the question text to plain text, so it can safely be displayed during import to let the user see roughly what is going on.

	format_question_text ($question)
	Convert the question text to plain text, so it can safely be displayed during import to let the user see roughly what is going on.

	get_category_path ($id, $includecontext=true)
	get the category as a path (e.g., tom/dick/harry)

	get_name ()
	Return the localized pluginname string for the question format.

	get_qtype ($qtype)
	Turn the internal question type name into a human readable form.

	import_category ($question)
	This is not a real question type.

	import_question ($questionxml)

	presave_process ($content)
	Enable any processing to be done on the content just prior to the file being saved default is to do nothing.

	readdata ($filename)
	Return complete file within an array, one item per line.

	readquestion ($lines)

	readquestion ($lines)
	Given the data known to define a question in this format, this function converts it into a question object suitable for processing and insertion into Moodle.

	split_category_path ($path)
	Convert a string, as returned by assemble_category_path(), back into an array of category names.

	try_exporting_using_qtypes ($name, $question, $extra=null)
	Provide export functionality for plugin questiontypes Do not override.

	validate_is_utf8_file (stored_file $file)
	Check if the given file has the required utf8 encoding.

Protected Attributes
array	$answerfiles = []
	Array of files for question answers.

array	$feedbackfiles = []
	Array of files for feedback to question answers.

	$importcontext = null

Detailed Description

Importer for Moodle XML question format.

See http://docs.moodle.org/en/Moodle_XML_format for a description of the format.

Copyright: 1999 onwards Martin Dougiamas

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ add_blank_combined_feedback()

qformat_default::add_blank_combined_feedback ( $question )

protectedinherited

Add a blank combined feedback to a question object.

Parameters

object question

Return values

object question

◆ assemble_category_path()

qformat_default::assemble_category_path ( $names )

protectedinherited

Convert a list of category names, possibly preceeded by one of the context tokens like $course$, into a string representation of the category path.

Names are separated by / delimiters. And /s in the name are replaced by //.

To reverse the process and split the paths into names, use split_category_path().

Parameters

array $names

Return values

string

◆ can_import_file()

qformat_default::can_import_file ( $file )

inherited

Check if the given file is capable of being imported by this plugin.

Note that expensive or detailed integrity checks on the file should not be performed by this method. Simple file type or magic-number tests would be suitable.

Parameters

stored_file $file the file to check

Return values

bool	whether this plugin can import the file

Reimplemented in qformat_blackboard_six_base.

◆ clean_question_name() [1/2]

qformat_default::clean_question_name ( $name )

inherited

Ensure that a question name does not contain anything nasty, and will fit in the DB field.

Parameters

string $name the raw question name.

Return values

string a safe question name.

◆ clean_question_name() [2/2]

qformat_default::clean_question_name ( $name )

inherited

Ensure that a question name does not contain anything nasty, and will fit in the DB field.

Parameters

string $name the raw question name.

Return values

string a safe question name.

◆ count_questions() [1/2]

qformat_default::count_questions ( $questions )

protectedinherited

Count all non-category questions in the questions array.

Parameters

array questions An array of question objects.

Return values

int	The count.

◆ count_questions() [2/2]

qformat_default::count_questions ( $questions )

protectedinherited

Count all non-category questions in the questions array.

Parameters

array questions An array of question objects.

Return values

int	The count.

◆ create_category_path()

qformat_default::create_category_path	(		$catpath,
			$lastcategoryinfo = null )

protectedinherited

find and/or create the category described by a delimited list e.g.

$course$/tom/dick/harry or tom/dick/harry

removes any context string no matter whether $getcontext is set but if $getcontext is set then ignore the context and use selected category context.

Parameters

	string	catpath delimited category path
object	$lastcategoryinfo	Contains category information

Return values

mixed category object or null if fails

◆ create_default_question_name() [1/2]

qformat_default::create_default_question_name	(		$questiontext,
			$default )

inherited

Construct a reasonable default question name, based on the start of the question text.

Parameters

string	$questiontext	the question text.
string	$default	default question name to use if the constructed one comes out blank.

Return values

string a reasonable question name.

◆ create_default_question_name() [2/2]

qformat_default::create_default_question_name	(		$questiontext,
			$default )

inherited

Construct a reasonable default question name, based on the start of the question text.

Parameters

string	$questiontext	the question text.
string	$default	default question name to use if the constructed one comes out blank.

Return values

string a reasonable question name.

◆ create_dummy_question_representing_category()

qformat_default::create_dummy_question_representing_category	(	string	$categoryname,
			$categoryinfo )

protectedinherited

Create 'dummy' question for category export.

Parameters

string	$categoryname	the name of the category
object	$categoryinfo	description of the category

Return values

stdClass 'dummy' question for category

◆ defaultquestion() [1/2]

qformat_default::defaultquestion ( )

protectedinherited

return an "empty" question Somewhere to specify question parameters that are not handled by import but are required db fields.

This should not be overridden.

Return values

object default question

◆ defaultquestion() [2/2]

qformat_default::defaultquestion ( )

protectedinherited

return an "empty" question Somewhere to specify question parameters that are not handled by import but are required db fields.

This should not be overridden.

Return values

object default question

◆ error()

qformat_default::error	(	$message,
		$text = '',
		$questionname = '' )

protectedinherited

Handle parsing error.

Parameters

string	$message	information about error
string	$text	imported text that triggered the error
string	$questionname	imported question name

◆ export_file_extension()

qformat_xml::export_file_extension ( )

Return values

string the file extension (including .) that is normally used for files handled by this plugin.

Reimplemented from qformat_default.

◆ exportpostprocess()

qformat_default::exportpostprocess ( )

protectedinherited

Do an post-processing that may be required.

Return values

bool success

◆ exportpreprocess()

qformat_default::exportpreprocess ( )

inherited

Do any pre-processing that may be required.

Parameters

bool success

Reimplemented in qformat_aiken.

◆ exportprocess()

qformat_default::exportprocess ( $checkcapabilities = true )

inherited

Perform the export.

For most types this should not need to be overrided.

Parameters

bool $checkcapabilities Whether to check capabilities when exporting the questions.

Return values

string The content of the export.

◆ format()

qformat_xml::format ( $format )

Parameters

int $format a FORMAT_... constant.

Return values

string the attribute to add to an XML tag.

◆ get_category_path()

qformat_default::get_category_path	(		$id,
			$includecontext = true )

protectedinherited

get the category as a path (e.g., tom/dick/harry)

Parameters

int	id the id of the most nested catgory

Return values

string the path

◆ get_format()

qformat_xml::get_format ( $id )

Convert internal Moodle text format code into human readable form.

Parameters

int	id internal code

Return values

string format text

◆ get_name()

qformat_default::get_name ( )

protectedinherited

Return the localized pluginname string for the question format.

Return values

string the pluginname string for the question format

◆ get_qtype()

qformat_xml::get_qtype ( $qtype )

protected

Turn the internal question type name into a human readable form.

(In the past, the code used to use integers internally. Now, it uses strings, so there is less need for this, but to maintain backwards-compatibility we change two of the type names.)

Parameters

string $qtype question type plugin name.

Return values

string\$qtype string to use in the file.

◆ get_single()

qformat_xml::get_single ( $id )

Convert internal single question code into human readable form.

Parameters

int	id single question code

Return values

string single question string

◆ getpath()

qformat_xml::getpath	(	$xml,
		$path,
		$default,
		$istext = false,
		$error = '' )

return the value of a node, given a path to the node if it doesn't exist return the default value

Parameters

array	xml data to read
array	path path to node expressed as array
mixed	default
bool	istext process as text
string	error if set value must exist, return false and issue message if not

Return values

mixed value

◆ import_answer()

qformat_xml::import_answer	(	$answer,
		$withanswerfiles = false,
		$defaultformat = 'html' )

Import the common parts of a single answer.

Parameters

	array	answer xml tree for single answer
bool	$withanswerfiles	if true, the answers are HTML (or $defaultformat) and so may contain files, otherwise the answers are plain text.
	array	Default text format for the feedback, and the answers if $withanswerfiles is true.

Return values

object answer object

◆ import_calculated()

qformat_xml::import_calculated ( $question )

Import a calculated question.

Parameters

object $question the imported XML data.

◆ import_category()

qformat_xml::import_category ( $question )

protected

This is not a real question type.

It's a dummy type used to specify the import category. The format is: <question type="category"> <category>tom/dick/harry</category> <info format="moodle_auto_format"><text>Category description</text></info> </question>

◆ import_combined_feedback()

qformat_xml::import_combined_feedback	(	$qo,
		$questionxml,
		$withshownumpartscorrect = false )

Import the common overall feedback fields.

Parameters

object	$question	the part of the XML relating to this question.
object	$qo	the question data to add the fields to.
bool	$withshownumpartscorrect	include the shownumcorrect field.

◆ import_description()

qformat_xml::import_description ( $question )

Import description type question.

Parameters

array question question array from xml tree

Return values

object question object

◆ import_essay()

qformat_xml::import_essay ( $question )

Import essay type question.

Parameters

array question question array from xml tree

Return values

object question object

◆ import_files()

qformat_xml::import_files ( $xml )

Import files from a node in the XML.

Parameters

array $xml an array of <file> nodes from the the parsed XML.

Return values

array of things representing files - in the form that save_question expects.

◆ import_headers()

qformat_xml::import_headers ( $question )

import parts of question common to all types

Parameters

$question array question question array from xml tree

Return values

object question object

◆ import_hint()

qformat_xml::import_hint	(		$hintxml,
			$defaultformat )

Import a question hint.

Parameters

array	$hintxml	hint xml fragment.
string	$defaultformat	the text format to assume for hints that do not specify.

Return values

object hint for storing in the database.

◆ import_hints()

qformat_xml::import_hints	(	$qo,
		$questionxml,
		$withparts = false,
		$withoptions = false,
		$defaultformat = 'html' )

Import all the question hints.

Parameters

object	$qo	the question data that is being constructed.
array	$questionxml	The xml representing the question.
bool	$withparts	whether the extra fields relating to parts should be imported.
bool	$withoptions	whether the extra options field should be imported.
string	$defaultformat	the text format to assume for hints that do not specify.

Return values

array of objects representing the hints in the file.

◆ import_match()

qformat_xml::import_match ( $question )

Import matching type question.

Parameters

array question question array from xml tree

Return values

object question object

◆ import_multianswer()

qformat_xml::import_multianswer ( $question )

Import cloze type question.

Parameters

array question question array from xml tree

Return values

object question object

◆ import_multichoice()

qformat_xml::import_multichoice ( $question )

import multiple choice question

Parameters

array question question array from xml tree

Return values

object question object

◆ import_numerical()

qformat_xml::import_numerical ( $question )

Import numerical type question.

Parameters

array question question array from xml tree

Return values

object question object

◆ import_question()

qformat_xml::import_question ( $questionxml )

protected

Parameters

array $questionxml xml describing the question

Return values

null|stdClass an object with data to be fed to question type save_question_options

◆ import_question_tags()

qformat_xml::import_question_tags	(		$qo,
			$questionxml )

Import all the question tags.

Parameters

object	$qo	the question data that is being constructed.
array	$questionxml	The xml representing the question.

Return values

array of objects representing the tags in the file.

◆ import_questions()

qformat_xml::import_questions ( $xml )

Parameters

array $xml the xmlized xml

Return values

stdClass[] question objects to pass to question type save_question_options

◆ import_shortanswer()

qformat_xml::import_shortanswer ( $question )

Import short answer type question.

Parameters

array question question array from xml tree

Return values

object question object

◆ import_text()

qformat_xml::import_text ( $text )

process text string from xml file

Parameters

array $text bit of xml tree after ['text']

Return values

string processed text.

◆ import_truefalse()

qformat_xml::import_truefalse ( $question )

Import true/false type question.

Parameters

array question question array from xml tree

Return values

object question object

◆ importpostprocess() [1/2]

qformat_default::importpostprocess ( )

inherited

Reimplemented in qformat_blackboard_six_base.

◆ importpostprocess() [2/2]

qformat_default::importpostprocess ( )

inherited

Override if any post-processing is required.

Return values

bool success

Reimplemented in qformat_blackboard_six_base.

◆ importpreprocess()

qformat_default::importpreprocess ( )

inherited

Perform any required pre-processing.

Return values

bool success

◆ importprocess()

qformat_default::importprocess ( )

inherited

Process the file This method should not normally be overidden.

Return values

bool success

◆ mime_type()

qformat_xml::mime_type ( )

The string mime-type of the files that this plugin reads or writes.

Reimplemented from qformat_default.

◆ presave_process()

qformat_xml::presave_process ( $content )

protected

Enable any processing to be done on the content just prior to the file being saved default is to do nothing.

Parameters

string	output text
string	processed output text

Reimplemented from qformat_default.

◆ provide_export()

qformat_xml::provide_export ( )

Return values

bool	whether this plugin provides export functionality.

Reimplemented from qformat_default.

◆ provide_import()

qformat_xml::provide_import ( )

Reimplemented from qformat_default.

◆ readdata() [1/2]

qformat_default::readdata ( $filename )

inherited

Reimplemented in qformat_blackboard_six.

◆ readdata() [2/2]

qformat_default::readdata ( $filename )

protectedinherited

Return complete file within an array, one item per line.

Parameters

string filename name of file

Return values

mixed contents array or false on failure

Reimplemented in qformat_blackboard_six.

◆ readquestion()

qformat_default::readquestion ( $lines )

protectedinherited

Given the data known to define a question in this format, this function converts it into a question object suitable for processing and insertion into Moodle.

If your format does not use blank lines to delimit questions (e.g. an XML format) you must override 'readquestions' too

Parameters

$lines mixed data that represents question

Return values

object question object

◆ readquestions()

qformat_xml::readquestions ( $lines )

Parse the array of lines into an array of questions this could burn memory - but it won't happen that much so fingers crossed!

Parameters

	array	of lines from the input file.
stdClass	$context

Return values

array (of objects) question objects.

Reimplemented from qformat_default.

◆ set_can_access_backupdata()

qformat_default::set_can_access_backupdata ( $canaccess )

inherited

Parameters

bool $canaccess Whether the current use can access the backup data folder. Determines where export files are saved.

◆ set_display_progress()

qformat_default::set_display_progress ( $displayprogress )

inherited

Change whether to display progress messages.

There is normally no need to use this function as the default for $displayprogress is true. Set to false for unit tests.

Parameters

bool $displayprogress

◆ setCategory()

qformat_default::setCategory ( $category )

inherited

set the category

Parameters

object category the category object

◆ setCatfromfile()

qformat_default::setCatfromfile ( $catfromfile )

inherited

set catfromfile

Parameters

bool	catfromfile allow categories embedded in import file

◆ setCattofile()

qformat_default::setCattofile ( $cattofile )

inherited

set cattofile

Parameters

bool	cattofile exports categories within export file

◆ setContextfromfile()

qformat_default::setContextfromfile ( $contextfromfile )

inherited

set contextfromfile

Parameters

bool $contextfromfile allow contexts embedded in import file

◆ setContexts()

qformat_default::setContexts ( $contexts )

inherited

set an array of contexts.

Parameters

context[] $contexts

◆ setContexttofile()

qformat_default::setContexttofile ( $contexttofile )

inherited

set contexttofile

Parameters

bool	cattofile exports categories within export file

◆ setCourse()

qformat_default::setCourse ( $course )

inherited

set the course class variable

Parameters

course object Moodle course variable

◆ setFilename()

qformat_default::setFilename ( $filename )

inherited

set the filename

Parameters

string filename name of file to import/export

◆ setMatchgrades()

qformat_default::setMatchgrades ( $matchgrades )

inherited

set matchgrades

Parameters

string matchgrades error or nearest for grades

◆ setQuestions()

qformat_default::setQuestions ( $questions )

inherited

Set the specific questions to export.

Should not include questions with parents (sub questions of cloze question type). Only used for question export.

Parameters

array of question objects

◆ setRealfilename()

qformat_default::setRealfilename ( $realfilename )

inherited

set the "real" filename (this is what the user typed, regardless of wha happened next)

Parameters

string realfilename name of file as typed by user

◆ setStoponerror()

qformat_default::setStoponerror ( $stoponerror )

inherited

set stoponerror

Parameters

bool	stoponerror stops database write if any errors reported

◆ split_category_path()

qformat_default::split_category_path ( $path )

protectedinherited

Convert a string, as returned by assemble_category_path(), back into an array of category names.

Each category name is cleaned by a call to clean_param(, PARAM_TEXT), which matches the cleaning in question/bank/managecategories/category_form.php.

Parameters

string $path

Return values

array of category names.

◆ trans_format()

qformat_xml::trans_format ( $name )

Translate human readable format name into internal Moodle code number Note the reverse function is called get_format.

Parameters

string name format name from xml file

Return values

int	Moodle format code

◆ trans_single()

qformat_xml::trans_single ( $name )

Translate human readable single answer option to internal code number.

Parameters

string name true/false

Return values

int	internal code number

◆ try_exporting_using_qtypes()

qformat_default::try_exporting_using_qtypes	(	$name,
		$question,
		$extra = null )

protectedinherited

Provide export functionality for plugin questiontypes Do not override.

Parameters

name	questiontype name
question	object data to export
extra	mixed any addition format specific data needed

Return values

string the data to append to export or false if error (or unhandled)

◆ try_importing_using_qtypes() [1/2]

qformat_default::try_importing_using_qtypes	(	$data,
		$question = null,
		$extra = null,
		$qtypehint = '' )

inherited

Import for questiontype plugins.

Parameters

mixed	$data	The segment of data containing the question
object	$question	processed (so far) by standard import code if appropriate
object	$extra	mixed any additional format specific data that may be passed by the format
string	$qtypehint	hint about a question type from format

Return values

object question object suitable for save_options() or false if cannot handle

◆ try_importing_using_qtypes() [2/2]

qformat_default::try_importing_using_qtypes	(	$data,
		$question = null,
		$extra = null,
		$qtypehint = '' )

inherited

Import for questiontype plugins Do not override.

Parameters

data	mixed The segment of data containing the question
question	object processed (so far) by standard import code if appropriate
extra	mixed any additional format specific data that may be passed by the format
qtypehint	hint about a question type from format

Return values

object question object suitable for save_options() or false if cannot handle

◆ validate_file()

qformat_xml::validate_file ( stored_file $file )

Validate the given file.

For more expensive or detailed integrity checks.

Parameters

stored_file $file the file to check

Return values

string the error message that occurred while validating the given file

Reimplemented from qformat_default.

◆ validate_is_utf8_file()

qformat_default::validate_is_utf8_file ( stored_file $file )

protectedinherited

Check if the given file has the required utf8 encoding.

Parameters

stored_file $file the file to check

Return values

string the error message if the file encoding is not UTF-8

◆ write_combined_feedback()

qformat_xml::write_combined_feedback	(	$questionoptions,
		$questionid,
		$contextid )

Output the combined feedback fields.

Parameters

object	$questionoptions	the question definition data.
int	$questionid	the question id.
int	$contextid	the question context id.

Return values

string XML to output.

◆ write_files()

qformat_xml::write_files ( $files )

Generte the XML to represent some files.

Parameters

array of store array of stored_file objects.

Return values

string\$string the XML.

◆ write_hints()

qformat_xml::write_hints ( $question )

Write out the hints.

Parameters

object $question the question definition data.

Return values

string XML to output.

◆ writequestion()

qformat_xml::writequestion ( $question )

Turns question into an xml segment.

Parameters

object $question the question data.

Return values

string xml segment

Reimplemented from qformat_default.

◆ writetext()

qformat_xml::writetext	(	$raw,
		$indent = 0,
		$short = true )

Generates <text></text> tags, processing raw text therein.

Parameters

string	$raw	the content to output.
int	$indent	the current indent level.
bool	$short	stick it on one line.

Return values

string formatted text.

◆ xml_escape()

qformat_xml::xml_escape ( $string )

Take a string, and wrap it in a CDATA secion, if that is required to make the output XML valid.

Parameters

string $string a string

Return values

string the string, wrapped in CDATA if necessary.

Member Data Documentation

◆ $qtypeconvert

qformat_default::$qtypeconvert

inherited

Initial value:

= array('numerical'   => LESSON_PAGE_NUMERICAL,
                               'multichoice' => LESSON_PAGE_MULTICHOICE,
                               'truefalse'   => LESSON_PAGE_TRUEFALSE,
                               'shortanswer' => LESSON_PAGE_SHORTANSWER,
                               'match'       => LESSON_PAGE_MATCHING,
                               'essay'       => LESSON_PAGE_ESSAY
                              )

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

question/format/xml/format.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_blank_combined_feedback()

◆ assemble_category_path()

◆ can_import_file()

◆ clean_question_name() [1/2]

◆ clean_question_name() [2/2]

◆ count_questions() [1/2]

◆ count_questions() [2/2]

◆ create_category_path()

◆ create_default_question_name() [1/2]

◆ create_default_question_name() [2/2]

◆ create_dummy_question_representing_category()

◆ defaultquestion() [1/2]

◆ defaultquestion() [2/2]

◆ error()

◆ export_file_extension()

◆ exportpostprocess()

◆ exportpreprocess()

◆ exportprocess()

◆ format()

◆ get_category_path()

◆ get_format()

◆ get_name()

◆ get_qtype()

◆ get_single()

◆ getpath()

◆ import_answer()

◆ import_calculated()

◆ import_category()

◆ import_combined_feedback()

◆ import_description()

◆ import_essay()

◆ import_files()

◆ import_headers()

◆ import_hint()

◆ import_hints()

◆ import_match()

◆ import_multianswer()

◆ import_multichoice()

◆ import_numerical()

◆ import_question()

◆ import_question_tags()

◆ import_questions()

◆ import_shortanswer()

◆ import_text()

◆ import_truefalse()

◆ importpostprocess() [1/2]

◆ importpostprocess() [2/2]

◆ importpreprocess()

◆ importprocess()

◆ mime_type()

◆ presave_process()

◆ provide_export()

◆ provide_import()

◆ readdata() [1/2]

◆ readdata() [2/2]

◆ readquestion()

◆ readquestions()

◆ set_can_access_backupdata()

◆ set_display_progress()

◆ setCategory()

◆ setCatfromfile()

◆ setCattofile()

◆ setContextfromfile()

◆ setContexts()

◆ setContexttofile()

◆ setCourse()

◆ setFilename()

◆ setMatchgrades()

◆ setQuestions()

◆ setRealfilename()

◆ setStoponerror()

◆ split_category_path()

◆ trans_format()

◆ trans_single()