ilOrgUnitExportOptionXML Class Reference

Inheritance diagram for ilOrgUnitExportOptionXML:

Collaboration diagram for ilOrgUnitExportOptionXML:

Public Member Functions
	init (Container $DIC)
	getExportType ()
	getExportOptionId ()
	getSupportedRepositoryObjectTypes ()
	isObjectSupported (ObjectId $object_id)
	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 Attributes
ilLanguage	$lng
ilCtrlInterface	$ctrl

Detailed Description

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

Member Function Documentation

getExportOptionId()

ilOrgUnitExportOptionXML::getExportOptionId

(

)

Definition at line 46 of file class.ilOrgUnitExportOptionXML.php.

                                       : string
    {
        return "orgu_exp_option_simple_xml";
    }

getExportType()

ilOrgUnitExportOptionXML::getExportType

(

)

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

                                   : string
    {
        return "simple xml";
    }

getFiles()

ilOrgUnitExportOptionXML::getFiles

(

ilExportHandlerConsumerContextInterface

$context

)

Definition at line 94 of file class.ilOrgUnitExportOptionXML.php.

     : ilExportHandlerFileInfoCollectionInterface {
        # Direct download on export creation, no local files
        return $context->fileCollectionBuilder()->collection();
    }

getFileSelection()

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

Definition at line 101 of file class.ilOrgUnitExportOptionXML.php.

     : ilExportHandlerFileInfoCollectionInterface {
        # Direct download on export creation, no local files
        return $context->fileCollectionBuilder()->collection();
    }

getLabel()

ilOrgUnitExportOptionXML::getLabel

(

)

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

getSupportedRepositoryObjectTypes()

ilOrgUnitExportOptionXML::getSupportedRepositoryObjectTypes

(

)

Definition at line 51 of file class.ilOrgUnitExportOptionXML.php.

                                                       : array
    {
        return ["orgu"];
    }

init()

ilOrgUnitExportOptionXML::init

(

Container

$DIC

)

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

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

                                        : void
    {
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
    }

Here is the call graph for this function:

isObjectSupported()

ilOrgUnitExportOptionXML::isObjectSupported

(

ObjectId

$object_id

)

Definition at line 56 of file class.ilOrgUnitExportOptionXML.php.

References ilObjOrgUnit\getRootOrgId(), and ILIAS\Data\ObjectId\toInt().

                                                          : bool
    {
        //Simple XML and Simple XLS Export should only be available in the root orgunit folder as it always exports the whole tree
        return $object_id->toInt() === ilObjOrgUnit::getRootOrgId();
    }

Here is the call graph for this function:

onDeleteFiles()

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

Definition at line 73 of file class.ilOrgUnitExportOptionXML.php.

     : void {
        # Direct download on export creation, no local files
    }

onDownloadFiles()

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

Definition at line 80 of file class.ilOrgUnitExportOptionXML.php.

     : void {
        # Direct download on export creation, no local files
    }

onDownloadWithLink()

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

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

     : void {
        # Direct download on export creation, no local files
    }

onExportOptionSelected()

ilOrgUnitExportOptionXML::onExportOptionSelected

(

ilExportHandlerConsumerContextInterface

$context

)

Definition at line 68 of file class.ilOrgUnitExportOptionXML.php.

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

Field Documentation

$ctrl

ilCtrlInterface ilOrgUnitExportOptionXML::$ctrl

protected

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

$lng

ilLanguage ilOrgUnitExportOptionXML::$lng

protected

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

---

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

• components/ILIAS/OrgUnit/classes/class.ilOrgUnitExportOptionXML.php