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

Collaboration diagram for ilExportGUI:

Public Member Functions
	__construct (object $a_parent_gui, ?ilObject $a_main_obj=null)
	addFormat (string $a_key, string $a_txt="", object $a_call_obj=null, string $a_call_func="")
	getFormats ()
	addCustomColumn (string $a_txt, object $a_obj, string $a_func)
	addCustomMultiCommand (string $a_txt, object $a_obj, string $a_func)
	getCustomMultiCommands ()
	getCustomColumns ()
	executeCommand ()
	listExportFiles ()
	createExportFile ()
	confirmDeletion ()
	Confirm file deletion. More...
	delete ()
	download ()
	Download file. More...
	handleCustomMultiCommand ()

Protected Member Functions
	initFileIdentifierFromQuery ()
	initFileIdentifiersFromPost ()
	initFormatFromPost ()
	initExportOptionsFromPost ()
	buildExportTableGUI ()
	getParentGUI ()
	showItemSelection ()
	Show container item selection table. More...
	saveItemSelection ()

Protected Attributes
Factory	$refinery
Services	$http
array	$formats = array()
array	$custom_columns = array()
array	$custom_multi_commands = array()
ilObject	$obj
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
ilCtrlInterface	$ctrl
ilAccessHandler	$access
ilErrorHandling	$error
ilToolbarGUI	$toolbar
ilObjectDefinition	$objDefinition
ilTree	$tree

Private Attributes
object	$parent_gui

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 Export User Interface Class

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilExportGUI:

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

Constructor & Destructor Documentation

__construct()

ilExportGUI::__construct	(	object	$a_parent_gui,
		?ilObject	$a_main_obj = null
	)

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\toolbar().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule("exp");

        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();

        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->access = $DIC->access();
        $this->error = $DIC['ilErr'];
        $this->toolbar = $DIC->toolbar();
        $this->parent_gui = $a_parent_gui;
        $this->objDefinition = $DIC['objDefinition'];
        $this->tree = $DIC->repositoryTree();
        if ($a_main_obj == null) {
            $this->obj = $a_parent_gui->getObject();
        } else {
            $this->obj = $a_main_obj;
        }
    }

Here is the call graph for this function:

Member Function Documentation

addCustomColumn()

ilExportGUI::addCustomColumn	(	string	$a_txt,
		object	$a_obj,
		string	$a_func
	)

Definition at line 159 of file class.ilExportGUI.php.

                                                                                 : void
    {
        $this->custom_columns[] = array("txt" => $a_txt,
                                        "obj" => $a_obj,
                                        "func" => $a_func
        );
    }

addCustomMultiCommand()

ilExportGUI::addCustomMultiCommand	(	string	$a_txt,
		object	$a_obj,
		string	$a_func
	)

Definition at line 167 of file class.ilExportGUI.php.

                                                                                       : void
    {
        $this->custom_multi_commands[] = array("txt" => $a_txt,
                                               "obj" => $a_obj,
                                               "func" => $a_func
        );
    }

addFormat()

ilExportGUI::addFormat	(	string	$a_key,
		string	$a_txt = "",
		object	$a_call_obj = null,
		string	$a_call_func = ""
	)

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

References ILIAS\Repository\lng().

Referenced by ilCmiXapiExportGUI\__construct(), and ilTestExportGUI\__construct().

     : void {
        if ($a_txt == "") {
            $a_txt = $this->lng->txt("exp_" . $a_key);
        }
        $this->formats[] = array(
            "key" => $a_key,
            "txt" => $a_txt,
            "call_obj" => $a_call_obj,
            "call_func" => $a_call_func
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildExportTableGUI()

ilExportGUI::buildExportTableGUI ( )

protected

Definition at line 127 of file class.ilExportGUI.php.

Referenced by listExportFiles().

                                            : ilExportTableGUI
    {
        return new ilExportTableGUI($this, "listExportFiles", $this->obj);
    }

Here is the caller graph for this function:

confirmDeletion()

ilExportGUI::confirmDeletion

(

)

Confirm file deletion.

Definition at line 288 of file class.ilExportGUI.php.

References $filename, $i, ILIAS\Repository\ctrl(), initFileIdentifiersFromPost(), and ILIAS\Repository\lng().

                                     : void
    {
        $files = $this->initFileIdentifiersFromPost();
        if (!count($files)) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "listExportFiles");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($this->ctrl->getFormAction($this));
            $cgui->setHeaderText($this->lng->txt("exp_really_delete"));
            $cgui->setCancel($this->lng->txt("cancel"), "listExportFiles");
            $cgui->setConfirm($this->lng->txt("delete"), "delete");

            foreach ($files as $i) {
                if (strpos($i, ':') !== false) {
                    $iarr = explode(":", $i);
                    $filename = $iarr[1];
                } else {
                    $filename = $i;
                }
                $cgui->addItem("file[]", $i, $filename);
            }
            $this->tpl->setContent($cgui->getHTML());
        }
    }

