ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilXmlImporter Class Reference

Xml importer class. More...

+ Inheritance diagram for ilXmlImporter:
+ Collaboration diagram for ilXmlImporter:

Public Member Functions

 __construct ()
 Constructor. More...
 
 setImport ($a_val)
 Set import. More...
 
 getImport ()
 Get import. More...
 
 init ()
 Init. More...
 
 setInstallId ($a_val)
 Set installation id. More...
 
 getInstallId ()
 Get installation id. More...
 
 setInstallUrl ($a_val)
 Set installation url. More...
 
 getInstallUrl ()
 Get installation url. More...
 
 setSchemaVersion ($a_val)
 Set schema version. More...
 
 getSchemaVersion ()
 Get schema version. More...
 
 setImportDirectory ($a_val)
 Set import directory. More...
 
 getImportDirectory ()
 Get import directory. More...
 
 setSkipEntities ($a_val)
 Set skip entities. More...
 
 getSkipEntities ()
 Get skip entities. More...
 
 exportedFromSameInstallation ()
 Is exporting and importing installation identical? More...
 
 importXmlRepresentation ($a_entity, $a_id, $a_xml, $a_mapping)
 Import xml representation. More...
 
 finalProcessing ($a_mapping)
 Final processing. More...
 
 afterContainerImportProcessing (ilImportMapping $mapping)
 Called after all container objects have been implemented. More...
 

Protected Attributes

 $skip_entities = array()
 
 $imp
 

Detailed Description

Xml importer class.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 11 of file class.ilXmlImporter.php.

Constructor & Destructor Documentation

◆ __construct()

ilXmlImporter::__construct ( )

Constructor.

Parameters

Definition at line 22 of file class.ilXmlImporter.php.

23  {
24  }

Member Function Documentation

◆ afterContainerImportProcessing()

ilXmlImporter::afterContainerImportProcessing ( ilImportMapping  $mapping)

Called after all container objects have been implemented.

Parameters
ilImportMapping$mapping

Definition at line 191 of file class.ilXmlImporter.php.

192  {
193  }

◆ exportedFromSameInstallation()

ilXmlImporter::exportedFromSameInstallation ( )

Is exporting and importing installation identical?

Parameters

Definition at line 158 of file class.ilXmlImporter.php.

References getInstallId(), and importXmlRepresentation().

Referenced by ilGlossaryImporter\finalProcessing().

159  {
160  if ($this->getInstallId() > 0 && ($this->getInstallId() == IL_INST_ID)) {
161  return true;
162  }
163  return false;
164  }
getInstallId()
Get installation id.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ finalProcessing()

ilXmlImporter::finalProcessing (   $a_mapping)

Final processing.

Parameters
arraymapping array

Definition at line 182 of file class.ilXmlImporter.php.

Referenced by ilCOPageImporter\importXmlRepresentation().

183  {
184  }
+ Here is the caller graph for this function:

◆ getImport()

ilXmlImporter::getImport ( )

Get import.

Returns
ilImport import object

Definition at line 41 of file class.ilXmlImporter.php.

References $imp.

Referenced by ilSurveyImporter\importXmlRepresentation(), ilGlossaryImporter\init(), ilMediaPoolImporter\init(), ilMediaObjectsImporter\init(), ilHelpImporter\init(), and ilLearningModuleImporter\init().

42  {
43  return $this->imp;
44  }
+ Here is the caller graph for this function:

◆ getImportDirectory()

◆ getInstallId()

ilXmlImporter::getInstallId ( )

Get installation id.

Returns
string installation id

Definition at line 67 of file class.ilXmlImporter.php.

Referenced by exportedFromSameInstallation(), ilTestQuestionPoolImporter\importQuestionSkillAssignments(), ilTestImporter\importQuestionSkillAssignments(), ilTestImporter\importSkillLevelThresholds(), ilChatroomImporter\importXmlRepresentation(), and ilForumImporter\importXmlRepresentation().

68  {
69  return $this->install_id;
70  }
+ Here is the caller graph for this function:

◆ getInstallUrl()

ilXmlImporter::getInstallUrl ( )

Get installation url.

Returns
string installation url

Definition at line 87 of file class.ilXmlImporter.php.

88  {
89  return $this->install_url;
90  }

◆ getSchemaVersion()

ilXmlImporter::getSchemaVersion ( )

Get schema version.

Returns
string schema version

Definition at line 107 of file class.ilXmlImporter.php.

