ilExportGUI Class Reference

Export User Interface Class. More...

Inheritance diagram for ilExportGUI:

Collaboration diagram for ilExportGUI:

Public Member Functions
	__construct (object $a_parent_gui, ?ilObject $a_main_obj=null, bool $public_access_enabled=true, bool $default_export_option_enabled=true)
	isPublicAccessEnabled ()
	executeCommand ()
	addFormat ()
	listExportFiles ()
	getFormats ()

Data Fields
const	CMD_LIST_EXPORT_FILES = "listExportFiles"
const	CMD_EXPORT_XML = "createXmlExportFile"

Protected Member Functions
	initExportOptionsFromPost ()
	builtExportOptionCommand (ilExportHandlerConsumerExportOptionInterface $export_option)
	enableStandardXMLExport ()
	initExportOptions ()
	displayExportFiles ()
	createXMLExportFile ()
	showItemSelection ()
	Show container item selection table. More...
	saveItemSelection ()
	createXMLExport (ExportConfigCollectionInterface $export_configs)
	createXMLContainerExport ()

Protected Attributes
const	CMD_SAVE_ITEM_SELECTION = "saveItemSelection"
const	CMD_EXPORT_OPTION_PREFIX = "exportOption"
ilExportHandlerConsumerExportOptionCollectionInterface	$export_options
ilUIServices	$ui_services
ilHTTPServices	$http
ilRefineryFactory	$refinery
ilObjUser	$il_user
ilLanguage	$lng
ilObject	$obj
ilGlobalTemplateInterface	$tpl
ilCtrlInterface	$ctrl
ilAccessHandler	$access
ilErrorHandling	$error
ilToolbarGUI	$toolbar
ilObjectDefinition	$obj_definition
ilTree	$tree
ilExportHandler	$export_handler
ilExportHandlerConsumerContextInterface	$context
ilDataFactory	$data_factory
object	$parent_gui
bool	$public_access_enabled

Detailed Description

Export User Interface Class.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilExportGUI::__construct	(	object	$a_parent_gui,
		?ilObject	$a_main_obj = null,
		bool	$public_access_enabled = true,
		bool	$default_export_option_enabled = true
	)

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

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

      {
        global $DIC;
        $this->ui_services = $DIC->ui();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->il_user = $DIC->user();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule("exp");
        $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->obj_definition = $DIC['objDefinition'];
        $this->tree = $DIC->repositoryTree();
        $this->obj = $a_main_obj ?? $a_parent_gui->getObject();
        $this->export_handler = new ilExportHandler();
        $this->context = $this->export_handler->consumer()->context()->handler($this, $this->obj);
        $this->export_options = $this->export_handler->consumer()->exportOption()->collection();
        $this->data_factory = new ilDataFactory();
        $this->public_access_enabled = $public_access_enabled;
        $this->initExportOptions();
        if ($default_export_option_enabled) {
            $this->enableStandardXMLExport();
        }
    }

Here is the call graph for this function:

Member Function Documentation

addFormat()

ilExportGUI::addFormat

(

)

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

Referenced by ilCmiXapiExportGUI\__construct().

                               : void
    {

    }

Here is the caller graph for this function:

builtExportOptionCommand()

ilExportGUI::builtExportOptionCommand ( ilExportHandlerConsumerExportOptionInterface  $export_option )

finalprotected

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

Referenced by displayExportFiles(), and executeCommand().

                                                                                                                  : string
    {
        return self::CMD_EXPORT_OPTION_PREFIX . $export_option->getExportOptionId();
    }

Here is the caller graph for this function:

createXMLContainerExport()

ilExportGUI::createXMLContainerExport ( )

finalprotected

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

References $access, $obj_definition, $ref_id, ilObject\_lookupObjId(), ilObject\_lookupType(), ilExportOptions\allocateExportId(), ilExportOptions\EXPORT_BUILD, ilExportOptions\EXPORT_EXISTING, ilExportOptions\EXPORT_OMIT, initExportOptionsFromPost(), ILIAS\Repository\int(), ilExportOptions\KEY_ROOT, and ilExportOptions\newInstance().

