ilDataCollectionExportOptionsXLSX Class Reference

Inheritance diagram for ilDataCollectionExportOptionsXLSX:

Collaboration diagram for ilDataCollectionExportOptionsXLSX:

Public Member Functions
	init (Container $DIC)
	getExportType ()
	getExportOptionId ()
	getSupportedRepositoryObjectTypes ()
	getLabel ()
	getFiles (ilExportHandlerConsumerContextInterface $context)
	onExportOptionSelected (ilExportHandlerConsumerContextInterface $context)
	onDeleteFiles (ilExportHandlerConsumerContextInterface $context, ilExportHandlerConsumerFileIdentifierCollectionInterface $file_identifiers)
Public Member Functions inherited from ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler
	init (Container $DIC)
	onDeleteFiles (ilExportHandlerConsumerContextInterface $context, ilExportHandlerConsumerFileIdentifierCollectionInterface $file_identifiers)
	onDownloadFiles (ilExportHandlerConsumerContextInterface $context, ilExportHandlerConsumerFileIdentifierCollectionInterface $file_identifiers)
	onDownloadWithLink (ReferenceId $reference_id, ilExportHandlerConsumerFileIdentifierInterface $file_identifier)
	getFileSelection (ilExportHandlerConsumerContextInterface $context, ilExportHandlerConsumerFileIdentifierCollectionInterface $file_identifiers)
	getFiles (ilExportHandlerConsumerContextInterface $context)
Public Member Functions inherited from ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicHandler
	__construct ()
	isObjectSupported (ObjectId $object_id)
	isPublicAccessPossible ()

Protected Member Functions
	getExportFiles (string $directory)
	checkForAsyncEnabled (ilExportHandlerConsumerContextInterface $context)

Protected Attributes
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
Protected Attributes inherited from ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler
ilCtrl	$ctrl
ilDataFactory	$data_factory

Detailed Description

Definition at line 28 of file class.ilDataCollectionExportOptionsXLSX.php.

Member Function Documentation

checkForAsyncEnabled()

ilDataCollectionExportOptionsXLSX::checkForAsyncEnabled ( ilExportHandlerConsumerContextInterface  $context )

protected

Definition at line 162 of file class.ilDataCollectionExportOptionsXLSX.php.

References $DIC, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by onExportOptionSelected().

     : bool {
        global $DIC;
        if ($DIC->settings()->get('soap_user_administration', '0') === '1') {
            return true;
        }

        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('dcl_no_export_async_config'), true);
        $this->ctrl->redirect($context->exportGUIObject(), "listExportFiles");

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExportFiles()

ilDataCollectionExportOptionsXLSX::getExportFiles ( string  $directory )

protected

Definition at line 116 of file class.ilDataCollectionExportOptionsXLSX.php.

References $context, Vendor\Package\$e, ILIAS\Repository\ctrl(), getExportType(), ILIAS\Repository\int(), and ILIAS\Repository\lng().

