ilPageComponentPluginImporter Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPageComponentPluginImporter:

Collaboration diagram for ilPageComponentPluginImporter:

Static Public Member Functions
static	setPCProperties (string $a_id, array $a_properties)
	Set the properties of a plugged page content This method is used by ilCOPageExporter to provide the properties. More...
static	getPCProperties (string $a_id)
	Get the properties of a plugged page content. More...
static	setPCVersion (string $a_id, string $a_version)
	Set the version of a plugged page content This method is used by ilCOPageExporter to provide the version. More...
static	getPCVersion (string $a_id)
	Get the version of a plugged page content. More...
static	getPCMapping (string $a_id, ilImportMapping $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 array	$pc_properties = array()
static array	$pc_version = array()

Additional Inherited Members
Public Member Functions inherited from ilXmlImporter
	__construct ()
	setImport (ilImport $a_val)
	getImport ()
	init ()
	setInstallId (string $a_val)
	getInstallId ()
	setInstallUrl (string $a_val)
	getInstallUrl ()
	setSchemaVersion (string $a_val)
	getSchemaVersion ()
	setImportDirectory (string $a_val)
	getImportDirectory ()
	setSkipEntities (array $a_val)
	getSkipEntities ()
	exportedFromSameInstallation ()
	importXmlRepresentation (string $a_entity, string $a_id, string $a_xml, ilImportMapping $a_mapping)
	finalProcessing (ilImportMapping $a_mapping)
	afterContainerImportProcessing (ilImportMapping $mapping)
Protected Attributes inherited from ilXmlImporter
array	$skip_entities = array()
ilImport	$imp
string	$install_id
string	$install_url
string	$schema_version
string	$import_directory

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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

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

Member Function Documentation

getPCMapping()

static ilPageComponentPluginImporter::getPCMapping ( string  $a_id, ilImportMapping  $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()

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

References $parts, and ilImportMapping\getMapping().

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

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

Here is the call graph for this function:

getPCProperties()

static ilPageComponentPluginImporter::getPCProperties ( string  $a_id )

static

Get the properties of a plugged page content.

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

References null.

Referenced by ilCOPageImporter\afterContainerImportProcessing().

                                                        : ?array
    {
        return self::$pc_properties[$a_id] ?? null;
    }

Here is the caller graph for this function:

getPCVersion()

static ilPageComponentPluginImporter::getPCVersion ( string  $a_id )

static

Get the version of a plugged page content.

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

References null.

Referenced by ilCOPageImporter\afterContainerImportProcessing().

                                                     : ?string
    {
        return self::$pc_version[$a_id] ?? null;
    }

Here is the caller graph for this function:

setPCProperties()

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

static

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

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

Referenced by ilCOPageImporter\afterContainerImportProcessing().

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

Here is the caller graph for this function:

setPCVersion()

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

static

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

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

Referenced by ilCOPageImporter\afterContainerImportProcessing().

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

Here is the caller graph for this function:

Field Documentation

$pc_properties

array ilPageComponentPluginImporter::$pc_properties = array()

staticprotected

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

$pc_version

array ilPageComponentPluginImporter::$pc_version = array()

staticprotected

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

---

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

• components/ILIAS/COPage/classes/class.ilPageComponentPluginImporter.php