Referenced by ilScormAiccImporter\handleEditableLmXml(), ilForumImporter\importXmlRepresentation(), ilContentPageImporter\importXmlRepresentation(), ilIndividualAssessmentImporter\importXmlRepresentation(), ilGlossaryImporter\importXmlRepresentation(), ilStyleImporter\importXmlRepresentation(), ilExerciseImporter\importXmlRepresentation(), ilNotesImporter\importXmlRepresentation(), ilTaxonomyImporter\importXmlRepresentation(), ilSessionImporter\importXmlRepresentation(), ilPollImporter\importXmlRepresentation(), ilWikiImporter\importXmlRepresentation(), ilBookmarksImporter\importXmlRepresentation(), ilItemGroupImporter\importXmlRepresentation(), ilCalendarImporter\importXmlRepresentation(), ilExternalFeedImporter\importXmlRepresentation(), ilMediaCastImporter\importXmlRepresentation(), ilNewsImporter\importXmlRepresentation(), ilRatingImporter\importXmlRepresentation(), ilBlogImporter\importXmlRepresentation(), ilUserImporter\importXmlRepresentation(), ilHTMLLearningModuleImporter\importXmlRepresentation(), ilPortfolioImporter\importXmlRepresentation(), ilBibliographicImporter\importXmlRepresentation(), ilDataCollectionImporter\importXmlRepresentation(), ilMediaObjectsImporter\importXmlRepresentation(), ilObjectImporter\importXmlRepresentation(), ilSkillImporter\importXmlRepresentation(), ilMediaPoolImporter\importXmlRepresentation(), ilHelpImporter\importXmlRepresentation(), ilLearningModuleImporter\importXmlRepresentation(), ilCOPageImporter\importXmlRepresentation(), and ilSurveyImporter\importXmlRepresentation().

108  {
109  return $this->schema_version;
110  }
+ Here is the caller graph for this function:

◆ getSkipEntities()

ilXmlImporter::getSkipEntities ( )

Get skip entities.

Returns
array entities to skip

Definition at line 147 of file class.ilXmlImporter.php.

References $skip_entities.

148  {
149  return $this->skip_entities;
150  }

◆ importXmlRepresentation()

ilXmlImporter::importXmlRepresentation (   $a_entity,
  $a_id,
  $a_xml,
  $a_mapping 
)
abstract

Import xml representation.

Parameters
stringentity
stringtarget release
stringid
Returns
string xml string

Referenced by exportedFromSameInstallation(), and ilContainerReferenceImporter\getReference().

+ Here is the caller graph for this function:

◆ init()

ilXmlImporter::init ( )

Init.

Definition at line 48 of file class.ilXmlImporter.php.

49  {
50  }

◆ setImport()

ilXmlImporter::setImport (   $a_val)

Set import.

Parameters
ilImport$a_valimport object

Definition at line 31 of file class.ilXmlImporter.php.

32  {
33  $this->imp = $a_val;
34  }

◆ setImportDirectory()

ilXmlImporter::setImportDirectory (   $a_val)

Set import directory.

Parameters
stringimport directory

Definition at line 117 of file class.ilXmlImporter.php.

118  {
119  $this->import_directory = $a_val;
120  }

◆ setInstallId()

ilXmlImporter::setInstallId (   $a_val)

Set installation id.

Parameters
stringinstallation id

Definition at line 57 of file class.ilXmlImporter.php.

58  {
59  $this->install_id = $a_val;
60  }

◆ setInstallUrl()

ilXmlImporter::setInstallUrl (   $a_val)

Set installation url.

Parameters
stringinstallation url

Definition at line 77 of file class.ilXmlImporter.php.

78  {
79  $this->install_url = $a_val;
80  }

◆ setSchemaVersion()

ilXmlImporter::setSchemaVersion (   $a_val)

Set schema version.

Parameters
stringschema version

Definition at line 97 of file class.ilXmlImporter.php.

98  {
99  $this->schema_version = $a_val;
100  }

◆ setSkipEntities()

ilXmlImporter::setSkipEntities (   $a_val)

Set skip entities.

Parameters
array$a_valentities to skip

Definition at line 137 of file class.ilXmlImporter.php.

138  {
139  $this->skip_entities = $a_val;
140  }

Field Documentation

◆ $imp

ilXmlImporter::$imp
protected

Definition at line 14 of file class.ilXmlImporter.php.

Referenced by getImport().

◆ $skip_entities

ilXmlImporter::$skip_entities = array()
protected

Definition at line 13 of file class.ilXmlImporter.php.

Referenced by getSkipEntities().


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