ILIAS\Export\HTML\ExportOptionBase Class Reference

Inheritance diagram for ILIAS\Export\HTML\ExportOptionBase:

Collaboration diagram for ILIAS\Export\HTML\ExportOptionBase:

Public Member Functions
	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 Attributes
ilExportHTMLStakeholder	$stakeholder
ExportFileDBRepository	$repo
ilCtrl	$ctrl
ilDataFactory	$data_factory

Detailed Description

Definition at line 38 of file ExportOptionBase.php.

Member Function Documentation

getFiles()

ILIAS\Export\HTML\ExportOptionBase::getFiles

(

ilExportHandlerConsumerContextInterface

$context

)

Definition at line 99 of file ExportOptionBase.php.

     : ilExportHandlerFileInfoCollectionInterface {
        $collection_builder = $context->fileCollectionBuilder();
        $object_id = $this->data_factory->objId($context->exportObject()->getId());
        foreach ($this->repo->getAllOfObjectId($context->exportObject()->getId()) as $file) {
            $collection_builder = $collection_builder->withResourceIdentifier(
                $this->repo->getResourceIdForIdString($file->getRid()),
                $object_id,
                $this
            );
        }
        return $collection_builder->collection();
    }

getFileSelection()

ILIAS\Export\HTML\ExportOptionBase::getFileSelection	(	ilExportHandlerConsumerContextInterface	$context,
		ilExportHandlerConsumerFileIdentifierCollectionInterface	$file_identifiers
	)

Reimplemented in ilLearningModuleExportOptionHTML.

Definition at line 85 of file ExportOptionBase.php.

     : ilExportHandlerFileInfoCollectionInterface {
        $collection_builder = $context->fileCollectionBuilder();
        $file_identifiers_array = $file_identifiers->toStringArray();
        foreach ($this->getFiles($context) as $file) {
            if (in_array($file->getFileIdentifier(), $file_identifiers_array)) {
                $collection_builder = $collection_builder->withFileInfo($file);
            }
        }
        return $collection_builder->collection();
    }

init()

ILIAS\Export\HTML\ExportOptionBase::init

(

Container

$DIC

)

Reimplemented in ilBlogExportOptionHTML, ilGlossaryExportOptionHTML, ilLearningModuleExportOptionHTML, and ilWikiExportOptionHTML.

Definition at line 45 of file ExportOptionBase.php.

                                        : void
    {
        $this->ctrl = $DIC->ctrl();
        $this->data_factory = new ilDataFactory();
        $this->repo = $DIC->export()->internal()->repo()->html()->exportFile();
        $this->stakeholder = new \ilExportHTMLStakeholder();
    }

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

Here is the call graph for this function:

onDeleteFiles()

ILIAS\Export\HTML\ExportOptionBase::onDeleteFiles	(	ilExportHandlerConsumerContextInterface	$context,
		ilExportHandlerConsumerFileIdentifierCollectionInterface	$file_identifiers
	)

Definition at line 53 of file ExportOptionBase.php.

     : void {
        foreach ($file_identifiers as $file_identifier) {
            $rid = $file_identifier->getIdentifier();
            $this->repo->delete(
                $context->exportObject()->getId(),
                $rid
            );
        }
    }

References $context.

onDownloadFiles()

ILIAS\Export\HTML\ExportOptionBase::onDownloadFiles	(	ilExportHandlerConsumerContextInterface	$context,
		ilExportHandlerConsumerFileIdentifierCollectionInterface	$file_identifiers
	)

Definition at line 66 of file ExportOptionBase.php.

     : void {
        foreach ($file_identifiers as $file_identifier) {
            $rid = $file_identifier->getIdentifier();
            $this->repo->deliverFile($rid);
        }
    }

onDownloadWithLink()

ILIAS\Export\HTML\ExportOptionBase::onDownloadWithLink	(	ReferenceId	$reference_id,
		ilExportHandlerConsumerFileIdentifierInterface	$file_identifier
	)

Definition at line 76 of file ExportOptionBase.php.

     : void {
        $rid = $file_identifier->getIdentifier();
        $this->repo->deliverFile($rid);
        exit;
    }

Field Documentation

$ctrl

ilCtrl ILIAS\Export\HTML\ExportOptionBase::$ctrl

protected

Definition at line 42 of file ExportOptionBase.php.

$data_factory

ilDataFactory ILIAS\Export\HTML\ExportOptionBase::$data_factory

protected

Definition at line 43 of file ExportOptionBase.php.

$repo

ExportFileDBRepository ILIAS\Export\HTML\ExportOptionBase::$repo

protected

Definition at line 41 of file ExportOptionBase.php.

$stakeholder

ilExportHTMLStakeholder ILIAS\Export\HTML\ExportOptionBase::$stakeholder

protected

Definition at line 40 of file ExportOptionBase.php.

---

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

• components/ILIAS/Export/HTML/ExportOptionBase.php