Difference between revisions of "Developer Area/Import//Export/LEAP Import"

From Mahara Wiki
Jump to navigation Jump to search
(Created page with "Mahara's Leap Import is implemented as a plugin for Mahara's "Import" plugin type. It allows Mahara to import [http://wiki.cetis.ac.…")
 
Line 5: Line 5:
 
<div id="section_1">
 
<div id="section_1">
  
=== Architecture ===
+
===Architecture===
  
 
The Leap import plugin lives in <code>htdocs/import/leap/</code>. The core import algorithm is implemented here, as well as other parts necessary to implement the Mahara import API. Most of the work is done by the PluginImportLeap class, which represents a Leap export and the process of importing it.
 
The Leap import plugin lives in <code>htdocs/import/leap/</code>. The core import algorithm is implemented here, as well as other parts necessary to implement the Mahara import API. Most of the work is done by the PluginImportLeap class, which represents a Leap export and the process of importing it.
Line 15: Line 15:
 
</div><div id="section_2">
 
</div><div id="section_2">
  
=== Importing Algorithm ===
+
===Importing Algorithm===
  
 
This algorithm is still under development. Please see the [[Developer Area/Import//Export/Import: Implementation Plan|implementation plan]] for an exhaustive description of the algorithm as it was planned. The algorithm has not changed much from how that document describes it.
 
This algorithm is still under development. Please see the [[Developer Area/Import//Export/Import: Implementation Plan|implementation plan]] for an exhaustive description of the algorithm as it was planned. The algorithm has not changed much from how that document describes it.
Line 21: Line 21:
 
</div><div id="section_3">
 
</div><div id="section_3">
  
=== Artefact Plugins and Leap Import ===
+
===Artefact Plugins and Leap Import===
  
 
From a Leap export:
 
From a Leap export:
Line 33: Line 33:
 
</div><div id="section_4">
 
</div><div id="section_4">
  
=== Importing from Other Systems ===
+
===Importing from Other Systems===
  
 
We have documented the results of importing from other systems, as well as exporting, in the [[Developer Area/Import//Export/Interoperability|Interoperability]] section.
 
We have documented the results of importing from other systems, as well as exporting, in the [[Developer Area/Import//Export/Interoperability|Interoperability]] section.

Revision as of 15:15, 11 May 2011

Mahara's Leap Import is implemented as a plugin for Mahara's "Import" plugin type. It allows Mahara to import Leap2A files, which Mahara can also export.

Note: A working understanding of the Leap2A spec will help you understand the documentation written here. We suggest you at least partially familiarise yourself with the spec before diving into the code or this documentation.

Architecture

The Leap import plugin lives in htdocs/import/leap/. The core import algorithm is implemented here, as well as other parts necessary to implement the Mahara import API. Most of the work is done by the PluginImportLeap class, which represents a Leap export and the process of importing it.

In addition to this, each artefact plugin can provide the import/leap/lib.php file which the core searches for in order to do most of the heavy lifting. The core Mahara artefact plugins provide this so that, for example, files and blogs in Leap files are imported as files and blogs in Mahara. If you are writing an artefact plugin and your plugin does not supply any artefact type that can be meaningly imported from a Leap file, you don't have to provide the import/leap/ directory at all.

The code uses the PHP extension simplexml to parse the Leap files. This extension is bundled with PHP5 by default, so you're very likely to have it available.

Importing Algorithm

This algorithm is still under development. Please see the implementation plan for an exhaustive description of the algorithm as it was planned. The algorithm has not changed much from how that document describes it.

Artefact Plugins and Leap Import

From a Leap export:

Importing from Other Systems

We have documented the results of importing from other systems, as well as exporting, in the Interoperability section.

You should probably validate incoming Leap2A exports before filing a bug against the Mahara Leap importer.

Files

Subpages