Here is the call graph for this function:

createExportFile()

ilExportGUI::createExportFile

(

)

Definition at line 260 of file class.ilExportGUI.php.

References Vendor\Package\$f, $format, ILIAS\Repository\ctrl(), getFormats(), getParentGUI(), initFormatFromPost(), ILIAS\Repository\lng(), and showItemSelection().

Referenced by executeCommand().

                                      : void
    {
        if ($this->ctrl->getCmd() == "createExportFile") {
            $format = $this->initFormatFromPost();
        } else {
            $format = substr($this->ctrl->getCmd(), 7);
        }
        foreach ($this->getFormats() as $f) {
            if ($f["key"] == $format) {
                if (is_object($f["call_obj"])) {
                    $f["call_obj"]->{$f["call_func"]}();
                } elseif ($this->getParentGUI() instanceof ilContainerGUI) {
                    $this->showItemSelection();
                    return;
                } elseif ($format == "xml") {        // standard procedure
                    $exp = new ilExport();
                    $exp->exportObject($this->obj->getType(), $this->obj->getId());
                }
            }
        }

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("exp_file_created"), true);
        $this->ctrl->redirect($this, "listExportFiles");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilExportGUI::delete

(

)

Definition at line 314 of file class.ilExportGUI.php.

References ilExport\_getExportDirectory(), ILIAS\Repository\ctrl(), ilFileUtils\delDir(), ilExportFileInfo\delete(), initFileIdentifiersFromPost(), and ILIAS\Repository\lng().

                            : void
    {
        $files = $this->initFileIdentifiersFromPost();
        foreach ($files as $file) {
            $file = explode(":", $file);

            $file[1] = basename($file[1]);

            $export_dir = ilExport::_getExportDirectory(
                $this->obj->getId(),
                str_replace("..", "", $file[0]),
                $this->obj->getType()
            );

            $exp_file = $export_dir . "/" . str_replace("..", "", $file[1]);
            $exp_dir = $export_dir . "/" . substr($file[1], 0, strlen($file[1]) - 4);
            if (is_file($exp_file)) {
                unlink($exp_file);
            }
            if (is_dir($exp_dir)) {
                ilFileUtils::delDir($exp_dir);
            }

            // delete entry in database
            $info = new ilExportFileInfo($this->obj->getId(), $file[0], $file[1]);
            $info->delete();
        }
        if (count($files) > 0) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('export_files_deleted'), true);
        }
        $this->ctrl->redirect($this, "listExportFiles");
    }

Here is the call graph for this function:

download()

ilExportGUI::download

(

)

Download file.

Definition at line 350 of file class.ilExportGUI.php.

References ilExport\_getExportDirectory(), ILIAS\Repository\ctrl(), ilFileDelivery\deliverFileLegacy(), and initFileIdentifierFromQuery().

