ilSkillExportOption Class Reference

Inheritance diagram for ilSkillExportOption:

Collaboration diagram for ilSkillExportOption:

Public Member Functions
	init (Container $DIC)
	getExportType ()
	getExportOptionId ()
	getSupportedRepositoryObjectTypes ()
	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
ILIAS Data Factory	$data_factory

Detailed Description

Definition at line 29 of file class.ilSkillExportOption.php.

Member Function Documentation

getExportOptionId()

ilSkillExportOption::getExportOptionId

(

)

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

                                       : string
    {
        return 'il_skill_profile_exp';
    }

getExportType()

ilSkillExportOption::getExportType

(

)

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

                                   : string
    {
        return 'xml';
    }

getFiles()

ilSkillExportOption::getFiles

(

ilExportHandlerConsumerContextInterface

$context

)

Definition at line 97 of file class.ilSkillExportOption.php.

References ilExport\_getExportDirectory().

Referenced by getFileSelection().

     : ilExportHandlerFileInfoCollectionInterface {
        $collection_builder = $context->fileCollectionBuilder();
        $export_dir = ilExport::_getExportDirectory($context->exportObject()->getId(), "xml", 'skmg');
        $file_names = file_exists($export_dir) ? scandir($export_dir) : [];
        foreach ($file_names as $file_name) {
            if (in_array($file_name, ['.', '..'])) {
                continue;
            }
            $collection_builder = $collection_builder->withSPLFileInfo(
                new SplFileInfo($export_dir . DIRECTORY_SEPARATOR . $file_name),
                $this->data_factory->objId($context->exportObject()->getId()),
                $this
            );
        }
        return $collection_builder->collection();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFileSelection()

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

Definition at line 116 of file class.ilSkillExportOption.php.

References getFiles().

Referenced by onDeleteFiles(), and onDownloadFiles().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getLabel()

ilSkillExportOption::getLabel

(

)

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

                              : string
    {
        # Return an empty label so that the export button is not displayed in the export tab.
        return '';
    }

getSupportedRepositoryObjectTypes()

ilSkillExportOption::getSupportedRepositoryObjectTypes

(

)

Definition at line 48 of file class.ilSkillExportOption.php.

                                                       : array
    {
        return ['skee'];
    }

init()

ilSkillExportOption::init

(

Container

$DIC

)

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

                                        : void
    {
        $this->data_factory = new \ILIAS\Data\Factory();
    }

onDeleteFiles()

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

Definition at line 65 of file class.ilSkillExportOption.php.

References getFileSelection().

     : void {
        foreach ($this->getFileSelection($context, $file_identifiers) as $file) {
            $exp_dir = $file->getDownloadInfo();
            $file_path = $file->getDownloadInfo() . DIRECTORY_SEPARATOR . $file->getFileName();
            if (is_file($file_path)) {
                unlink($file_path);
            }
        }
    }

Here is the call graph for this function:

onDownloadFiles()

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

Definition at line 78 of file class.ilSkillExportOption.php.

References ilFileDelivery\deliverFileLegacy(), and getFileSelection().

     : void {
        foreach ($this->getFileSelection($context, $file_identifiers) as $file) {
            ilFileDelivery::deliverFileLegacy(
                $file->getDownloadInfo() . DIRECTORY_SEPARATOR . $file->getFileName(),
                $file->getFileName()
            );
        }
    }

Here is the call graph for this function:

onDownloadWithLink()

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

Definition at line 90 of file class.ilSkillExportOption.php.

     : void {

    }

onExportOptionSelected()

ilSkillExportOption::onExportOptionSelected

(

ilExportHandlerConsumerContextInterface

$context

)

Definition at line 59 of file class.ilSkillExportOption.php.

     : void {
        # Do nothing, the export happens in another tab.
    }

Field Documentation

$data_factory

ILIAS Data Factory ilSkillExportOption::$data_factory

protected

Definition at line 31 of file class.ilSkillExportOption.php.

---

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

• components/ILIAS/Skill/Export/class.ilSkillExportOption.php