ilPageComponentPluginExporter 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 ilPageComponentPluginExporter:

Collaboration diagram for ilPageComponentPluginExporter:

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 Public Member Functions inherited from ilXmlExporter
static	lookupExportDirectory (string $a_obj_type, int $a_obj_id, string $a_export_type='xml', string $a_entity="")

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

Additional Inherited Members
Public Member Functions inherited from ilXmlExporter
	__construct ()
	setExport (ilExport $a_exp)
	getExport ()
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	init ()
	setExportDirectories (string $a_dir_relative, string $a_dir_absolute)
	getRelativeExportDirectory ()
	getAbsoluteExportDirectory ()
	getXmlExportHeadDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get tail dependencies. More...
	getValidSchemaVersions (string $a_entity)
	Returns schema versions that the component can export to. More...
	determineSchemaVersion (string $a_entity, string $a_target_release)
Protected Attributes inherited from ilXmlExporter
string	$dir_relative = ""
string	$dir_absolute = ""
ilExport	$exp

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 exporter classes.

Author

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

Definition at line 23 of file class.ilPageComponentPluginExporter.php.

Member Function Documentation

getPCProperties()

static ilPageComponentPluginExporter::getPCProperties ( string  $a_id )

static

Get the properties of a plugged page content.

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

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

getPCVersion()

static ilPageComponentPluginExporter::getPCVersion ( string  $a_id )

static

Get the version of a plugged page content.

Definition at line 76 of file class.ilPageComponentPluginExporter.php.

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

setPCProperties()

static ilPageComponentPluginExporter::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 47 of file class.ilPageComponentPluginExporter.php.

Referenced by ilCOPageExporter\getValidSchemaVersions().

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

Here is the caller graph for this function:

setPCVersion()

static ilPageComponentPluginExporter::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 66 of file class.ilPageComponentPluginExporter.php.

Referenced by ilCOPageExporter\getValidSchemaVersions().

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

Here is the caller graph for this function:

Field Documentation

$pc_properties

array ilPageComponentPluginExporter::$pc_properties = array()

staticprotected

Definition at line 33 of file class.ilPageComponentPluginExporter.php.

$pc_version

array ilPageComponentPluginExporter::$pc_version = array()

staticprotected

Definition at line 40 of file class.ilPageComponentPluginExporter.php.

---

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

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