Referenced by saveItemSelection().

                                                       : void
    {
        $tree_nodes = $this->tree->getSubTree($this->tree->getNodeData($this->parent_gui->getObject()->getRefId()));
        $post_export_options = $this->initExportOptionsFromPost();
        $eo = ilExportOptions::newInstance(ilExportOptions::allocateExportId());
        $eo->addOption(ilExportOptions::KEY_ROOT, 0, 0, $this->obj->getId());
        $items_selected = $eo->addOptions(
            $this->parent_gui->getObject()->getRefId(),
            $this->obj_definition,
            $this->access,
            $tree_nodes,
            $post_export_options
        );
        $eo->read();
        $ref_ids_export = [$this->parent_gui->getObject()->getRefId()];
        $ref_ids_all = [$this->parent_gui->getObject()->getRefId()];
        $tree_ref_ids = array_map(function ($node) { return (int) $node['ref_id']; }, $tree_nodes);
        $post_ref_ids = array_map(function ($key) {return (int) $key; }, array_keys($post_export_options));
        $valid_ref_ids = array_intersect($post_ref_ids, $tree_ref_ids);
        foreach ($valid_ref_ids as $ref_id) {
            $info = $post_export_options[$ref_id];
            $export_option_id = (int) $info["type"];
            if (
                $export_option_id === ilExportOptions::EXPORT_OMIT ||
                !$this->obj_definition->allowExport(ilObject::_lookupType($ref_id, true)) ||
                !$this->access->checkAccess('write', '', $ref_id)
            ) {
                continue;
            }
            if ($export_option_id === ilExportOptions::EXPORT_BUILD) {
                $ref_ids_export[] = $ref_id;
            }
            if (
                $export_option_id === ilExportOptions::EXPORT_BUILD ||
                $export_option_id === ilExportOptions::EXPORT_EXISTING
            ) {
                $ref_ids_all[] = $ref_id;
            }
        }
        $export_configs = $this->export_handler->consumer()->exportConfig()->allExportConfigs();
        $manager = $this->export_handler->manager()->handler();
        if (count($ref_ids_all) === 1) {
            $manager->createExportOfObject($this->obj, $this->il_user->getId(), $export_configs);
        }
        if (count($ref_ids_all) > 1) {
            $obj_ids_export = array_map(function (int $ref_id) { return ilObject::_lookupObjId($ref_id); }, $ref_ids_export);
            $obj_ids_all = array_map(function (int $ref_id) { return ilObject::_lookupObjId($ref_id); }, $ref_ids_all);
            $object_id_collection_builder = $manager->getObjectIdCollectioBuilder();
            foreach ($obj_ids_all as $obj_id) {
                $object_id_collection_builder = $object_id_collection_builder->addObjectId(
                    $this->data_factory->objId($obj_id),
                    in_array($obj_id, $obj_ids_export)
                );
            }
            $container_export_info = $manager->getContainerExportInfo(
                $this->data_factory->objId($obj_ids_all[0]),
                $object_id_collection_builder->getCollection(),
                $export_configs
            );
            $element = $manager->createContainerExport($this->il_user->getId(), $container_export_info);
        }
        $eo->delete();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createXMLExport()

ilExportGUI::createXMLExport ( ExportConfigCollectionInterface  $export_configs )

finalprotected

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

Referenced by createXMLExportFile().

     : void {
        $manager = $this->export_handler->manager()->handler();
        $manager->createExportOfObject($this->obj, $this->il_user->getId(), $export_configs);
    }

Here is the caller graph for this function:

createXMLExportFile()

ilExportGUI::createXMLExportFile ( )

finalprotected

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

References createXMLExport(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\MESSAGE_TYPE_SUCCESS, and showItemSelection().

Referenced by executeCommand().

                                                  : void
    {
        if ($this->parent_gui instanceof ilContainerGUI) {
            $this->showItemSelection();
            return;
        }
        $this->createXMLExport($this->export_handler->consumer()->exportConfig()->allExportConfigs());
        $this->tpl->setOnScreenMessage(
            ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
            $this->lng->txt("exp_file_created"),
            true
        );
        $this->ctrl->redirect($this, self::CMD_LIST_EXPORT_FILES);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

displayExportFiles()

ilExportGUI::displayExportFiles ( )

finalprotected

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

References builtExportOptionCommand(), ILIAS\Repository\ctrl(), isPublicAccessEnabled(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by executeCommand(), and listExportFiles().

                                                 : void
    {
        if ($this->export_options->count() === 0) {
            return;
        }
        $table = $this->export_handler->table()->handler()
            ->withExportOptions($this->export_options)
            ->withContext($this->context)
            ->withPublicAccessEnabled($this->isPublicAccessEnabled());
        $table->handleCommands();
        $infos = [];
        foreach ($this->export_options as $export_option) {
            # Do not display export option if the label is missing.
            if ($export_option->getLabel() === '') {
                continue;
            }
            $infos[$export_option->getLabel()] = $this->ctrl->getLinkTarget($this, $this->builtExportOptionCommand($export_option));
        }
        if (count($infos) === 1) {
            $this->toolbar->addComponent($this->ui_services->factory()->button()->standard(
                sprintf($this->lng->txt("exp_export_single_option"), array_keys($infos)[0]),
                array_values($infos)[0]
            ));
        }
        if (count($infos) > 1) {
            $links = [];
            foreach ($infos as $label => $link) {
                $links[] = $this->ui_services->factory()->link()->standard($label, $link);
            }
            $this->toolbar->addComponent(
                $this->ui_services->factory()->dropdown()->standard($links)
                    ->withLabel($this->lng->txt("exp_export_dropdown"))
            );
        }
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

enableStandardXMLExport()

ilExportGUI::enableStandardXMLExport ( )

finalprotected

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

Referenced by __construct().

                                                      : void
    {
        $this->export_options = $this->export_options->withElement(new ilExportExportOptionXML());
    }

Here is the caller graph for this function:

executeCommand()

ilExportGUI::executeCommand

(

)

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

References ilObject\_lookupType(), ILIAS\Repository\access(), builtExportOptionCommand(), createXMLExportFile(), ILIAS\Repository\ctrl(), displayExportFiles(), ILIAS\Repository\lng(), saveItemSelection(), 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->obj_definition->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(self::CMD_LIST_EXPORT_FILES);
        if (str_starts_with($cmd, self::CMD_EXPORT_OPTION_PREFIX)) {
            foreach ($this->export_options as $export_option) {
                if ($cmd === $this->builtExportOptionCommand($export_option)) {
                    $export_option->onExportOptionSelected($this->context);
                }
            }
        }
        switch ($cmd) {
            case self::CMD_EXPORT_XML:
                $this->createXMLExportFile();
                break;
            case self::CMD_SAVE_ITEM_SELECTION:
                $this->saveItemSelection();
                break;
            case self::CMD_LIST_EXPORT_FILES:
            default:
                $this->displayExportFiles();
                break;
        }
    }

Here is the call graph for this function:

getFormats()

ilExportGUI::getFormats

(

)

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

                                : array
    {
        return [];
    }

initExportOptions()

ilExportGUI::initExportOptions ( )

finalprotected

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

Referenced by __construct().

                                                : void
    {
        $export_options = $this->export_handler->consumer()->exportOption()->allExportOptions();
        foreach ($export_options as $export_option) {
            if (
                in_array($this->obj->getType(), $export_option->getSupportedRepositoryObjectTypes()) and
                $export_option->isObjectSupported($this->data_factory->objId($this->obj->getId()))
            ) {
                $this->export_options = $this->export_options->withElement($export_option);
            }
        }
    }

Here is the caller graph for this function:

initExportOptionsFromPost()

ilExportGUI::initExportOptionsFromPost ( )

finalprotected

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

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

Referenced by createXMLContainerExport(), and 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:

isPublicAccessEnabled()

ilExportGUI::isPublicAccessEnabled ( )

final

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

References $public_access_enabled.

Referenced by displayExportFiles().

                                                 : bool
    {
        return $this->public_access_enabled;
    }

Here is the caller graph for this function:

listExportFiles()

ilExportGUI::listExportFiles

(

)

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

References displayExportFiles().

                                     : void
    {
        $this->displayExportFiles();
    }

Here is the call graph for this function:

saveItemSelection()

ilExportGUI::saveItemSelection ( )

finalprotected

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

References Vendor\Package\$e, createXMLContainerExport(), ILIAS\Repository\ctrl(), initExportOptionsFromPost(), ILIAS\Repository\lng(), and showItemSelection().

Referenced by executeCommand().

                                                : void
    {
        // check export limitation
        $cp_options = $this->initExportOptionsFromPost();
        $exp_limit = new ilExportLimitation();
        try {
            $exp_limit->checkLimitation(
                $this->parent_gui->getObject()->getRefId(),
                $cp_options
            );
        } catch (Exception $e) {
            $this->tpl->setOnScreenMessage('failure', $e->getMessage());
            $this->showItemSelection();
            return;
        }
        // create export
        $this->createXMLContainerExport();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('export_created'), true);
        $this->ctrl->redirect($this, self::CMD_LIST_EXPORT_FILES);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showItemSelection()

ilExportGUI::showItemSelection ( )

finalprotected

Show container item selection table.

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

Referenced by createXMLExportFile(), and saveItemSelection().

                                                : void
    {
        $this->tpl->addJavaScript('assets/js/ilContainer.js');
        $this->tpl->setVariable('BODY_ATTRIBUTES', 'onload="ilDisableChilds(\'cmd\');"');
        $table = new ilExportSelectionTableGUI($this, self::CMD_LIST_EXPORT_FILES, $this->export_handler);
        $table->parseContainer($this->parent_gui->getObject()->getRefId());
        $this->tpl->setContent($table->getHTML());
    }

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilExportGUI::$access

protected

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

Referenced by createXMLContainerExport().

$context

ilExportHandlerConsumerContextInterface ilExportGUI::$context

protected

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

$ctrl

ilCtrlInterface ilExportGUI::$ctrl

protected

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

$data_factory

ilDataFactory ilExportGUI::$data_factory

protected

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

$error

ilErrorHandling ilExportGUI::$error

protected

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

$export_handler

ilExportHandler ilExportGUI::$export_handler

protected

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

$export_options

ilExportHandlerConsumerExportOptionCollectionInterface ilExportGUI::$export_options

protected

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

$http

ilHTTPServices ilExportGUI::$http

protected

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

$il_user

ilObjUser ilExportGUI::$il_user

protected

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

$lng

ilLanguage ilExportGUI::$lng

protected

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

$obj

ilObject ilExportGUI::$obj

protected

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

$obj_definition

ilObjectDefinition ilExportGUI::$obj_definition

protected

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

Referenced by createXMLContainerExport().

$parent_gui

object ilExportGUI::$parent_gui

protected

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

$public_access_enabled

bool ilExportGUI::$public_access_enabled

protected

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

Referenced by __construct(), and isPublicAccessEnabled().

$refinery

ilRefineryFactory ilExportGUI::$refinery

protected

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

$toolbar

ilToolbarGUI ilExportGUI::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface ilExportGUI::$tpl

protected

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

$tree

ilTree ilExportGUI::$tree

protected

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

$ui_services

ilUIServices ilExportGUI::$ui_services

protected

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

CMD_EXPORT_OPTION_PREFIX

const ilExportGUI::CMD_EXPORT_OPTION_PREFIX = "exportOption"

protected

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

CMD_EXPORT_XML

const ilExportGUI::CMD_EXPORT_XML = "createXmlExportFile"

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

CMD_LIST_EXPORT_FILES

const ilExportGUI::CMD_LIST_EXPORT_FILES = "listExportFiles"

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

Referenced by ilObjBlogGUI\createExportFile(), ilObjBlogGUI\createExportFileWithComments(), ilObjContentObjectGUI\doExportHTML(), ilObjContentObjectGUI\doExportXML(), ilWikiExportOptionHTML\getLabel(), ilWikiExportOptionHTMLWithComments\isObjectSupported(), ilMediaPoolExportOptionXMLMasterNoMedia\onExportOptionSelected(), and ilMediaPoolExportOptionXMLMaster\onExportOptionSelected().

CMD_SAVE_ITEM_SELECTION

const ilExportGUI::CMD_SAVE_ITEM_SELECTION = "saveItemSelection"

protected

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

---

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

• components/ILIAS/Export/classes/class.ilExportGUI.php