Hook-Class for exporting data-collections (used in SOAP-Class) This Class avoids duplicated code by routing the request to the right place. More...

Collaboration diagram for ilDclContentExporter:

Public Member Functions
	__construct (int $ref_id, ?int $table_id, array $filter=[])

	sanitizeFilename (string $filename)
	Sanitize the given filename The ilUtil::_sanitizeFilename() does not clean enough. More...

	getExportContentPath (string $format)
	Return export path. More...

	export (string $format=self::EXPORT_EXCEL, ?string $filepath=null, bool $send=false)
	Creates an export of a specific data collection table. More...

	exportAsync (string $format=self::EXPORT_EXCEL, ?string $filepath=null)

Data Fields
const	SOAP_FUNCTION_NAME = 'exportDataCollectionContent'

const	EXPORT_EXCEL = 'xlsx'

const	IN_PROGRESS_POSTFIX = '.prog'

Protected Member Functions
	fillRowExcel (ilDclTable $table, ilExcel $worksheet, ilDclBaseRecordModel $record, int $row)
	Fill a excel row. More...

	fillHeaderExcel (ilDclTable $table, ilExcel $worksheet, int $row)
	Fill Excel header. More...

	fillMetaExcel (ilDclTable $table, ilExcel $worksheet, int $row)
	Fill Excel meta-data. More...

Protected Attributes
int	$ref_id
	Ref-ID of DataCollection. More...

int	$table_id
	Table-Id for export. More...

array	$filter
	Array with filters. More...

ilObjDataCollection	$dcl

ilLanguage	$lng

ilDclTable	$table

array	$tables

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Detailed Description

Hook-Class for exporting data-collections (used in SOAP-Class) This Class avoids duplicated code by routing the request to the right place.

Definition at line 25 of file class.ilDclContentExporter.php.

Constructor & Destructor Documentation

◆ __construct()

ilDclContentExporter::__construct	(	int	$ref_id,
		?int	$table_id,
		array	$filter = `[]`
	)

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

References $DIC, $filter, $lng, $ref_id, $table_id, ILIAS\Repository\filter(), ILIAS\Repository\lng(), and ilLanguage\loadLanguageModule().

     {
         global $DIC;
         $this->main_tpl = $DIC->ui()->mainTemplate();
         $lng = $DIC['lng'];
 
         $this->ref_id = $ref_id;
         $this->table_id = $table_id;
         $this->filter = $filter;
 
         $this->dcl = new ilObjDataCollection($ref_id);
         $this->tables = ($table_id) ? [$this->dcl->getTableById($table_id)] : $this->dcl->getTables();
 
         $lng->loadLanguageModule('dcl');
         $this->lng = $lng;
     }

Here is the call graph for this function:

Member Function Documentation

◆ export()

ilDclContentExporter::export	(	string	$format = `self::EXPORT_EXCEL`,
		?string	$filepath = `null`,
		bool	$send = `false`
	)

Creates an export of a specific data collection table.

Returns: bool|void

Exceptions

Definition at line 130 of file class.ilDclContentExporter.php.

