ilExportExportOptionXML Class Reference

Inheritance diagram for ilExportExportOptionXML:

Collaboration diagram for ilExportExportOptionXML:

Public Member Functions
	init (Container $DIC)
	getExportType ()
	getExportOptionId ()
	getSupportedRepositoryObjectTypes ()
	isPublicAccessPossible ()
	getLabel ()
	onExportOptionSelected (ilExportHandlerConsumerContextInterface $context)
	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)
Public Member Functions inherited from ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicHandler
	__construct ()
	isObjectSupported (ObjectId $object_id)
	isPublicAccessPossible ()

Protected Member Functions
	buildElements (ilExportHandlerConsumerContextInterface $context, ObjectId $object_id, array $file_identifiers, bool $all_elements=false)

Protected Attributes
ilExportHandlerFactoryInterface	$export_handler
ilLanguage	$lng
ilCtrl	$ctrl
ilObjUser	$user
ilDataFactory	$data_factory

Detailed Description

Definition at line 36 of file class.ilExportExportOptionXML.php.

Member Function Documentation

buildElements()

ilExportExportOptionXML::buildElements ( ilExportHandlerConsumerContextInterface  $context, ObjectId  $object_id, array  $file_identifiers, bool  $all_elements = false  )

protected

Definition at line 152 of file class.ilExportExportOptionXML.php.

References $id.

Referenced by getFiles(), and getFileSelection().

     : ilExportHandlerFileInfoCollectionInterface {
        $keys = $this->export_handler->repository()->key()->collection();
        if ($all_elements) {
            $keys = $keys->withElement($this->export_handler->repository()->key()->handler()->withObjectId($object_id));
        }
        if (!$all_elements) {
            foreach ($file_identifiers as $id) {
                $keys = $keys->withElement($this->export_handler->repository()->key()->handler()
                    ->withObjectId($object_id)
                    ->withResourceIdSerialized($id));
            }
        }
        $elements = $this->export_handler->repository()->handler()->getElements($keys);
        $object_id = $this->data_factory->objId($context->exportObject()->getId());
        $collection_builder = $context->fileCollectionBuilder();
        foreach ($elements as $element) {
            $collection_builder = $collection_builder->withResourceIdentifier(
                $element->getIRSSInfo()->getResourceId(),
                $object_id,
                $this
            );
        }
        return $collection_builder->collection();
    }

Here is the caller graph for this function:

getExportOptionId()

ilExportExportOptionXML::getExportOptionId

(

)

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

                                       : string
    {
        return "expxml";
    }

getExportType()

ilExportExportOptionXML::getExportType

(

)

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

                                   : string
    {
        return "xml";
    }

getFiles()

ilExportExportOptionXML::getFiles

(

ilExportHandlerConsumerContextInterface

$context

)

Definition at line 137 of file class.ilExportExportOptionXML.php.

References buildElements().

     : ilExportHandlerFileInfoCollectionInterface {
        $object_id = $this->data_factory->objId($context->exportObject()->getId());
        return $this->buildElements($context, $object_id, [], true);
    }

Here is the call graph for this function:

getFileSelection()

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

Definition at line 144 of file class.ilExportExportOptionXML.php.

References buildElements().

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

Here is the call graph for this function:

getLabel()

ilExportExportOptionXML::getLabel

(

)

Definition at line 77 of file class.ilExportExportOptionXML.php.

References ILIAS\Repository\lng().

                              : string
    {
        return $this->lng->txt("exp_format_dropdown-xml");
    }

Here is the call graph for this function:

getSupportedRepositoryObjectTypes()

ilExportExportOptionXML::getSupportedRepositoryObjectTypes

(

)

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

                                                       : array
    {
        # The standard xml export is a special case.
        # It is by default always enabled, independend of the object types returned.
        # Therefore no object types are returned.
        # The only exception are the special cases: Test, TestQuestionPool
        return [];
    }

init()

ilExportExportOptionXML::init

(

Container

$DIC

)

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

References ILIAS\Repository\ctrl(), ILIAS\DI\Container\ctrl(), ILIAS\DI\Container\language(), ILIAS\Repository\lng(), ILIAS\Repository\user(), and ILIAS\DI\Container\user().

                                        : void
    {
        $this->export_handler = new ilExportHandlerFactory();
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->data_factory = new ilDataFactory();
    }

Here is the call graph for this function:

isPublicAccessPossible()

ilExportExportOptionXML::isPublicAccessPossible

(

)

Definition at line 72 of file class.ilExportExportOptionXML.php.

                                            : bool
    {
        return true;
    }

onDeleteFiles()

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

Definition at line 88 of file class.ilExportExportOptionXML.php.

References ILIAS\Repository\user().

     : void {
        $object_id = $this->data_factory->objId($context->exportObject()->getId());
        $keys = $this->export_handler->repository()->key()->collection();
        foreach ($file_identifiers as $file_identifier) {
            $keys = $keys->withElement($this->export_handler->repository()->key()->handler()
                ->withObjectId($object_id)
                ->withResourceIdSerialized($file_identifier->getIdentifier()));
        }
        $this->export_handler->repository()->handler()->deleteElements(
            $keys,
            $this->export_handler->repository()->stakeholder()->handler()->withOwnerId($this->user->getId())
        );
    }

Here is the call graph for this function:

onDownloadFiles()

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

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

     : void {
        $object_id = $this->data_factory->objId($context->exportObject()->getId());
        $keys = $this->export_handler->repository()->key()->collection();
        foreach ($file_identifiers as $file_identifier) {
            $keys = $keys->withElement($this->export_handler->repository()->key()->handler()
                ->withObjectId($object_id)
                ->withResourceIdSerialized($file_identifier->getIdentifier()));
        }
        $elements = $this->export_handler->repository()->handler()->getElements($keys);
        foreach ($elements as $element) {
            $element->getIRSS()->download();
        }
    }

onDownloadWithLink()

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

Definition at line 122 of file class.ilExportExportOptionXML.php.

References ILIAS\Data\ReferenceId\toObjectId().

     : void {
        $object_id = $reference_id->toObjectId();
        $keys = $this->export_handler->repository()->key()->collection()
            ->withElement($this->export_handler->repository()->key()->handler()
                ->withObjectId($object_id)
                ->withResourceIdSerialized($file_identifier->getIdentifier()));
        $elements = $this->export_handler->repository()->handler()->getElements($keys);
        foreach ($elements as $element) {
            $element->getIRSS()->download();
        }
    }

Here is the call graph for this function:

onExportOptionSelected()

ilExportExportOptionXML::onExportOptionSelected

(

ilExportHandlerConsumerContextInterface

$context

)

Definition at line 82 of file class.ilExportExportOptionXML.php.

References ILIAS\Repository\ctrl().

     : void {
        $this->ctrl->redirect($context->exportGUIObject(), $context->exportGUIObject()::CMD_EXPORT_XML);
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilCtrl ilExportExportOptionXML::$ctrl

protected

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

$data_factory

ilDataFactory ilExportExportOptionXML::$data_factory

protected

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

$export_handler

ilExportHandlerFactoryInterface ilExportExportOptionXML::$export_handler

protected

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

$lng

ilLanguage ilExportExportOptionXML::$lng

protected

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

$user

ilObjUser ilExportExportOptionXML::$user

protected

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

---

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

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