ilTestExportOptionXMLRES Class Reference

Inheritance diagram for ilTestExportOptionXMLRES:

Collaboration diagram for ilTestExportOptionXMLRES:

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)
	getFileSelection (ilExportHandlerConsumerContextInterface $context, ilExportHandlerConsumerFileIdentifierCollectionInterface $file_identifiers)
	onExportOptionSelected (ilExportHandlerConsumerContextInterface $context)
Public Member Functions inherited from ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicHandler
	__construct ()
	isObjectSupported (ObjectId $object_id)
	isPublicAccessPossible ()

Data Fields
const	OPTIONS_ID = 'test_exp_option_xmlres'

Protected Member Functions
	buildElements (ilExportHandlerConsumerContextInterface $context, ObjectId $object_id, ?array $file_identifiers=null)

Private Attributes
ilLanguage	$lng
ResourceStorage	$irss
DataFactory	$data_factory
DBRepository	$repository

Detailed Description

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

Member Function Documentation

buildElements()

ilTestExportOptionXMLRES::buildElements ( ilExportHandlerConsumerContextInterface  $context, ObjectId  $object_id, ?array  $file_identifiers = null  )

protected

Definition at line 131 of file class.ilTestExportOptionXMLRES.php.

References ILIAS\UI\examples\Deck\repository(), and ILIAS\Data\ObjectId\toInt().

Referenced by getFiles(), and getFileSelection().

     : ilExportHandlerFileInfoCollectionInterface {
        if ($file_identifiers === null) {
            $file_identifiers = array_map(
                static fn(array $v): string => $v['rid'],
                $this->repository->getFor($object_id->toInt())
            );
        }
        $collection_builder = $context->fileCollectionBuilder();
        foreach ($file_identifiers as $file_identifier) {
            $collection_builder = $collection_builder->withResourceIdentifier(
                $this->irss->manage()->find($file_identifier),
                $object_id,
                $this
            );
        }
        return $collection_builder->collection();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExportOptionId()

ilTestExportOptionXMLRES::getExportOptionId

(

)

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

                                       : string
    {
        return self::OPTIONS_ID;
    }

getExportType()

ilTestExportOptionXMLRES::getExportType

(

)

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

                                   : string
    {
        return 'ZIP Results';
    }

getFiles()

ilTestExportOptionXMLRES::getFiles

(

ilExportHandlerConsumerContextInterface

$context

)

Definition at line 105 of file class.ilTestExportOptionXMLRES.php.

References buildElements().

     : ilExportHandlerFileInfoCollectionInterface {
        return $this->buildElements(
            $context,
            $this->data_factory->objId($context->exportObject()->getId())
        );
    }

Here is the call graph for this function:

getFileSelection()

ilTestExportOptionXMLRES::getFileSelection	(	ilExportHandlerConsumerContextInterface	$context,
		ilExportHandlerConsumerFileIdentifierCollectionInterface	$file_identifiers
	)

Definition at line 114 of file class.ilTestExportOptionXMLRES.php.

References buildElements().

     : ilExportHandlerFileInfoCollectionInterface {
        return $this->buildElements(
            $context,
            $this->data_factory->objId($context->exportObject()->getId()),
            $file_identifiers->toStringArray()
        );
    }

Here is the call graph for this function:

getLabel()

ilTestExportOptionXMLRES::getLabel

(

)

Definition at line 67 of file class.ilTestExportOptionXMLRES.php.

References ILIAS\Repository\lng().

                              : string
    {
        $this->lng->loadLanguageModule('exp');
        $this->lng->loadLanguageModule('assessment');
        return  $this->lng->txt("exp_format_dropdown-xml") . " (" . $this->lng->txt('ass_create_export_file_with_results') . ")";
    }

Here is the call graph for this function:

getSupportedRepositoryObjectTypes()

ilTestExportOptionXMLRES::getSupportedRepositoryObjectTypes

(

)

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

                                                       : array
    {
        return ['tst'];
    }

init()

ilTestExportOptionXMLRES::init

(

Container

$DIC

)

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

References ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

     : void {
        $this->lng = $DIC['lng'];
        $this->irss = $DIC['resource_storage'];
        $this->data_factory = new DataFactory();
        $this->repository = TestDIC::dic()['exportimport.repository'];
    }

Here is the call graph for this function:

onDeleteFiles()

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

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

References ILIAS\UI\examples\Deck\repository().

     : void {
        $object_id = new ObjectId($context->exportObject()->getId());
        foreach ($file_identifiers as $file_identifier) {
            $rid = $this->irss->manage()->find($file_identifier->getIdentifier());
            $this->repository->delete($rid);
            $this->irss->manage()->remove($rid, new ResultsExportStakeholder());
        }
    }

Here is the call graph for this function:

onDownloadFiles()

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

Definition at line 86 of file class.ilTestExportOptionXMLRES.php.

     : void {
        $object_id = new ObjectId($context->exportObject()->getId());
        foreach ($file_identifiers as $file_identifier) {
            $this->irss->consume()->download(
                $this->irss->manage()->find($file_identifier->getIdentifier())
            )->run();
        }
    }

onDownloadWithLink()

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

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

     : void {
        $this->irss->consume()->download($reference_id)->run();
    }

onExportOptionSelected()

ilTestExportOptionXMLRES::onExportOptionSelected

(

ilExportHandlerConsumerContextInterface

$context

)

Definition at line 125 of file class.ilTestExportOptionXMLRES.php.

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

Field Documentation

$data_factory

DataFactory ilTestExportOptionXMLRES::$data_factory

private

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

$irss

ResourceStorage ilTestExportOptionXMLRES::$irss

private

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

$lng

ilLanguage ilTestExportOptionXMLRES::$lng

private

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

$repository

DBRepository ilTestExportOptionXMLRES::$repository

private

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

OPTIONS_ID

const ilTestExportOptionXMLRES::OPTIONS_ID = 'test_exp_option_xmlres'

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

---

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

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