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 ($ref_id, $table_id=null, $filter=array())

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

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

	export ($format=self::EXPORT_EXCEL, $filepath=null, $send=false)
	Creates an export of a specific datacollection table. More...

	exportAsync ($format=self::EXPORT_EXCEL, $filepath=null)
	Start Export async. More...

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, $row)
	Fill a excel row. More...

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

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

Protected Attributes
	$ref_id

	$table_id

	$filter

	$dcl

	$lng

	$table

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.

Author: Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

◆ __construct()

ilDclContentExporter::__construct	(	$ref_id,
		$table_id = `null`,
		$filter = `array()`
	)

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

    {
        global $DIC;
        $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)? array($this->dcl->getTableById($table_id)) : $this->dcl->getTables();
 
        $lng->loadLanguageModule('dcl');
        $this->lng = $lng;
    }

References $DIC, $filter, $lng, $ref_id, and $table_id.

Member Function Documentation

◆ export()

int $table_id Table Id for ilDclContentExporter::export	(	$format = `self::EXPORT_EXCEL`,
		$filepath = `null`,
		$send = `false`
	)

Creates an export of a specific datacollection table.

Parameters

string	$format
null	$filepath
bool \| false	$send

Returns: null|string|void

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

    {
        if (count($this->tables) == 0) {
            return;
        }
 
        if (empty($filepath)) {
            $filepath = $this->getExportContentPath($format);
            ilUtil::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;
        switch ($format) {
            case self::EXPORT_EXCEL:
                require_once "./Services/Excel/classes/class.ilExcel.php";
 
                $adapter = new ilExcel();
                foreach ($this->tables as $table) {
                    ilDclCache::resetCache();
 
                    $list = $table->getPartialRecords(null, null, 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
                        $pre = $row;
                        $this->fillHeaderExcel($table, $adapter, $row);
                        if ($pre == $row) {
                            $row++;
                        }
 
                        foreach ($list['records'] as $set) {
                            $this->fillRowExcel($table, $adapter, $set, $row);
                            $row++; // #14760
                        }
 
                        $data_available = true;
                    }
                }
                break;
        }
        
        if (file_exists($in_progress_file)) {
            unlink($in_progress_file);
        }
 
        if (!$data_available) {
            ilUtil::sendInfo($this->lng->txt('dcl_no_export_content_available'));
            return false;
        }
 
        if (!$fields_available) {
            global $ilCtrl;
            ilUtil::sendInfo(sprintf(
                $this->lng->txt('dcl_no_export_fields_available'),
                $ilCtrl->getLinkTargetByClass(array('ilDclTableListGUI', 'ilDclTableEditGUI', 'ilDclFieldListGUI'), 'listFields')
            ));
            return false;
        }
 
        if ($send) {
            $adapter->sendToClient($filename);
            exit;
        } else {
            $adapter->writeToFile($filepath);
        }
    }

References $adapter, $filename, $format, $ilCtrl, $list, $row, $table, $title, date, exit, EXPORT_EXCEL, fillHeaderExcel(), fillMetaExcel(), fillRowExcel(), getExportContentPath(), IN_PROGRESS_POSTFIX, ilUtil\makeDirParents(), ilDclCache\resetCache(), sanitizeFilename(), ilUtil\sendInfo(), and sprintf.

Here is the call graph for this function:

◆ exportAsync()

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

Start Export async.

Parameters

string	$format
null	$filepath

Returns: mixed

Exceptions

ilDclException

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

    {
        global $DIC;
        $ilLog = $DIC['ilLog'];
 
        $method = self::SOAP_FUNCTION_NAME;
 
        $soap_params = array($this->dcl->getRefId());
        array_push($soap_params, $this->table_id, $format, $filepath);
 
        $new_session_id = ilSession::_duplicate($_COOKIE['PHPSESSID']);
        $client_id = $_COOKIE['ilClientId'];
 
        // Start cloning process using soap call
        include_once 'Services/WebServices/SOAP/classes/class.ilSoapClient.php';
 
        $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');
            require_once('./webservice/soap/include/inc.soap_functions.php');
            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;
    }

References $_COOKIE, $client_id, $DIC, $format, $ilLog, $res, ilSession\_duplicate(), and SOAP_FUNCTION_NAME.

Here is the call graph for this function:

◆ fillHeaderExcel()

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

protected

Fill Excel header.

Parameters

ilDclTable	$table
ilExcel	$worksheet
	$row

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

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

References $row, $table, and $worksheet.

Referenced by export().

Here is the caller graph for this function:

◆ fillMetaExcel()

ilDclContentExporter::fillMetaExcel	(	$table,
		$worksheet,
		$row
	)

protected

Fill Excel meta-data.

Parameters

$table
$worksheet
$row

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

146 {

147 }

Referenced by export().

Here is the caller graph for this function:

◆ fillRowExcel()

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

protected

Fill a excel row.

Parameters

ilDclTable	$table
ilExcel	$worksheet
ilDclBaseRecordModel	$record
	$row

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

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

References $row, $table, $worksheet, and ilDclBaseRecordModel\fillRecordFieldExcelExport().

Referenced by export().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExportContentPath()

ilDclContentExporter::getExportContentPath ( $format )

Return export path.

Parameters

$format

Returns: string

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

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

References $format, and ilExport\_getExportDirectory().

Referenced by export().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sanitizeFilename()

ilDclContentExporter::sanitizeFilename ( $filename )

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

Parameters

$filename

Returns: string

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

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