Referenced by getFiles().

     : array {
        $file = [];
        try {
            $h_dir = dir($directory);
            while ($entry = $h_dir->read()) {
                if (
                    $entry !== "." &&
                    $entry !== ".." &&
                    substr($entry, -5) === "." . $this->getExportType()
                ) {
                    $ts = substr($entry, 0, strpos($entry, "__"));
                    $file[$entry . $this->getExportType()] = [
                        "type" => $this->getExportType(),
                        "file" => $entry,
                        "size" => (int) filesize($directory . "/" . $entry),
                        "timestamp" => (int) $ts
                    ];
                }
            }
        } catch (Exception $e) {
        }
        return $file;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExportOptionId()

ilDataCollectionExportOptionsXLSX::getExportOptionId

(

)

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

                                       : string
    {
        return 'dcl_exp_option_xlsx';
    }

getExportType()

ilDataCollectionExportOptionsXLSX::getExportType

(

)

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

Referenced by getExportFiles(), and getFiles().

                                   : string
    {
        return 'xlsx';
    }

Here is the caller graph for this function:

getFiles()

ilDataCollectionExportOptionsXLSX::getFiles

(

ilExportHandlerConsumerContextInterface

$context

)

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

References ilExport\_getExportDirectory(), getExportFiles(), and getExportType().

     : ilExportHandlerFileInfoCollectionInterface {
        $collection_builder = $context->fileCollectionBuilder();
        $dir = ilExport::_getExportDirectory(
            $context->exportObject()->getId(),
            $this->getExportType(),
            $context->exportObject()->getType()
        );
        $file_infos = $this->getExportFiles($dir);
        $object_id = new ObjectId($context->exportObject()->getId());
        foreach ($file_infos as $file_name => $file_info) {
            $collection_builder = $collection_builder->withSPLFileInfo(
                new SplFileInfo($dir . DIRECTORY_SEPARATOR . $file_info["file"]),
                $object_id,
                $this
            );
        }
        return $collection_builder->collection();
    }

Here is the call graph for this function:

getLabel()

ilDataCollectionExportOptionsXLSX::getLabel

(

)

Definition at line 55 of file class.ilDataCollectionExportOptionsXLSX.php.

References ILIAS\Repository\lng().

                              : string
    {
        return $this->lng->txt('dcl_xls_async_export');
    }

Here is the call graph for this function:

getSupportedRepositoryObjectTypes()

ilDataCollectionExportOptionsXLSX::getSupportedRepositoryObjectTypes

(

)

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

                                                       : array
    {
        return ['dcl'];
    }

init()

ilDataCollectionExportOptionsXLSX::init

(

Container

$DIC

)

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

References init(), ILIAS\DI\Container\language(), ILIAS\Repository\lng(), and ILIAS\DI\Container\ui().

                                        : void
    {
        $this->lng = $DIC->language();
        $this->tpl = $DIC->ui()->mainTemplate();
        parent::init($DIC);
    }

Here is the call graph for this function:

onDeleteFiles()

ilDataCollectionExportOptionsXLSX::onDeleteFiles	(	ilExportHandlerConsumerContextInterface	$context,
		ilExportHandlerConsumerFileIdentifierCollectionInterface	$file_identifiers
	)

Definition at line 90 of file class.ilDataCollectionExportOptionsXLSX.php.

References ilExport\_getExportDirectory(), and ilFileUtils\delDir().

     : void {
        foreach ($file_identifiers as $file_identifier) {
            $file = explode(":", $file_identifier->getIdentifier());
            $file[1] = basename($file[1]);
            $export_dir = ilExport::_getExportDirectory(
                $context->exportObject()->getId(),
                str_replace("..", "", $file[0]),
                $context->exportObject()->getType()
            );
            $exp_file = $export_dir . "/" . str_replace("..", "", $file[1]);
            $exp_dir = $export_dir . "/" . substr($file[1], 0, strlen($file[1]) - 5);
            if (is_file($exp_file)) {
                unlink($exp_file);
            }
            if (
                is_dir($exp_dir) and
                count(scandir($exp_dir)) === 2
            ) {
                ilFileUtils::delDir($exp_dir);
            }
        }
    }

Here is the call graph for this function:

onExportOptionSelected()

ilDataCollectionExportOptionsXLSX::onExportOptionSelected

(

ilExportHandlerConsumerContextInterface

$context

)

Definition at line 81 of file class.ilDataCollectionExportOptionsXLSX.php.

References checkForAsyncEnabled(), and ILIAS\Repository\ctrl().

     : void {
        if (!$this->checkForExportableFields($context) || !$this->checkForAsyncEnabled($context)) {
            return;
        }
        $this->ctrl->redirectByClass(ilObjDataCollectionGUI::class, "handleExportAsync");
    }

Here is the call graph for this function:

Field Documentation

$lng

ilLanguage ilDataCollectionExportOptionsXLSX::$lng

protected

Definition at line 30 of file class.ilDataCollectionExportOptionsXLSX.php.

$tpl

ilGlobalTemplateInterface ilDataCollectionExportOptionsXLSX::$tpl

protected

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

---

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

• components/ILIAS/DataCollection/classes/class.ilDataCollectionExportOptionsXLSX.php