Referenced by ilTestExportGUI\getExportTypeFromFileName().

                              : void
    {
        $file = $this->initFileIdentifierFromQuery();
        if (!$file) {
            $this->ctrl->redirect($this, "listExportFiles");
        }

        $file = explode(":", trim($file));
        $export_dir = ilExport::_getExportDirectory(
            $this->obj->getId(),
            str_replace("..", "", $file[0]),
            $this->obj->getType()
        );

        $file[1] = basename($file[1]);

        ilFileDelivery::deliverFileLegacy(
            $export_dir . "/" . $file[1],
            $file[1]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilExportGUI::executeCommand

(

)

Definition at line 185 of file class.ilExportGUI.php.

References ilObject\_lookupType(), ILIAS\Repository\access(), createExportFile(), ILIAS\Repository\ctrl(), handleCustomMultiCommand(), ILIAS\Repository\lng(), and ilExportLimitation\SET_EXPORT_DISABLED.

                                    : void
    {
        // this should work (at least) for repository objects
        if (method_exists($this->obj, 'getRefId') and $this->obj->getRefId()) {
            if (!$this->access->checkAccess('write', '', $this->obj->getRefId())) {
                $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->WARNING);
            }

            // check export activation of container
            $exp_limit = new ilExportLimitation();
            if ($this->objDefinition->isContainer(ilObject::_lookupType($this->obj->getRefId(), true)) &&
                $exp_limit->getLimitationMode() == ilExportLimitation::SET_EXPORT_DISABLED) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt("exp_error_disabled"));
                return;
            }
        }

        $cmd = $this->ctrl->getCmd("listExportFiles");

        switch ($cmd) {
            case "listExportFiles":
                $this->$cmd();
                break;

            default:
                if (substr($cmd, 0, 7) == "create_") {
                    $this->createExportFile();
                } elseif (substr($cmd, 0, 6) == "multi_") {    // custom multi command
                    $this->handleCustomMultiCommand();
                } else {
                    $this->$cmd();
                }
                break;
        }
    }

Here is the call graph for this function:

getCustomColumns()

ilExportGUI::getCustomColumns

(

)

Definition at line 180 of file class.ilExportGUI.php.

References $custom_columns.

Referenced by ilTestExportGUI\listExportFiles(), and listExportFiles().

                                      : array
    {
        return $this->custom_columns;
    }

Here is the caller graph for this function:

getCustomMultiCommands()

ilExportGUI::getCustomMultiCommands

(

)

Definition at line 175 of file class.ilExportGUI.php.

References $custom_multi_commands.

Referenced by handleCustomMultiCommand(), ilTestExportGUI\listExportFiles(), and listExportFiles().

                                            : array
    {
        return $this->custom_multi_commands;
    }

Here is the caller graph for this function:

getFormats()

ilExportGUI::getFormats

(

)

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

References $formats.

Referenced by createExportFile(), ilTestExportGUI\listExportFiles(), and listExportFiles().

                                : array
    {
        return $this->formats;
    }

Here is the caller graph for this function:

getParentGUI()

ilExportGUI::getParentGUI ( )

protected

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

References $parent_gui.

Referenced by createExportFile(), ilTestExportGUI\getExportTypeFromFileName(), ilTestExportGUI\listExportFiles(), saveItemSelection(), and showItemSelection().

                                     : object
    {
        return $this->parent_gui;
    }

Here is the caller graph for this function:

handleCustomMultiCommand()

ilExportGUI::handleCustomMultiCommand

(

)

Definition at line 372 of file class.ilExportGUI.php.

References $c, ILIAS\Repository\ctrl(), getCustomMultiCommands(), and initFileIdentifiersFromPost().

