ilCategoryExporter Class Reference

Class for category export. More...

Inheritance diagram for ilCategoryExporter:

Collaboration diagram for ilCategoryExporter:

Public Member Functions
	getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. More...
	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml. More...
	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...
	init ()
	Init method. More...
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...

Additional Inherited Members
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...
Protected Attributes inherited from ilXmlExporter
	$dir_relative
	$dir_absolute
	$exp

Detailed Description

Class for category export.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e $Id$

Definition at line 12 of file class.ilCategoryExporter.php.

Member Function Documentation

getValidSchemaVersions()

ilCategoryExporter::getValidSchemaVersions

(

$a_entity

)

Returns schema versions that the component can export to.

ILIAS chooses the first one, that has min/max constraints which fit to the target release. Please put the newest on top.

Returns

Definition at line 122 of file class.ilCategoryExporter.php.

References array.

    {
        return array(
            "4.3.0" => array(
                "namespace" => "http://www.ilias.de/Modules/Category/cat/4_3",
                "xsd_file" => "ilias_cat_4_3.xsd",
                "uses_dataset" => false,
                "min" => "4.3.0",
                "max" => "")
        );
    }

getXmlExportHeadDependencies()

ilCategoryExporter::getXmlExportHeadDependencies	(		$a_entity,
			$a_target_release,
			$a_ids
	)

Get head dependencies.

Parameters

string	entity
string	target release
array	ids

Returns

array array of array with keys "component", entity", "ids"

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

References array.

    {
        // always trigger container because of co-page(s)
        return array(
            array(
                'component'             => 'Services/Container',
                'entity'                => 'struct',
                'ids'                   => $a_ids
            )
        );
        
        /*
        include_once './Services/Export/classes/class.ilExportOptions.php';
        $eo = ilExportOptions::getInstance();

        $obj_id = end($a_ids);


        $GLOBALS['ilLog']->write(__METHOD__.': '.$obj_id);
        if($eo->getOption(ilExportOptions::KEY_ROOT) != $obj_id)
        {
            return array();
        }

        if(count(ilExportOptions::getInstance()->getSubitemsForExport()) > 1)
        {
            return array(
                array(
                    'component'         => 'Services/Container',
                    'entity'            => 'struct',
                    'ids'                       => $a_ids
                )
            );
        }
        return array();
        */
    }

getXmlExportTailDependencies()

ilCategoryExporter::getXmlExportTailDependencies	(		$a_entity,
			$a_target_release,
			$a_ids
	)

Get tail dependencies.

Parameters

string	entity
string	target release
array	ids

Returns

array array of array with keys "component", entity", "ids"

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

References $id, array, and ilObjTaxonomy\getUsageOfObject().

    {
        if ($a_entity == "cat") {
            include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
            $tax_ids = array();
            foreach ($a_ids as $id) {
                $t_ids = ilObjTaxonomy::getUsageOfObject($id);
                if (count($t_ids) > 0) {
                    $tax_ids[$t_ids[0]] = $t_ids[0];
                }
            }

            return array(
                array(
                    "component" => "Services/Taxonomy",
                    "entity" => "tax",
                    "ids" => $tax_ids)
                );
        }
        return array();
    }

Here is the call graph for this function:

getXmlRepresentation()

ilCategoryExporter::getXmlRepresentation	(		$a_entity,
			$a_schema_version,
			$a_id
	)

Get xml.

Parameters

object	$a_entity
object	$a_schema_version
object	$a_id

Returns

Definition at line 97 of file class.ilCategoryExporter.php.

References $GLOBALS, ilObject\_getAllReferences(), ilObjectFactory\getInstanceByRefId(), and ilCategoryXmlWriter\MODE_EXPORT.

    {
        $cat_ref_id = end(ilObject::_getAllReferences($a_id));
        $category = ilObjectFactory::getInstanceByRefId($cat_ref_id, false);

        if (!$category instanceof ilObjCategory) {
            $GLOBALS['ilLog']->write(__METHOD__ . $a_id . ' is not instance of type category!');
            return '';
        }

        include_once './Modules/Category/classes/class.ilCategoryXmlWriter.php';

        $writer = new ilCategoryXmlWriter($category);
        $writer->setMode(ilCategoryXmlWriter::MODE_EXPORT);
        $writer->export(false);
        return $writer->getXml();
    }

Here is the call graph for this function:

init()

ilCategoryExporter::init

(

)

Init method.

Definition at line 137 of file class.ilCategoryExporter.php.

    {
    }

---

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

• Modules/Category/classes/class.ilCategoryExporter.php