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

Collaboration diagram for ilOrgUnitExporter:

Public Member Functions
	__construct ()
	simpleExport (int $orgu_ref_id)
	simpleExportExcel (int $orgu_ref_id)
	sendAndCreateSimpleExportFile ()
Public Member Functions inherited from ilCategoryExporter
	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)
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	getValidSchemaVersions (string $a_entity)
	Returns schema versions that the component can export to. More...
	init ()
	Init method. More...
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 Member Functions
	getExternalId (int $orgu_ref_id)
	buildExternalId (int $orgu_ref_id)

Private Member Functions
	getStructure (int $root_node_ref)
	getAttributesForOrgu (ilObjOrgUnit $orgu)

Private Attributes
ilTree	$tree

Additional Inherited Members
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="")
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 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 25 of file class.ilOrgUnitExporter.php.

Constructor & Destructor Documentation

__construct()

ilOrgUnitExporter::__construct

(

)

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

    {
        global $DIC;
        parent::__construct();
        $this->tree = $DIC['tree'];
    }

Here is the call graph for this function:

Member Function Documentation

buildExternalId()

ilOrgUnitExporter::buildExternalId ( int  $orgu_ref_id )

protected

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

References CLIENT_ID.

Referenced by getExternalId().

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

Here is the caller graph for this function:

getAttributesForOrgu()

ilOrgUnitExporter::getAttributesForOrgu ( ilObjOrgUnit  $orgu )

private

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

References $ref_id, getExternalId(), ilObject\getRefId(), and ilObjOrgUnit\getRootOrgRefId().

Referenced by simpleExport(), and simpleExportExcel().

                                                             : array
    {
        $parent_ref = $this->tree->getParentId($orgu->getRefId());
        if ($parent_ref != ilObjOrgUnit::getRootOrgRefId()) {
            $ou_parent_id = $this->getExternalId($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->getExternalId($ref_id),
                      "ou_id_type" => "external_id",
                      "ou_parent_id" => $ou_parent_id,
                      "ou_parent_id_type" => "external_id",
                      "action" => "create"
        );

        return $attr;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExternalId()

ilOrgUnitExporter::getExternalId ( int  $orgu_ref_id )

protected

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

References ilObject\_lookupObjectId(), and buildExternalId().

Referenced by getAttributesForOrgu(), and simpleExport().

                                                      : string
    {
        $import_id = ilObjOrgunit::_lookupImportId(ilObjOrgUnit::_lookupObjectId($orgu_ref_id));

        return $import_id ?: $this->buildExternalId($orgu_ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStructure()

ilOrgUnitExporter::getStructure ( int  $root_node_ref )

private

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

Referenced by simpleExport(), and simpleExportExcel().

                                                     : array
    {
        $open = array($root_node_ref);
        $closed = array();
        while (count($open)) {
            $current = array_shift($open);
            $closed[] = $current;
            foreach ($this->tree->getChildsByType($current, "orgu") as $new) {
                if (in_array($new["child"], $closed, true) === false && in_array($new["child"], $open, true) === false) {
                    $open[] = $new["child"];
                }
            }
        }

        return $closed;
    }

Here is the caller graph for this function:

sendAndCreateSimpleExportFile()

ilOrgUnitExporter::sendAndCreateSimpleExportFile

(

)

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

References ilXmlExporter\$exp, ilExport\_createExportDirectory(), ilExport\_getExportDirectory(), ilFileUtils\delDir(), ilFileDelivery\deliverFileLegacy(), ilObjOrgUnit\getRootOrgId(), ilObjOrgUnit\getRootOrgRefId(), IL_CAL_UNIX, IL_INST_ID, ILIAS_VERSION_NUMERIC, ilFileUtils\makeDirParents(), simpleExport(), and ilFileUtils\zip().

                                                   : array
    {
        $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;
        ilFileUtils::makeDirParents($export_run_dir);

        $writer = $this->simpleExport($orgu_ref_id);
        $writer->xmlDumpFile($export_run_dir . "/manifest.xml", false);

        // zip the file
        ilFileUtils::zip($export_run_dir, $export_dir . "/" . $new_file);
        ilFileUtils::delDir($export_run_dir);

        // Store info about export
        $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();

        ilFileDelivery::deliverFileLegacy(
            $export_dir . "/" . $new_file,
            $new_file
        );

        return array(
            "success" => true,
            "file" => $new_file,
            "directory" => $export_dir,
        );
    }

Here is the call graph for this function:

simpleExport()

ilOrgUnitExporter::simpleExport

(

int

$orgu_ref_id

)

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

References $attributes, getAttributesForOrgu(), getExternalId(), ilObjOrgUnit\getRootOrgRefId(), and getStructure().

Referenced by sendAndCreateSimpleExportFile().

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

        return $writer;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

simpleExportExcel()

ilOrgUnitExporter::simpleExportExcel

(

int

$orgu_ref_id

)

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

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

                                                       : void
    {
        // New File and Sheet
        $file_name = "org_unit_export_" . $orgu_ref_id;
        $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, "title");
        $worksheet->setCell($row, 6, "description");
        $worksheet->setCell($row, 7, "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->getTitle());
            $worksheet->setCell($row, 6, $orgu->getDescription());
            $worksheet->setCell($row, 7, "create");
        }
        $worksheet->sendToClient($file_name);
    }

Here is the call graph for this function:

Field Documentation

$tree

ilTree ilOrgUnitExporter::$tree

private

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

---

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

• Modules/OrgUnit/classes/class.ilOrgUnitExporter.php