Referenced by executeCommand().

                                              : void
    {
        $cmd = substr($this->ctrl->getCmd(), 6);
        foreach ($this->getCustomMultiCommands() as $c) {
            if ($c["func"] == $cmd) {
                $c["obj"]->{$c["func"]}($this->initFileIdentifiersFromPost());
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initExportOptionsFromPost()

ilExportGUI::initExportOptionsFromPost ( )

protected

Definition at line 109 of file class.ilExportGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by saveItemSelection().

                                                  : array
    {
        $options = [];
        if ($this->http->wrapper()->post()->has('cp_options')) {
            $custom_transformer = $this->refinery->custom()->transformation(
                function ($array) {
                    return $array;
                }
            );
            $options = $this->http->wrapper()->post()->retrieve(
                'cp_options',
                $custom_transformer
            );
        }
        return $options;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initFileIdentifierFromQuery()

ilExportGUI::initFileIdentifierFromQuery ( )

protected

Definition at line 74 of file class.ilExportGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by download().

                                                    : string
    {
        if ($this->http->wrapper()->query()->has('file')) {
            return $this->http->wrapper()->query()->retrieve(
                'file',
                $this->refinery->kindlyTo()->string()
            );
        }
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initFileIdentifiersFromPost()

ilExportGUI::initFileIdentifiersFromPost ( )

protected

Definition at line 85 of file class.ilExportGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by confirmDeletion(), delete(), and handleCustomMultiCommand().

                                                    : array
    {
        if ($this->http->wrapper()->post()->has('file')) {
            return $this->http->wrapper()->post()->retrieve(
                'file',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->string()
                )
            );
        }
        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initFormatFromPost()

ilExportGUI::initFormatFromPost ( )

protected

Definition at line 98 of file class.ilExportGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by createExportFile().

                                           : string
    {
        if ($this->http->wrapper()->post()->has('format')) {
            return $this->http->wrapper()->post()->retrieve(
                'format',
                $this->refinery->kindlyTo()->string()
            );
        }
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listExportFiles()

ilExportGUI::listExportFiles

(

)

Definition at line 221 of file class.ilExportGUI.php.

References $c, Vendor\Package\$f, $format, buildExportTableGUI(), ILIAS\Repository\ctrl(), getCustomColumns(), getCustomMultiCommands(), getFormats(), ilSubmitButton\getInstance(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

                                     : void
    {
        $button = ilSubmitButton::getInstance();

        // creation buttons
        $this->toolbar->setFormAction($this->ctrl->getFormAction($this));
        if (count($this->getFormats()) > 1) {
            // type selection
            $options = [];
            foreach ($this->getFormats() as $f) {
                $options[$f["key"]] = $f["txt"];
            }
            $si = new ilSelectInputGUI($this->lng->txt("type"), "format");
            $si->setOptions($options);
            $this->toolbar->addInputItem($si, true);

            $button->setCaption("exp_create_file");
            $button->setCommand("createExportFile");
        } else {
            $format = $this->getFormats();
            $format = $format[0];

            $button->setCaption($this->lng->txt("exp_create_file") . " (" . $format["txt"] . ")", false);
            $button->setCommand("create_" . $format["key"]);
        }

        $this->toolbar->addButtonInstance($button);

        $table = $this->buildExportTableGUI();
        $table->setSelectAllCheckbox("file");
        foreach ($this->getCustomColumns() as $c) {
            $table->addCustomColumn($c["txt"], $c["obj"], $c["func"]);
        }
        foreach ($this->getCustomMultiCommands() as $c) {
            $table->addCustomMultiCommand($c["txt"], "multi_" . $c["func"]);
        }
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

saveItemSelection()

ilExportGUI::saveItemSelection ( )

protected

Definition at line 395 of file class.ilExportGUI.php.

References Vendor\Package\$e, $ref_id, $type, ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\access(), ilExportOptions\allocateExportId(), ILIAS\Repository\ctrl(), ilExportOptions\EXPORT_BUILD, ilExportOptions\EXPORT_OMIT, getParentGUI(), initExportOptionsFromPost(), ilExportOptions\KEY_ITEM_MODE, ilExportOptions\KEY_ROOT, ILIAS\Repository\lng(), ilExportOptions\newInstance(), and showItemSelection().

                                          : void
    {
        $eo = ilExportOptions::newInstance(ilExportOptions::allocateExportId());
        $eo->addOption(ilExportOptions::KEY_ROOT, 0, 0, $this->obj->getId());

        $cp_options = $this->initExportOptionsFromPost();

        // check export limitation
        $exp_limit = new ilExportLimitation();
        try {
            $exp_limit->checkLimitation(
                $this->getParentGUI()->getObject()->getRefId(),
                $cp_options
            );
        } catch (Exception $e) {
            $this->tpl->setOnScreenMessage('failure', $e->getMessage());
            $this->showItemSelection();
            return;
        }

        $items_selected = false;
        foreach ($this->tree->getSubTree($root = $this->tree->getNodeData($this->getParentGUI()->getObject()->getRefId())) as $node) {
            if ($node['type'] === 'rolf') {
                continue;
            }
            if ($node['ref_id'] == $this->getParentGUI()->getObject()->getRefId()) {
                $eo->addOption(
                    ilExportOptions::KEY_ITEM_MODE,
                    (int) $node['ref_id'],
                    (int) $node['obj_id'],
                    ilExportOptions::EXPORT_BUILD
                );
                continue;
            }
            // no export available or no access
            if (!$this->objDefinition->allowExport($node['type']) || !$this->access->checkAccess(
                'write',
                '',
                (int) $node['ref_id']
            )) {
                $eo->addOption(
                    ilExportOptions::KEY_ITEM_MODE,
                    (int) $node['ref_id'],
                    (int) $node['obj_id'],
                    ilExportOptions::EXPORT_OMIT
                );
                continue;
            }

            $mode = $cp_options[$node['ref_id']]['type'] ?? ilExportOptions::EXPORT_OMIT;
            $eo->addOption(
                ilExportOptions::KEY_ITEM_MODE,
                (int) $node['ref_id'],
                (int) $node['obj_id'],
                $mode
            );
            if ($mode != ilExportOptions::EXPORT_OMIT) {
                $items_selected = true;
            }
        }

        if ($items_selected) {
            // TODO: move this to background soap
            $eo->read();
            $exp = new ilExport();
            foreach ($eo->getSubitemsForCreation($this->obj->getRefId()) as $ref_id) {
                $obj_id = ilObject::_lookupObjId($ref_id);
                $type = ilObject::_lookupType($obj_id);
                $exp->exportObject($type, $obj_id);
            }
            // Fixme: there is a naming conflict between the container settings xml and the container subitem xml.
            sleep(1);
            // Export container
            $cexp = new ilExportContainer($eo);
            $cexp->exportObject($this->obj->getType(), $this->obj->getId());
        } else {
            $exp = new ilExport();
            $exp->exportObject($this->obj->getType(), $this->obj->getId());
        }

        // Delete export options
        $eo->delete();

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('export_created'), true);
        $this->ctrl->redirect($this, "listExportFiles");
    }

Here is the call graph for this function:

showItemSelection()

ilExportGUI::showItemSelection ( )

protected

Show container item selection table.

Definition at line 385 of file class.ilExportGUI.php.

References getParentGUI().

Referenced by createExportFile(), and saveItemSelection().

                                          : void
    {
        $this->tpl->addJavaScript('./Services/CopyWizard/js/ilContainer.js');
        $this->tpl->setVariable('BODY_ATTRIBUTES', 'onload="ilDisableChilds(\'cmd\');"');

        $table = new ilExportSelectionTableGUI($this, 'listExportFiles');
        $table->parseContainer($this->getParentGUI()->getObject()->getRefId());
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilExportGUI::$access

protected

Definition at line 42 of file class.ilExportGUI.php.

$ctrl

ilCtrlInterface ilExportGUI::$ctrl

protected

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

$custom_columns

array ilExportGUI::$custom_columns = array()

protected

Definition at line 34 of file class.ilExportGUI.php.

Referenced by getCustomColumns().

$custom_multi_commands

array ilExportGUI::$custom_multi_commands = array()

protected

Definition at line 35 of file class.ilExportGUI.php.

Referenced by getCustomMultiCommands().

$error

ilErrorHandling ilExportGUI::$error

protected

Definition at line 43 of file class.ilExportGUI.php.

$formats

array ilExportGUI::$formats = array()

protected

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

Referenced by getFormats().

$http

Services ilExportGUI::$http

protected

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

$lng

ilLanguage ilExportGUI::$lng

protected

Definition at line 39 of file class.ilExportGUI.php.

Referenced by ilTestExportGUI\buildExportTableGUI(), ilTestExportGUI\createTestArchiveExport(), ilTestExportGUI\getExportTypeFromFileName(), and ilTestExportGUI\listExportFiles().

$obj

ilObject ilExportGUI::$obj

protected

Definition at line 38 of file class.ilExportGUI.php.

$objDefinition

ilObjectDefinition ilExportGUI::$objDefinition

protected

Definition at line 45 of file class.ilExportGUI.php.

$parent_gui

object ilExportGUI::$parent_gui

private

Definition at line 37 of file class.ilExportGUI.php.

Referenced by getParentGUI().

$refinery

Factory ilExportGUI::$refinery

protected

Definition at line 31 of file class.ilExportGUI.php.

$toolbar

ilToolbarGUI ilExportGUI::$toolbar

protected

Definition at line 44 of file class.ilExportGUI.php.

$tpl

ilGlobalTemplateInterface ilExportGUI::$tpl

protected

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

Referenced by ilTestExportGUI\listExportFiles().

$tree

ilTree ilExportGUI::$tree

protected

Definition at line 46 of file class.ilExportGUI.php.

---

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

• Services/Export/classes/class.ilExportGUI.php