qformat_gift Class Reference

The GIFT import filter was designed as an easy to use method for teachers writing questions as a text file. More...

Inheritance diagram for qformat_gift:

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.
	extract_idnumber_and_tags_from_comment (string $comment)
	Extract any tags or idnumber declared in the question comment.
	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)
	readquestion ($lines)
	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
	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_general_feedback ($question, $indent="\t")
	Outputs the general feedback for the question, if any.
	write_idnumber_and_tags (stdClass $questiondata)
	Prepare any question idnumber or tags for export.
	write_name ($name)
	write_questiontext ($text, $format, $defaultformat=FORMAT_MOODLE)
	writequestion ($question)
	convert a single question object into text output in the given format.

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.
	answerweightparser (&$answer)
	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.
	check_answer_count ($min, $answers, $text)
	commentparser ($answer, $defaultformat)
	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.
	escapedchar_post ($string)
	escapedchar_pre ($string)
	exportpostprocess ()
	Do an post-processing that may be required.
	format_const_to_name ($format)
	format_name_to_const ($format)
	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.
	parse_text_with_format ($text, $defaultformat=FORMAT_MOODLE)
	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.
	readquestions ($lines)
	readquestions ($lines)
	Parses an array of lines into an array of questions, where each item is a question object as defined by readquestion().
	repchar ($text, $notused=0)
	split_category_path ($path)
	Convert a string, as returned by assemble_category_path(), back into an array of category names.
	split_truefalse_comment ($answer, $defaultformat)
	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
	$importcontext = null

Detailed Description

The GIFT import filter was designed as an easy to use method for teachers writing questions as a text file.

It supports most question types and the missing word format.

Multiple Choice / Missing Word Who's buried in Grant's tomb?{~Grant ~Jefferson =no one} Grant is {~buried =entombed ~living} in Grant's tomb. True-False: Grant is buried in Grant's tomb.{FALSE} Short-Answer. Who's buried in Grant's tomb?{=no one =nobody} Numerical When was Ulysses S. Grant born?{#1822:5} Matching Match the following countries with their corresponding capitals.{=Canada->Ottawa =Italy->Rome =Japan->Tokyo}

Comment lines start with a double backslash (//). Optional question names are enclosed in double colon(\‍). Answer feedback is indicated with hash mark (#). Percentage answer weights immediately follow the tilde (for multiple choice) or equal sign (for short answer and numerical), and are enclosed in percent signs (% %). See docs and examples.txt for more.

This filter was written through the collaboration of numerous members of the Moodle community. It was originally based on the missingword format, which included code from Thomas Robb and others. Paul Tsuchido Shew wrote this filter in December 2003.

Copyright

2003 Paul Tsuchido Shew

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_gift::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.

extract_idnumber_and_tags_from_comment()

qformat_gift::extract_idnumber_and_tags_from_comment

(

string

$comment

)

Extract any tags or idnumber declared in the question comment.

Parameters

string

$comment

E.g. "// Line 1.::n//Line 2.\n".

Return values

array

with two elements. string $idnumber (or '') and string[] of tags.

format_const_to_name()

qformat_gift::format_const_to_name ( $format )

protected

Parameters

int

$format

one of the FORMAT_ constants.

Return values

string

the corresponding name.

format_name_to_const()

qformat_gift::format_name_to_const ( $format )

protected

Parameters

int

$format

one of the FORMAT_ constants.

Return values

string

the corresponding name.

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_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

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_default::mime_type ( )

inherited

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

Reimplemented in qformat_blackboard_six_base, and qformat_xml.

presave_process()

qformat_default::presave_process ( $content )

protectedinherited

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 in qformat_xml.

provide_export()

qformat_gift::provide_export

(

)

Return values

bool	whether this plugin provides export functionality.

Reimplemented from qformat_default.

provide_import()

qformat_gift::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_gift::readquestion

(

$lines

)

Reimplemented from qformat_default.

readquestions() [1/2]

qformat_default::readquestions ( $lines )

protectedinherited

Reimplemented in qformat_blackboard_six, qformat_blackboard_six_pool, qformat_blackboard_six_qti, and qformat_xml.

readquestions() [2/2]

qformat_default::readquestions ( $lines )

protectedinherited

Parses an array of lines into an array of questions, where each item is a question object as defined by readquestion().

Questions are defined as anything between blank lines.

NOTE this method used to take $context as a second argument. However, at the point where this method was called, it was impossible to know what context the quetsions were going to be saved into, so the value could be wrong. Also, none of the standard question formats were using this argument, so it was removed. See MDL-32220.

If your format does not use blank lines as a delimiter then you will need to override this method. Even then try to use readquestion for each question

Parameters

array

lines array of lines from readdata

Return values

array

array of question objects

Reimplemented in qformat_blackboard_six, qformat_blackboard_six_pool, qformat_blackboard_six_qti, and qformat_xml.

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.

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_gift::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_general_feedback()

qformat_gift::write_general_feedback	(		$question,
			$indent = "\t" )

Outputs the general feedback for the question, if any.

This needs to be the last thing before the }.

Parameters

object	$question	the question data.
string	$indent	to put before the general feedback. Defaults to a tab. If this is not blank, a newline is added after the line.

write_idnumber_and_tags()

qformat_gift::write_idnumber_and_tags

(

stdClass

$questiondata

)

Prepare any question idnumber or tags for export.

Parameters

stdClass

$questiondata

the question data we are exporting.

Return values

string

a string that can be written as a line in the GIFT file, e.g. "// [id:myid] [tag:some-tag]::n". Will be '' if none.

writequestion()

qformat_gift::writequestion

(

$question

)

convert a single question object into text output in the given format.

This must be overriden

Parameters

object

question question object

Return values

mixed

question export text or null if not implemented

Reimplemented from qformat_default.

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/gift/format.php