ilPageComponentPluginImporter Class Reference

Abstract parent class for all page component plugin importer classes. More...

Inheritance diagram for ilPageComponentPluginImporter:

Collaboration diagram for ilPageComponentPluginImporter:

Static Public Member Functions
static	setPCProperties ($a_id, $a_properties)
	Set the properties of a plugged page content This method is used by ilCOPageExporter to provide the properties. More...
static	getPCProperties ($a_id)
	Get the properties of a plugged page content. More...
static	setPCVersion ($a_id, $a_version)
	Set the version of a plugged page content This method is used by ilCOPageExporter to provide the version. More...
static	getPCVersion ($a_id)
	Get the version of a plugged page content. More...
static	getPCMapping ($a_id, $a_mapping)
	Get the id of the mapped page content The id structure should be irrelevant to child classes The mapped ID shold be used both for getPCProperties() and setPCProperties() when being called in their importXmlRepresentation() More...

Static Protected Attributes
static	$pc_properties = array()
static	$pc_version = array()

Additional Inherited Members
Public Member Functions inherited from ilXmlImporter
	__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 inherited from ilXmlImporter
	$skip_entities = array()
	$imp

Detailed Description

Abstract parent class for all page component plugin importer classes.

Author

Fred Neumann fred..nosp@m.neum.nosp@m.ann@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 15 of file class.ilPageComponentPluginImporter.php.

Member Function Documentation

getPCMapping()

static ilPageComponentPluginImporter::getPCMapping (   $a_id,   $a_mapping  )

static

Get the id of the mapped page content The id structure should be irrelevant to child classes The mapped ID shold be used both for getPCProperties() and setPCProperties() when being called in their importXmlRepresentation()

Parameters

string	$a_id
ilImportMapping	$a_mapping

Definition at line 99 of file class.ilPageComponentPluginImporter.php.

    {
        $parts = explode(':', $a_id);
        $old_page_id = $parts[0] . ':' . $parts[1];
        $new_page_id = $a_mapping->getMapping("Services/COPage", 'pg', $old_page_id);

        return $new_page_id . ':' . $parts[2] . ':' . $parts[3];
    }

getPCProperties()

static ilPageComponentPluginImporter::getPCProperties (   $a_id )

static

Get the properties of a plugged page content.

Parameters

string

$a_id

Returns

mixed|null

Definition at line 53 of file class.ilPageComponentPluginImporter.php.

Referenced by ilCOPageImporter\importXmlRepresentation().

    {
        if (isset(self::$pc_properties[$a_id])) {
            return self::$pc_properties[$a_id];
        } else {
            return null;
        }
    }

Here is the caller graph for this function:

getPCVersion()

static ilPageComponentPluginImporter::getPCVersion (   $a_id )

static

Get the version of a plugged page content.

Parameters

string

$a_id

Returns

string|null

Definition at line 80 of file class.ilPageComponentPluginImporter.php.

Referenced by ilCOPageImporter\importXmlRepresentation().

    {
        if (isset(self::$pc_version[$a_id])) {
            return self::$pc_version[$a_id];
        } else {
            return null;
        }
    }

Here is the caller graph for this function:

setPCProperties()

static ilPageComponentPluginImporter::setPCProperties (   $a_id,   $a_properties  )

static

Set the properties of a plugged page content This method is used by ilCOPageExporter to provide the properties.

Parameters

string	$a_id
array	$a_properties

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

Referenced by ilCOPageImporter\importXmlRepresentation().

    {
        self::$pc_properties[$a_id] = $a_properties;
    }

Here is the caller graph for this function:

setPCVersion()

static ilPageComponentPluginImporter::setPCVersion (   $a_id,   $a_version  )

static

Set the version of a plugged page content This method is used by ilCOPageExporter to provide the version.

Parameters

string	$a_id
string	$a_version

Definition at line 69 of file class.ilPageComponentPluginImporter.php.

Referenced by ilCOPageImporter\importXmlRepresentation().

    {
        self::$pc_version[$a_id] = $a_version;
    }

Here is the caller graph for this function:

Field Documentation

$pc_properties

ilPageComponentPluginImporter::$pc_properties = array()

staticprotected

Definition at line 25 of file class.ilPageComponentPluginImporter.php.

$pc_version

ilPageComponentPluginImporter::$pc_version = array()

staticprotected

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

---

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

• Services/COPage/classes/class.ilPageComponentPluginImporter.php