Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
moodle1_assignment_subplugin_handler Class Reference

Base class for the assignment subplugin handler Extend this for your own subplugin conversion handling purposes. More...

Inheritance diagram for moodle1_assignment_subplugin_handler:
moodle1_submod_handler moodle1_plugin_handler moodle1_xml_handler moodle1_handler loggable moodle1_assignment_unsupported_subplugin_handler moodle1_mod_assignment_offline_subplugin_handler moodle1_mod_assignment_online_subplugin_handler moodle1_mod_assignment_upload_subplugin_handler moodle1_mod_assignment_uploadsingle_subplugin_handler

Public Member Functions

 __construct (moodle1_mod_handler $assignmenthandler, $subpluginname)
 
 append_subplugin_data ($data)
 a call back (entry point) to the subplugin conversion handler class. More...
 
 get_component_name ()
 Returns the normalized name of the plugin, eg mod_workshop. More...
 
 get_converter ()
 
 get_paths ()
 Activity module subplugins can't declare any paths to handle. More...
 
 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. More...
 
 use_xml_writer (xml_writer $xmlwriter)
 Provides a xml_writer instance to this assignment subplugin type handler. More...
 

Protected Member Functions

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

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 assignment subplugin handler Extend this for your own subplugin conversion handling purposes.

Constructor & Destructor Documentation

◆ __construct()

moodle1_assignment_subplugin_handler::__construct ( moodle1_mod_handler  $assignmenthandler,
  $subpluginname 
)
Parameters
moodle1_mod_handler$assignmenthandlerthe handler of a module we are subplugin of
string$subpluginnamethe name of the subplugin

Member Function Documentation

◆ append_subplugin_data()

moodle1_assignment_subplugin_handler::append_subplugin_data (   $data)

a call back (entry point) to the subplugin conversion handler class.

$data are the elements of <assignment>, any (

Todo:
sub paths containing subplugindata isn't handed through).

◆ 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_converterthe converter that required this handler

◆ get_paths()

moodle1_submod_handler::get_paths ( )
finalinherited

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
arrayempty 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$filenamerelative file name like 'course/course.xml'
string | bool$rootelementroot element to use, false to not create the file
array$contentcontent of the root element
Return values
booltrue 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$filenameXML file name to write into
Return values
void

Reimplemented in moodle1_qtype_handler.

◆ use_xml_writer()

moodle1_assignment_subplugin_handler::use_xml_writer ( xml_writer  $xmlwriter)

Provides a xml_writer instance to this assignment subplugin type handler.

Parameters
xml_writer$xmlwriter

◆ 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$elementthe name of the root element of the tree
array$datathe associative array of data to write
array$attribslist of additional fields written as attributes instead of nested elements
string$parentused internally during the recursion, do not set yourself

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