ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
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 
25  }

Member Function Documentation

◆ afterContainerImportProcessing()

ilXmlImporter::afterContainerImportProcessing ( ilImportMapping  $mapping)

Called after all container objects have been implemented.

Parameters
ilImportMapping$mapping

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

195  {
196 
197  }

◆ exportedFromSameInstallation()

ilXmlImporter::exportedFromSameInstallation ( )

Is exporting and importing installation identical?

Parameters

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

References getInstallId(), and importXmlRepresentation().

Referenced by ilGlossaryImporter\finalProcessing().

160  {
161  if ($this->getInstallId() > 0 && ($this->getInstallId() == IL_INST_ID))
162  {
163  return true;
164  }
165  return false;
166  }
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 184 of file class.ilXmlImporter.php.

Referenced by ilCOPageImporter\importXmlRepresentation().

185  {
186 
187  }
+ Here is the caller graph for this function:

◆ getImport()

ilXmlImporter::getImport ( )

Get import.

Returns
ilImport import object

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

References $imp.

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

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

◆ getImportDirectory()

◆ getInstallId()

ilXmlImporter::getInstallId ( )

Get installation id.

Returns
string installation id

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

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

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

◆ getInstallUrl()

ilXmlImporter::getInstallUrl ( )

Get installation url.

Returns
string installation url

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

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

◆ getSchemaVersion()

ilXmlImporter::getSchemaVersion ( )

Get schema version.

Returns
string schema version

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

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

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

◆ getSkipEntities()

ilXmlImporter::getSkipEntities ( )

Get skip entities.

Returns
array entities to skip

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

References $skip_entities.

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

◆ 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().

+ Here is the caller graph for this function:

◆ init()

ilXmlImporter::init ( )

Init.

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

50  {
51  }

◆ setImport()

ilXmlImporter::setImport (   $a_val)

Set import.

Parameters
ilImport$a_valimport object

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

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

◆ setImportDirectory()

ilXmlImporter::setImportDirectory (   $a_val)

Set import directory.

Parameters
stringimport directory

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

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

◆ setInstallId()

ilXmlImporter::setInstallId (   $a_val)

Set installation id.

Parameters
stringinstallation id

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

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

◆ setInstallUrl()

ilXmlImporter::setInstallUrl (   $a_val)

Set installation url.

Parameters
stringinstallation url

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

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

◆ setSchemaVersion()

ilXmlImporter::setSchemaVersion (   $a_val)

Set schema version.

Parameters
stringschema version

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

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

◆ setSkipEntities()

ilXmlImporter::setSkipEntities (   $a_val)

Set skip entities.

Parameters
array$a_valentities to skip

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

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

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: