Inheritance diagram for ilOrgUnitExporter:

Collaboration diagram for ilOrgUnitExporter:

Public Member Functions
	simpleExport ($orgu_ref_id)

	simpleExportExcel ($orgu_ref_id)

	sendAndCreateSimpleExportFile ()

Public Member Functions inherited from ilCategoryExporter
	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...

Protected Member Functions
	buildExternalId ($orgu_ref_id)

Private Member Functions
	getStructure ($root_node_ref)

	getAttributesForOrgu ($orgu)

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 ilOrgUnitExporter.

Author: : Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; : Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 13 of file class.ilOrgUnitExporter.php.

Member Function Documentation

◆ buildExternalId()

ilOrgUnitExporter::buildExternalId ( $orgu_ref_id )

protected

Parameters

$orgu_ref_id int

Returns: string

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

                                                         {
                return "orgu_".CLIENT_ID."_".$orgu_ref_id;
        }

Referenced by getAttributesForOrgu(), and simpleExport().

Here is the caller graph for this function:

◆ getAttributesForOrgu()

ilOrgUnitExporter::getAttributesForOrgu ( $orgu )

private

Parameters

$orgu ilObjOrgUnit

Returns: array

Definition at line 152 of file class.ilOrgUnitExporter.php.

                                                    {
                global $DIC;
                $tree = $DIC['tree'];
                $parent_ref = $tree->getParentId($orgu->getRefId());
                if($parent_ref != ilObjOrgUnit::getRootOrgRefId()){
                        $ou_parent_id = $this->buildExternalId($parent_ref);
                } else {
                        $ou_parent_id = "__ILIAS";
                }
                // Only the ref id is guaranteed to be unique.
                $ref_id = $orgu->getRefId();
                $attr = array("ou_id" => $this->buildExternalId($ref_id), "ou_id_type" => "external_id", "ou_parent_id" => $ou_parent_id, "ou_parent_id_type" => "external_id", "action" => "create");
                return $attr;
        }

References $DIC, $ref_id, buildExternalId(), and ilObjOrgUnit\getRootOrgRefId().

Referenced by simpleExport(), and simpleExportExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStructure()

ilOrgUnitExporter::getStructure ( $root_node_ref )

private

Definition at line 132 of file class.ilOrgUnitExporter.php.

                                                     {
                global $DIC;
                $tree = $DIC['tree'];
                $open = array($root_node_ref);
                $closed = array();
                while(count($open)){
                        $current = array_shift($open);
                        $closed[] = $current;
                        foreach($tree->getChildsByType($current, "orgu") as $new){
                                if(!in_array($new["child"], $closed) && !in_array($new["child"], $open))
                                        $open[] = $new["child"];
                        }
                }
                return $closed;
        }

References $DIC, and $new.

Referenced by simpleExport(), and simpleExportExcel().

Here is the caller graph for this function:

◆ sendAndCreateSimpleExportFile()

ilOrgUnitExporter::sendAndCreateSimpleExportFile ( )

Definition at line 91 of file class.ilOrgUnitExporter.php.

                                                       {
                $orgu_id = ilObjOrgUnit::getRootOrgId();
                $orgu_ref_id = ilObjOrgUnit::getRootOrgRefId();
 
                ilExport::_createExportDirectory($orgu_id, "xml", "orgu");
                $export_dir = ilExport::_getExportDirectory($orgu_id, "xml", "orgu");
                $ts = time();
 
                // Workaround for test assessment
                $sub_dir = $ts.'__'.IL_INST_ID.'__'."orgu".'_'.$orgu_id."";
                $new_file = $sub_dir.'.zip';
 
                $export_run_dir = $export_dir."/".$sub_dir;
                ilUtil::makeDirParents($export_run_dir);
 
                $writer = $this->simpleExport($orgu_ref_id);
                $writer->xmlDumpFile($export_run_dir."/manifest.xml", false);
 
                // zip the file
                ilUtil::zip($export_run_dir , $export_dir."/".$new_file);
                ilUtil::delDir($export_run_dir );
 
                // Store info about export
                include_once './Services/Export/classes/class.ilExportFileInfo.php';
                $exp = new ilExportFileInfo($orgu_id);
                $exp->setVersion(ILIAS_VERSION_NUMERIC);
                $exp->setCreationDate(new ilDateTime($ts,IL_CAL_UNIX));
                $exp->setExportType('xml');
                $exp->setFilename($new_file);
                $exp->create();
 
                ilUtil::deliverFile($export_dir."/".$new_file,
                        $new_file);
 
                return array(
                        "success" => true,
                        "file" => $new_file,
                        "directory" => $export_dir
                );
        }

References ilXmlExporter\$exp, ilExport\_createExportDirectory(), ilExport\_getExportDirectory(), ilUtil\delDir(), ilUtil\deliverFile(), ilObjOrgUnit\getRootOrgId(), ilObjOrgUnit\getRootOrgRefId(), IL_CAL_UNIX, ILIAS_VERSION_NUMERIC, ilUtil\makeDirParents(), simpleExport(), and ilUtil\zip().

Here is the call graph for this function:

◆ simpleExport()

ilOrgUnitExporter::simpleExport ( $orgu_ref_id )

Definition at line 17 of file class.ilOrgUnitExporter.php.

                                                  {
                $nodes = $this->getStructure($orgu_ref_id);
                $writer = new ilXmlWriter();
                $writer->xmlHeader();
                $writer->xmlStartTag("OrgUnits");
                foreach($nodes as $orgu_ref_id){
                        $orgu = new ilObjOrgUnit($orgu_ref_id);
                        if($orgu->getRefId() == ilObjOrgUnit::getRootOrgRefId())
                                continue;
                        $attributes = $this->getAttributesForOrgu($orgu);
                        $writer->xmlStartTag("OrgUnit", $attributes);
                        $writer->xmlElement("external_id", null, $this->buildExternalId($orgu_ref_id));
                        $writer->xmlElement("title", null, $orgu->getTitle());
                        $writer->xmlElement("description", null, $orgu->getDescription());
                        $writer->xmlEndTag("OrgUnit");
                }
                $writer->xmlEndTag("OrgUnits");
                return $writer;
        }

References buildExternalId(), getAttributesForOrgu(), ilObjOrgUnit\getRootOrgRefId(), and getStructure().

Referenced by sendAndCreateSimpleExportFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ simpleExportExcel()

ilOrgUnitExporter::simpleExportExcel ( $orgu_ref_id )

Parameters

$orgu_ref_id

Definition at line 49 of file class.ilOrgUnitExporter.php.

                                                        {
                // New File and Sheet
                $file_name = "org_unit_export_" . $orgu_ref_id;
                require_once('./Services/Excel/classes/class.ilExcel.php');
                $worksheet = new ilExcel();
                $worksheet->addSheet('org_units');
                $row = 1;
 
                // Headers
                $worksheet->setCell($row, 0, "ou_id");
                $worksheet->setCell($row, 1, "ou_id_type");
                $worksheet->setCell($row, 2, "ou_parent_id");
                $worksheet->setCell($row, 3, "ou_parent_id_type");
                $worksheet->setCell($row, 4, "reference_id");
                $worksheet->setCell($row, 5, "external_id");
                $worksheet->setCell($row, 6, "title");
                $worksheet->setCell($row, 7, "description");
                $worksheet->setCell($row, 8, "action");
 
                // Rows
                $nodes = $this->getStructure($orgu_ref_id);
 
                foreach ($nodes as $node) {
                        $orgu = new ilObjOrgUnit($node);
                        if ($orgu->getRefId() == ilObjOrgUnit::getRootOrgRefId()) {
                                continue;
                        }
                        $row ++;
                        $attrs = $this->getAttributesForOrgu($orgu);
                        $worksheet->setCell($row, 0, $attrs["ou_id"]);
                        $worksheet->setCell($row, 1, $attrs["ou_id_type"]);
                        $worksheet->setCell($row, 2, $attrs["ou_parent_id"]);
                        $worksheet->setCell($row, 3, $attrs["ou_parent_id_type"]);
                        $worksheet->setCell($row, 4, $orgu->getRefId());
                        $worksheet->setCell($row, 5, $orgu->getImportId());
                        $worksheet->setCell($row, 6, $orgu->getTitle());
                        $worksheet->setCell($row, 7, $orgu->getDescription());
                        $worksheet->setCell($row, 8, "create");
                }
                $worksheet->sendToClient($file_name);
        }

References $row, $worksheet, getAttributesForOrgu(), ilObjOrgUnit\getRootOrgRefId(), and getStructure().

Here is the call graph for this function:

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

Modules/OrgUnit/classes/class.ilOrgUnitExporter.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ buildExternalId()

◆ getAttributesForOrgu()

◆ getStructure()

◆ sendAndCreateSimpleExportFile()

◆ simpleExport()

◆ simpleExportExcel()