References $filename, $filter, fillHeaderExcel(), fillMetaExcel(), fillRowExcel(), getExportContentPath(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ILIAS\Repository\lng(), ilFileUtils\makeDirParents(), null, ilDclCache\resetCache(), and sanitizeFilename().

Referenced by ilDclRecordListTableGUI\exportData().

     {
         if (count($this->tables) == 0) {
             return;
         }
 
         if (empty($filepath)) {
             $filepath = $this->getExportContentPath($format);
             ilFileUtils::makeDirParents($filepath);
 
             $basename = (isset($this->table_id)) ? $this->tables[0]->getTitle() : 'complete';
             $filename = time() . '__' . $basename . "_" . date("Y-m-d_H-i");
 
             $filepath .= $this->sanitizeFilename($filename);
         } else {
             $filename = pathinfo($filepath, PATHINFO_FILENAME);
         }
 
         $in_progress_file = $filepath . self::IN_PROGRESS_POSTFIX;
         file_put_contents($in_progress_file, "");
 
         $data_available = false;
         $fields_available = false;
         $adapter = new ilExcel();
         if ($format == self::EXPORT_EXCEL) {
             foreach ($this->tables as $table) {
                 ilDclCache::resetCache();
 
                 $list = $table->getPartialRecords((string) $this->dcl->getRefId(), 'id', 'asc', null, 0, $this->filter);
                 $data_available = $data_available || ($list['total'] > 0);
                 $fields_available = $fields_available || (count($table->getExportableFields()) > 0);
                 if ($list['total'] > 0 && count($table->getExportableFields()) > 0) {
                     // only 31 character-long table-titles are allowed
                     $title = substr($table->getTitle(), 0, 31);
                     $adapter->addSheet($title);
                     $row = 1;
 
                     $this->fillMetaExcel($table, $adapter, $row);
 
                     // #14813
                     $this->fillHeaderExcel($table, $adapter, $row);
                     $row++;
 
                     foreach ($list['records'] as $set) {
                         $this->fillRowExcel($table, $adapter, $set, $row);
                         $row++; // #14760
                     }
 
                     $data_available = true;
                 }
             }
         }
 
         if (file_exists($in_progress_file)) {
             unlink($in_progress_file);
         }
 
         if (!$data_available || !$fields_available) {
             $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('dcl_no_export_data_available'));
             return false;
         }
 
         if ($send) {
             $adapter->sendToClient($filename);
         } else {
             $adapter->writeToFile($filepath);
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportAsync()

ilDclContentExporter::exportAsync	(	string	$format = `self::EXPORT_EXCEL`,
		?string	$filepath = `null`
	)

Definition at line 200 of file class.ilDclContentExporter.php.

References $_COOKIE, $client_id, $DIC, $res, $table_id, and ilSession\_duplicate().

Referenced by ilObjDataCollectionGUI\handleExportAsync().

                                                                                             : mixed
     {
         global $DIC;
         $ilLog = $DIC['ilLog'];
 
         $method = self::SOAP_FUNCTION_NAME;
 
         $soap_params = [$this->dcl->getRefId()];
         array_push($soap_params, $this->table_id, $format, $filepath);
 
         $new_session_id = ilSession::_duplicate($_COOKIE[session_name()]);
         $client_id = $_COOKIE['ilClientId'];
 
         // Start cloning process using soap call
         $soap_client = new ilSoapClient();
         $soap_client->setResponseTimeout(5);
         $soap_client->enableWSDL(true);
 
         $ilLog->write(__METHOD__ . ': Trying to call Soap client...');
 
         array_unshift($soap_params, $new_session_id . '::' . $client_id);
 
         if ($soap_client->init()) {
             $ilLog->info('Calling soap ' . $method . ' method with params ' . print_r($soap_params, true));
             $res = $soap_client->call($method, $soap_params);
         } else {
             $ilLog->warning('SOAP clone call failed. Calling clone method manually');
             if (method_exists('ilSoapFunctions', $method)) {
                 $res = ilSoapFunctions::$method(
                     $new_session_id . '::' . $client_id,
                     $this->dcl->getRefId(),
                     $this->table_id,
                     $format,
                     $filepath
                 );
             } else {
                 throw new ilDclException("SOAP call " . $method . " does not exists!");
             }
         }
 
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillHeaderExcel()

ilDclContentExporter::fillHeaderExcel	(	ilDclTable	$table,
		ilExcel	$worksheet,
		int	$row
	)

protected

Fill Excel header.

Definition at line 107 of file class.ilDclContentExporter.php.

References ilDclTable\getFields().

Referenced by export().

                                                                                        : void
     {
         $col = 0;
 
         foreach ($table->getFields() as $field) {
             if ($field->getExportable()) {
                 $field->fillHeaderExcel($worksheet, $row, $col);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillMetaExcel()

ilDclContentExporter::fillMetaExcel	(	ilDclTable	$table,
		ilExcel	$worksheet,
		int	$row
	)

protected

Fill Excel meta-data.

Definition at line 121 of file class.ilDclContentExporter.php.

Referenced by export().

                                                                                      : void
     {
     }

Here is the caller graph for this function:

◆ fillRowExcel()

ilDclContentExporter::fillRowExcel	(	ilDclTable	$table,
		ilExcel	$worksheet,
		ilDclBaseRecordModel	$record,
		int	$row
	)

protected

Fill a excel row.

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

References ilDclBaseRecordModel\fillRecordFieldExcelExport(), and ilDclTable\getFields().

Referenced by export().

      : void {
         $col = 0;
         foreach ($table->getFields() as $field) {
             if ($field->getExportable()) {
                 $record->fillRecordFieldExcelExport($worksheet, $row, $col, $field->getId());
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExportContentPath()

ilDclContentExporter::getExportContentPath ( string $format )

Return export path.

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

References ilExport\_getExportDirectory().

Referenced by export().

                                                         : string
     {
         return ilExport::_getExportDirectory($this->dcl->getId(), $format, 'dcl') . '/';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sanitizeFilename()

ilDclContentExporter::sanitizeFilename ( string $filename )

Sanitize the given filename The ilUtil::_sanitizeFilename() does not clean enough.

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

Referenced by export().

                                                       : string
     {
         $dangerous_filename_characters = [" ", '"', "'", "&", "/", "\\", "?", "#", "`"];
 
         return str_replace($dangerous_filename_characters, "_", iconv("utf-8", "ascii//TRANSLIT", $filename));
     }