ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
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.

46 : string
47 {
48 return "orgu_exp_option_simple_xml";
49 }

◆ getExportType()

ilOrgUnitExportOptionXML::getExportType ( )

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

41 : string
42 {
43 return "simple xml";
44 }

◆ getFiles()

ilOrgUnitExportOptionXML::getFiles ( ilExportHandlerConsumerContextInterface  $context)

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

96 : ilExportHandlerFileInfoCollectionInterface {
97 # Direct download on export creation, no local files
98 return $context->fileCollectionBuilder()->collection();
99 }
$context
Definition: webdav.php:31

◆ getFileSelection()

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

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

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

◆ getLabel()

ilOrgUnitExportOptionXML::getLabel ( )

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

62 : string
63 {
64 $this->lng->loadLanguageModule('exp');
65 return $this->lng->txt('simple_xml');
66 }

References ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ getSupportedRepositoryObjectTypes()

ilOrgUnitExportOptionXML::getSupportedRepositoryObjectTypes ( )

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

51 : array
52 {
53 return ["orgu"];
54 }

◆ init()

ilOrgUnitExportOptionXML::init ( Container  $DIC)

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

35 : void
36 {
37 $this->lng = $DIC->language();
38 $this->ctrl = $DIC->ctrl();
39 }
language()
Get interface to the i18n service.
Definition: Container.php:95
ctrl()
Get the interface to the control structure.
Definition: Container.php:63

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

+ Here is the call graph for this function:

◆ isObjectSupported()

ilOrgUnitExportOptionXML::isObjectSupported ( ObjectId  $object_id)

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

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

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

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

+ 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.

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

◆ onDownloadFiles()

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

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

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

◆ onDownloadWithLink()

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

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

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

◆ onExportOptionSelected()

ilOrgUnitExportOptionXML::onExportOptionSelected ( ilExportHandlerConsumerContextInterface  $context)

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

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

References ILIAS\Repository\ctrl().

+ 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: