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

return

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

        {
 
        }

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.

        {
                
        }

exportedFromSameInstallation()

ilXmlImporter::exportedFromSameInstallation

(

)

Is exporting and importing installation identical?

Parameters

return

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

        {
                if ($this->getInstallId() > 0 && ($this->getInstallId() == IL_INST_ID))
                {
                        return true;
                }
                return false;
        }

References getInstallId().

Referenced by ilGlossaryImporter\finalProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

finalProcessing()

ilXmlImporter::finalProcessing

(

$a_mapping

)

Final processing.

Parameters

array

mapping array

Reimplemented in ilBlogImporter, ilCategoryImporter, ilDataCollectionImporter, ilGlossaryImporter, ilLearningModuleImporter, ilMediaCastImporter, ilMediaPoolImporter, ilPortfolioImporter, ilTestQuestionPoolImporter, ilWikiImporter, ilContainerImporter, ilCOPageImporter, and ilUserImporter.

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

        {
 
        }

getImport()

ilXmlImporter::getImport

(

)

Get import.

Returns

ilImport import object

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

        {
                return $this->imp;
        }

References $imp.

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

Here is the caller graph for this function:

getImportDirectory()

ilXmlImporter::getImportDirectory

(

)

Get import directory.

Returns

string import directory

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

        {
                return $this->import_directory;
        }

Referenced by ilTestImporter\getImportDirectoryContainer(), ilTestQuestionPoolImporter\getImportDirectoryContainer(), ilTestImporter\getImportPackageName(), ilTestQuestionPoolImporter\getImportPackageName(), ilBlogImporter\importXmlRepresentation(), ilFileImporter\importXmlRepresentation(), ilForumImporter\importXmlRepresentation(), ilGlossaryImporter\importXmlRepresentation(), ilLearningModuleImporter\importXmlRepresentation(), ilPollImporter\importXmlRepresentation(), ilPortfolioImporter\importXmlRepresentation(), ilTestImporter\importXmlRepresentation(), ilTestQuestionPoolImporter\importXmlRepresentation(), ilStyleImporter\importXmlRepresentation(), ilBibliographicImporter\init(), ilDataCollectionImporter\init(), ilExerciseImporter\init(), ilHTMLLearningModuleImporter\init(), ilMediaObjectsImporter\init(), ilStyleImporter\init(), ilUserImporter\init(), ilSurveyImporter\parseXmlFileNames(), ilSurveyQuestionPoolImporter\parseXmlFileNames(), ilTestImporter\parseXmlFileNames(), and ilTestQuestionPoolImporter\parseXmlFileNames().

Here is the caller graph for this function:

getInstallId()

ilXmlImporter::getInstallId

(

)

Get installation id.

Returns

string installation id

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

        {
                return $this->install_id;
        }

Referenced by exportedFromSameInstallation(), and ilForumImporter\importXmlRepresentation().

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.

        {
                return $this->install_url;
        }

getSchemaVersion()

ilXmlImporter::getSchemaVersion

(

)

Get schema version.

Returns

string schema version

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

        {
                return $this->schema_version;
        }

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

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.

        {
                return $this->skip_entities;
        }

References $skip_entities.

importXmlRepresentation()

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

abstract

Import xml representation.

Parameters

string	entity
string	target release
string	id

Returns

string xml string

Reimplemented in ilBibliographicImporter, ilBlogImporter, ilCategoryImporter, ilCourseImporter, ilDataCollectionImporter, ilExerciseImporter, ilExternalFeedImporter, ilFileImporter, ilFolderImporter, ilForumImporter, ilGlossaryImporter, ilGroupImporter, ilHTMLLearningModuleImporter, ilItemGroupImporter, ilLearningModuleImporter, ilMediaCastImporter, ilMediaPoolImporter, ilOrgUnitImporter, ilPollImporter, ilPortfolioImporter, ilSessionImporter, ilSurveyImporter, ilSurveyQuestionPoolImporter, ilTestImporter, ilTestQuestionPoolImporter, ilWebResourceImporter, ilWikiImporter, ilAccessControlImporter, ilAdvancedMetaDataImporter, ilBookmarksImporter, ilCalendarImporter, ilContainerReferenceImporter, ilCOPageImporter, ilHelpImporter, ilMediaObjectsImporter, ilMetaDataImporter, ilNewsImporter, ilNotesImporter, ilObjectImporter, ilRatingImporter, ilStyleImporter, ilTaxonomyImporter, and ilUserImporter.

init()

ilXmlImporter::init

(

)

Init.

Reimplemented in ilBibliographicImporter, ilBlogImporter, ilCategoryImporter, ilCourseImporter, ilDataCollectionImporter, ilExerciseImporter, ilExternalFeedImporter, ilFolderImporter, ilGlossaryImporter, ilGroupImporter, ilHTMLLearningModuleImporter, ilItemGroupImporter, ilLearningModuleImporter, ilMediaCastImporter, ilMediaPoolImporter, ilPollImporter, ilPortfolioImporter, ilSessionImporter, ilWebResourceImporter, ilWikiImporter, ilAccessControlImporter, ilBookmarksImporter, ilCalendarImporter, ilContainerImporter, ilContainerReferenceImporter, ilCOPageImporter, ilHelpImporter, ilMediaObjectsImporter, ilNewsImporter, ilNotesImporter, ilObjectImporter, ilRatingImporter, ilStyleImporter, ilTaxonomyImporter, and ilUserImporter.

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

        {
        }

setImport()

ilXmlImporter::setImport

(

$a_val

)

Set import.

Parameters

ilImport

$a_val

import object

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

        {
                $this->imp = $a_val;
        }

setImportDirectory()

ilXmlImporter::setImportDirectory

(

$a_val

)

Set import directory.

Parameters

string

import directory

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

        {
                $this->import_directory = $a_val;
        }

setInstallId()

ilXmlImporter::setInstallId

(

$a_val

)

Set installation id.

Parameters

string

installation id

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

        {
                $this->install_id = $a_val;
        }

setInstallUrl()

ilXmlImporter::setInstallUrl

(

$a_val

)

Set installation url.

Parameters

string

installation url

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

        {
                $this->install_url = $a_val;
        }

setSchemaVersion()

ilXmlImporter::setSchemaVersion

(

$a_val

)

Set schema version.

Parameters

string

schema version

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

        {
                $this->schema_version = $a_val;
        }

setSkipEntities()

ilXmlImporter::setSkipEntities

(

$a_val

)

Set skip entities.

Parameters

array

$a_val

entities to skip

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

        {
                $this->skip_entities = $a_val;
        }

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:

• Services/Export/classes/class.ilXmlImporter.php