ilPageComponentPluginExporter Class Reference

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

Inheritance diagram for ilPageComponentPluginExporter:

Collaboration diagram for ilPageComponentPluginExporter:

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

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

Additional Inherited Members
Public Member Functions inherited from ilXmlExporter
	__construct ()
	Constructor. More...
	setExport (ilExport $a_exp)
	Set export object. More...
	getExport ()
	Get export. More...
	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml representation. More...
	init ()
	setExportDirectories ($a_dir_relative, $a_dir_absolute)
	Export directories. More...
	getRelativeExportDirectory ()
	Get relative export directory. More...
	getAbsoluteExportDirectory ()
	Get absolute export directory. More...
	getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. More...
	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...
	determineSchemaVersion ($a_entity, $a_target_release)
	Determine schema version. More...
Protected Attributes inherited from ilXmlExporter
	$dir_relative
	$dir_absolute
	$exp

Detailed Description

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

Version

$Id$

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

Member Function Documentation

getPCProperties()

static ilPageComponentPluginExporter::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.ilPageComponentPluginExporter.php.

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

getPCVersion()

static ilPageComponentPluginExporter::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.ilPageComponentPluginExporter.php.

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

setPCProperties()

static ilPageComponentPluginExporter::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.ilPageComponentPluginExporter.php.

Referenced by ilCOPageExporter\getValidSchemaVersions().

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

Here is the caller graph for this function:

setPCVersion()

static ilPageComponentPluginExporter::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.ilPageComponentPluginExporter.php.

Referenced by ilCOPageExporter\getValidSchemaVersions().

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

Here is the caller graph for this function:

Field Documentation

$pc_properties

ilPageComponentPluginExporter::$pc_properties = array()

staticprotected

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

$pc_version

ilPageComponentPluginExporter::$pc_version = array()

staticprotected

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

---

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

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