ilTestExportOptionARC Class Reference

Inheritance diagram for ilTestExportOptionARC:

Collaboration diagram for ilTestExportOptionARC:

Public Member Functions
	init (Container $DIC)
	getExportType ()
	getExportOptionId ()
	getSupportedRepositoryObjectTypes ()
	getLabel ()
	onDeleteFiles (ilExportHandlerConsumerContextInterface $context, ilExportHandlerConsumerFileIdentifierCollectionInterface $file_identifiers)
	onDownloadFiles (ilExportHandlerConsumerContextInterface $context, ilExportHandlerConsumerFileIdentifierCollectionInterface $file_identifiers)
	onDownloadWithLink (ReferenceId $reference_id, ilExportHandlerConsumerFileIdentifierInterface $file_identifier)
	getFiles (ilExportHandlerConsumerContextInterface $context)
	onExportOptionSelected (ilExportHandlerConsumerContextInterface $context)
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)
	getDirectory (ObjectId $object_id, string $export_object_type)

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

Detailed Description

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

Member Function Documentation

getDirectory()

ilTestExportOptionARC::getDirectory ( ObjectId  $object_id, string  $export_object_type  )

protected

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

     : string {
        return $this->data_dir
            . DIRECTORY_SEPARATOR . CLIENT_ID . DIRECTORY_SEPARATOR . 'tst_data' . DIRECTORY_SEPARATOR
            . ilTestArchiver::EXPORT_DIRECTORY . DIRECTORY_SEPARATOR . $export_object_type . "_" . $object_id->toInt();
    }

getExportFiles()

ilTestExportOptionARC::getExportFiles ( string  $directory )

protected

Definition at line 141 of file class.ilTestExportOptionARC.php.

     : array {
        $files = [];
        try {
            foreach (scandir($directory) as $file) {
                if (
                    in_array($file, ['.', '..']) ||
                    !str_ends_with($file, ".zip")
                ) {
                    continue;
                }
                $files[$file] = ["file" => $file];
            }
        } catch (Exception $e) {
 
        }
        return $files;
    }

getExportOptionId()

ilTestExportOptionARC::getExportOptionId

(

)

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

                                       : string
    {
        return 'test_exp_option_arc';
    }

getExportType()

ilTestExportOptionARC::getExportType

(

)

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

                                   : string
    {
        return 'Archive';
    }

getFiles()

ilTestExportOptionARC::getFiles

(

ilExportHandlerConsumerContextInterface

$context

)

Reimplemented from ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler.

Definition at line 118 of file class.ilTestExportOptionARC.php.

     : ilExportHandlerFileInfoCollectionInterface {
        $collection_builder = $context->fileCollectionBuilder();
        $object_id = new ObjectId($context->exportObject()->getId());
        $dir = $this->getDirectory($object_id, $context->exportObject()->getType());
        $file_infos = $this->getExportFiles($dir);
        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();
    }

getLabel()

ilTestExportOptionARC::getLabel

(

)

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

                              : string
    {
        $this->lng->loadLanguageModule('assessment');
        return $this->lng->txt('ass_create_export_test_archive');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getSupportedRepositoryObjectTypes()

ilTestExportOptionARC::getSupportedRepositoryObjectTypes

(

)

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

                                                       : array
    {
        return ['tst'];
    }

init()

ilTestExportOptionARC::init

(

Container

$DIC

)

Reimplemented from ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler.

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

     : void {
        $this->lng = $DIC->language();
        $this->data_dir = $DIC->iliasIni()->readVariable('clients', 'datadir');
        parent::init($DIC);
    }

onDeleteFiles()

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

Reimplemented from ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler.

Definition at line 64 of file class.ilTestExportOptionARC.php.

     : void {
        $object_id = new ObjectId($context->exportObject()->getId());
        foreach ($file_identifiers as $file_identifier) {
            $file = explode(":", $file_identifier->getIdentifier());
            $file[1] = basename($file[1]);
            $export_dir = $this->getDirectory($object_id, $context->exportObject()->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) and
                count(scandir($exp_dir)) === 2
            ) {
                ilFileUtils::delDir($exp_dir);
            }
        }
    }

References $context, and ilFileUtils\delDir().

Here is the call graph for this function:

onDownloadFiles()

ilTestExportOptionARC::onDownloadFiles	(	ilExportHandlerConsumerContextInterface	$context,
		ilExportHandlerConsumerFileIdentifierCollectionInterface	$file_identifiers
	)

Reimplemented from ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler.

Definition at line 87 of file class.ilTestExportOptionARC.php.

     : void {
        $object_id = new ObjectId($context->exportObject()->getId());
        foreach ($file_identifiers as $file_identifier) {
            $file = explode(":", trim($file_identifier->getIdentifier()));
            $export_dir = $this->getDirectory($object_id, $context->exportObject()->getType());
            $file[1] = basename($file[1]);
            ilFileDelivery::deliverFileLegacy(
                $export_dir . "/" . $file[1],
                $file[1]
            );
        }
    }

References $context, and ilFileDelivery\deliverFileLegacy().

Here is the call graph for this function:

onDownloadWithLink()

ilTestExportOptionARC::onDownloadWithLink	(	ReferenceId	$reference_id,
		ilExportHandlerConsumerFileIdentifierInterface	$file_identifier
	)

Reimplemented from ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler.

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

     : void {
        $object_id = $reference_id->toObjectId();
        $type = ilObject::_lookupType($object_id->toInt());
        $file = explode(":", trim($file_identifier->getIdentifier()));
        $export_dir = $this->getDirectory($object_id, $type);
        $file[1] = basename($file[1]);
        ilFileDelivery::deliverFileLegacy(
            $export_dir . "/" . $file[1],
            $file[1]
        );
    }

onExportOptionSelected()

ilTestExportOptionARC::onExportOptionSelected

(

ilExportHandlerConsumerContextInterface

$context

)

Definition at line 135 of file class.ilTestExportOptionARC.php.

     : void {
        $context->exportGUIObject()->createTestArchiveExport();
    }

Field Documentation

$data_dir

string ilTestExportOptionARC::$data_dir

protected

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

$lng

ilLanguage ilTestExportOptionARC::$lng

protected

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

---

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

• components/ILIAS/Test/classes/class.ilTestExportOptionARC.php