ilExcel Class Reference

Inheritance diagram for ilExcel:

Collaboration diagram for ilExcel:

Public Member Functions
	__construct ()
	loadFromFile (string $filename)
	Loads a spreadsheet from file. More...
	getValidFormats ()
	setFormat (string $a_format)
	Set file format. More...
	addSheet (string $a_name, bool $a_activate=true)
	Add sheet. More...
	setActiveSheet (int $a_index)
	getSheetCount ()
	Returns number of sheets. More...
	getSheetTitle ()
	Return the current sheet title. More...
	setCellByCoordinates ($a_coords, $a_value)
	Set cell value by coordinates. More...
	setCell (int $a_row, int $a_col, $a_value, ?string $a_datatype=null)
	Set cell value. More...
	setCellArray (array $a_values, string $a_top_left='A1', $a_null_value=null)
	Set cell values from array. More...
	getCell (int $a_row, int $a_col)
	Returns the value of a cell. More...
	getSheetAsArray ()
	Returns the active sheet as an array. More...
	getColumnCount ()
	Returns the number of columns the sheet contains. More...
	getColumnCoord (int $a_col)
	Get column "name" from number. More...
	sendToClient (string $a_file_name)
	Send workbook to client. More...
	writeToFile (string $a_file)
	Save workbook to file. More...
	writeToTmpFile ()
	setBold (string $a_coords)
	Set cell(s) to bold. More...
	setColors (string $a_coords, string $a_background, string $a_font=null)
	Set cell(s) colors. More...
	setBorders (string $a_coords, bool $a_top, bool $a_right=false, bool $a_bottom=false, bool $a_left=false)
	Toggle cell(s) borders. More...
	getCoordByColumnAndRow (int $pColumn=1, int $pRow=1)
	Get cell coordinate (e.g. More...
	addLink (int $a_row, int $a_column, string $a_path)
	columnIndexAdjustment (int $column)
	Adjustment needed because of migration PHPExcel to PhpSpreadsheet. More...
	mergeCells (string $coordinatesRange)

Data Fields
const	FORMAT_XML = 'Xlsx'
const	FORMAT_BIFF = 'Xls'

Protected Member Functions
	prepareValue ($a_value)
	Prepare value for cell. More...
	prepareDateValue (ilDateTime $a_value)
	prepareBooleanValue (bool $a_value)
	prepareString (string $a_value)
	setDateFormat (Cell $a_cell, $a_value)
	Set date format of cell. More...
	setGlobalAutoSize ()
	Set all existing columns on all sheets to autosize. More...
	prepareStorage (string $a_file_name)
	Prepare workbook for storage/delivery. More...

Protected Attributes
string	$format
ilLanguage	$lng
Spreadsheet	$workbook
string	$type

Private Member Functions
	cleanupNonCharachters (string $string)

Private Attributes
array	$noncharacters

Detailed Description

Definition at line 34 of file class.ilExcel.php.

Constructor & Destructor Documentation

__construct()

ilExcel::__construct

(

)

Exceptions

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

References $DIC, ILIAS\Repository\lng(), and setFormat().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->setFormat(self::FORMAT_XML);
        $this->workbook = new Spreadsheet();
        $this->workbook->removeSheetByIndex(0);
    }

Here is the call graph for this function:

Member Function Documentation

addLink()

ilExcel::addLink	(	int	$a_row,
		int	$a_column,
		string	$a_path
	)

Exceptions

Definition at line 559 of file class.ilExcel.php.

References getCoordByColumnAndRow().

     : void {
        $coordinate = $this->getCoordByColumnAndRow($a_column, $a_row);
        $this->workbook->getActiveSheet()->getCell($coordinate)->getHyperlink()->setUrl($a_path);
    }

Here is the call graph for this function:

addSheet()

ilExcel::addSheet	(	string	$a_name,
		bool	$a_activate = true
	)

Add sheet.

Exceptions

Definition at line 122 of file class.ilExcel.php.

References setActiveSheet(), and ilStr\shortenTextExtended().

Referenced by ilSurveyEvaluationGUI\exportResultsDetailsExcel().

     : int {
        #20749
        // see Worksheet::$_invalidCharacters;
        $invalid = ['*', ':', '/', '\\', '?', '[', ']', '\'-', '\''];

        $a_name = str_replace($invalid, '', $a_name);

        // #19056 - phpExcel only allows 31 chars
        // see https://github.com/PHPOffice/PHPExcel/issues/79
        $a_name = ilStr::shortenTextExtended($a_name, 31);

        $sheet = new Worksheet($this->workbook, $a_name);
        $this->workbook->addSheet($sheet);
        $new_index = $this->workbook->getSheetCount() - 1;

        if ($a_activate) {
            $this->setActiveSheet($new_index);
        }

        return $new_index;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cleanupNonCharachters()

ilExcel::cleanupNonCharachters ( string  $string )

private

Definition at line 586 of file class.ilExcel.php.

Referenced by prepareString().

                                                          : string
    {
        return mb_ereg_replace('[' . implode('', $this->noncharacters) . ']', '', $string);
    }

Here is the caller graph for this function:

columnIndexAdjustment()

ilExcel::columnIndexAdjustment

(

int

$column

)

Adjustment needed because of migration PHPExcel to PhpSpreadsheet.

PhpExcel column was 0 index based and PhpSpreadshet set this index to 1

Definition at line 572 of file class.ilExcel.php.

Referenced by getColumnCoord(), and getCoordByColumnAndRow().

                                                      : int
    {
        return ++$column;
    }

Here is the caller graph for this function:

getCell()

ilExcel::getCell	(	int	$a_row,
		int	$a_col
	)

Returns the value of a cell.

Returns

mixed

Definition at line 353 of file class.ilExcel.php.

References getCoordByColumnAndRow().

Referenced by ilDclTextRecordFieldModel\getValueFromExcel(), ilDclBaseRecordFieldModel\getValueFromExcel(), and ilDclStandardField\getValueFromExcel().

      {
        $coordinate = $this->getCoordByColumnAndRow($a_col, $a_row);
        return $this->workbook->getActiveSheet()->getCell($coordinate)->getValue();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getColumnCoord()

ilExcel::getColumnCoord

(

int

$a_col

)

Get column "name" from number.

Definition at line 380 of file class.ilExcel.php.

References columnIndexAdjustment().

Referenced by ilSumScoreTableGUI\fillHeaderExcel(), ilTrObjectUsersPropsTableGUI\fillHeaderExcel(), ilTrUserObjectsPropsTableGUI\fillHeaderExcel(), ilTrMatrixTableGUI\fillHeaderExcel(), ilBookingReservationsTableGUI\fillHeaderExcel(), ilTrSummaryTableGUI\fillHeaderExcel(), ilTable2GUI\fillHeaderExcel(), assNumeric\setExportDetailsXLSX(), assTextQuestion\setExportDetailsXLSX(), assLongMenu\setExportDetailsXLSX(), assImagemapQuestion\setExportDetailsXLSX(), assFileUpload\setExportDetailsXLSX(), assKprimChoice\setExportDetailsXLSX(), assMultipleChoice\setExportDetailsXLSX(), assSingleChoice\setExportDetailsXLSX(), assOrderingQuestion\setExportDetailsXLSX(), assFormulaQuestion\setExportDetailsXLSX(), assClozeTest\setExportDetailsXLSX(), and assQuestion\setExportDetailsXLSX().

                                              : string
    {
        $col = $this->columnIndexAdjustment($a_col);
        return Coordinate::stringFromColumnIndex($col);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getColumnCount()

ilExcel::getColumnCount

(

)

Returns the number of columns the sheet contains.

Definition at line 372 of file class.ilExcel.php.

                                    : int
    {
        return Coordinate::columnIndexFromString($this->workbook->getActiveSheet()->getHighestDataColumn());
    }

getCoordByColumnAndRow()

ilExcel::getCoordByColumnAndRow	(	int	$pColumn = 1,
		int	$pRow = 1
	)

Get cell coordinate (e.g.

"B2") for column and row number

Definition at line 546 of file class.ilExcel.php.

References columnIndexAdjustment().

Referenced by addLink(), ilSurveyEvaluationGUI\exportResultsDetailsExcel(), getCell(), ilAssExcelFormatHelper\setCell(), and setCell().

     : string {
        $col = $this->columnIndexAdjustment($pColumn);
        $columnLetter = Coordinate::stringFromColumnIndex($col);

        return $columnLetter . $pRow;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSheetAsArray()

ilExcel::getSheetAsArray

(

)

Returns the active sheet as an array.

Definition at line 364 of file class.ilExcel.php.

                                     : array
    {
        return $this->workbook->getActiveSheet()->toArray();
    }

getSheetCount()

ilExcel::getSheetCount

(

)

Returns number of sheets.

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

                                   : int
    {
        return $this->workbook->getSheetCount();
    }

getSheetTitle()

ilExcel::getSheetTitle

(

)

Return the current sheet title.

Definition at line 168 of file class.ilExcel.php.

                                   : string
    {
        return $this->workbook->getActiveSheet()->getTitle();
    }

getValidFormats()

ilExcel::getValidFormats

(

)

Returns

list<string>

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

Referenced by setFormat().

                                     : array
    {
        return [self::FORMAT_XML, self::FORMAT_BIFF];
    }

Here is the caller graph for this function:

loadFromFile()

ilExcel::loadFromFile

(

string

$filename

)

Loads a spreadsheet from file.

Definition at line 85 of file class.ilExcel.php.

                                                  : void
    {
        $this->workbook = IOFactory::load($filename);
    }

mergeCells()

ilExcel::mergeCells

(

string

$coordinatesRange

)

Parameters

string

$coordinatesRange

A coordinates range string like 'A1:B5'

Exceptions

Definition at line 581 of file class.ilExcel.php.

                                                        : void
    {
        $this->workbook->getActiveSheet()->mergeCells($coordinatesRange);
    }

prepareBooleanValue()

ilExcel::prepareBooleanValue ( bool  $a_value )

protected

Definition at line 223 of file class.ilExcel.php.

References $lng, and ilLanguage\txt().

Referenced by prepareValue().

                                                         : string
    {
        $lng = $this->lng;

        return $a_value ? $lng->txt('yes') : $lng->txt('no');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareDateValue()

ilExcel::prepareDateValue ( ilDateTime  $a_value )

protected

Parameters

ilDateTime

$a_value

Returns

false|float

Definition at line 208 of file class.ilExcel.php.

References ilDateTime\get(), IL_CAL_DATE, and IL_CAL_DATETIME.

Referenced by prepareValue().

    {
        switch (true) {
            case $a_value instanceof ilDate:
                $a_value = Date::stringToExcel($a_value->get(IL_CAL_DATE));
                break;

            default:
                $a_value = Date::stringToExcel($a_value->get(IL_CAL_DATETIME));
                break;
        }

        return $a_value;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareStorage()

ilExcel::prepareStorage ( string  $a_file_name )

protected

Prepare workbook for storage/delivery.

Definition at line 410 of file class.ilExcel.php.

References setGlobalAutoSize().

Referenced by sendToClient(), and writeToFile().

                                                          : string
    {
        $this->setGlobalAutoSize();
        $this->workbook->setActiveSheetIndex(0);

        switch ($this->format) {
            case self::FORMAT_BIFF:
                if (stripos($a_file_name, '.xls') === false) {
                    $a_file_name .= '.xls';
                }
                break;

            case self::FORMAT_XML:
                if (stripos($a_file_name, '.xlsx') === false) {
                    $a_file_name .= '.xlsx';
                }
                break;
        }

        return $a_file_name;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareString()

ilExcel::prepareString ( string  $a_value )

protected

Definition at line 230 of file class.ilExcel.php.

References cleanupNonCharachters().

Referenced by prepareValue().

                                                     : string
    {
        return $this->cleanupNonCharachters(
            strip_tags($a_value)
        ); // #14542
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareValue()

ilExcel::prepareValue (   $a_value )

protected

Prepare value for cell.

Parameters

mixed

$a_value

Returns

mixed

Exceptions

InvalidArgumentException

Definition at line 184 of file class.ilExcel.php.

References prepareBooleanValue(), prepareDateValue(), and prepareString().

Referenced by ilAssExcelFormatHelper\setCell(), setCell(), setCellArray(), ilAssExcelFormatHelper\setCellByCoordinates(), and setCellByCoordinates().

    {
        if (is_bool($a_value)) {
            return $this->prepareBooleanValue($a_value);
        }

        if ($a_value instanceof ilDateTime) {
            return $this->prepareDateValue($a_value);
        }

        if (is_string($a_value)) {
            if (!mb_check_encoding($a_value, 'UTF-8')) {
                throw new InvalidArgumentException('Invalid UTF-8 passed.');
            }
            return $this->prepareString($a_value);
        }

        return $a_value;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendToClient()

ilExcel::sendToClient

(

string

$a_file_name

)

Send workbook to client.

Exceptions

Definition at line 436 of file class.ilExcel.php.

References ilFileDelivery\deliverFileAttached(), ilFileUtils\ilTempnam(), and prepareStorage().

                                                     : void
    {
        $a_file_name = $this->prepareStorage($a_file_name);
        switch ($this->format) {
            case self::FORMAT_BIFF:
                $a_mime_type = MimeType::APPLICATION__VND_MS_EXCEL;
                break;

            case self::FORMAT_XML:
                $a_mime_type = MimeType::APPLICATION__VND_OPENXMLFORMATS_OFFICEDOCUMENT_SPREADSHEETML_SHEET;
                break;
            default:
                $a_mime_type = MimeType::APPLICATION__OCTET_STREAM;
                break;
        }
        $tmp_name = ilFileUtils::ilTempnam();

        $writer = IOFactory::createWriter($this->workbook, $this->format);
        $writer->save($tmp_name);

        ilFileDelivery::deliverFileAttached($tmp_name, $a_file_name, $a_mime_type, true);
    }

Here is the call graph for this function:

setActiveSheet()

ilExcel::setActiveSheet

(

int

$a_index

)

Exceptions

Definition at line 150 of file class.ilExcel.php.

Referenced by addSheet().

                                                : void
    {
        $this->workbook->setActiveSheetIndex($a_index);
    }

Here is the caller graph for this function:

setBold()

ilExcel::setBold

(

string

$a_coords

)

Set cell(s) to bold.

Definition at line 487 of file class.ilExcel.php.

Referenced by ilSurveyEvaluationGUI\exportResultsDetailsExcel(), ilSumScoreTableGUI\fillHeaderExcel(), ilLPProgressTableGUI\fillHeaderExcel(), ilTrObjectUsersPropsTableGUI\fillHeaderExcel(), ilTrUserObjectsPropsTableGUI\fillHeaderExcel(), ilTrMatrixTableGUI\fillHeaderExcel(), ilBookingReservationsTableGUI\fillHeaderExcel(), ilTrSummaryTableGUI\fillHeaderExcel(), ilTable2GUI\fillHeaderExcel(), assNumeric\setExportDetailsXLSX(), assTextQuestion\setExportDetailsXLSX(), assLongMenu\setExportDetailsXLSX(), assImagemapQuestion\setExportDetailsXLSX(), assFileUpload\setExportDetailsXLSX(), assKprimChoice\setExportDetailsXLSX(), assMultipleChoice\setExportDetailsXLSX(), assSingleChoice\setExportDetailsXLSX(), assOrderingQuestion\setExportDetailsXLSX(), assFormulaQuestion\setExportDetailsXLSX(), assClozeTest\setExportDetailsXLSX(), and ilAssExcelFormatHelper\setFormattedExcelTitle().

                                             : void
    {
        $this->workbook->getActiveSheet()->getStyle($a_coords)->getFont()->setBold(true);
    }

Here is the caller graph for this function:

setBorders()

ilExcel::setBorders	(	string	$a_coords,
		bool	$a_top,
		bool	$a_right = false,
		bool	$a_bottom = false,
		bool	$a_left = false
	)

Toggle cell(s) borders.

Definition at line 519 of file class.ilExcel.php.

     : void {
        $style = $this->workbook->getActiveSheet()->getStyle($a_coords);

        // :TODO: border styles?
        if ($a_top) {
            $style->getBorders()->getTop()->setBorderStyle(Border::BORDER_THIN);
        }
        if ($a_right) {
            $style->getBorders()->getRight()->setBorderStyle(Border::BORDER_THIN);
        }
        if ($a_bottom) {
            $style->getBorders()->getBottom()->setBorderStyle(Border::BORDER_THIN);
        }
        if ($a_left) {
            $style->getBorders()->getLeft()->setBorderStyle(Border::BORDER_THIN);
        }
    }

setCell()

ilExcel::setCell	(	int	$a_row,
		int	$a_col,
			$a_value,
		?string	$a_datatype = null
	)

Set cell value.

Parameters

int	$a_row
int	$a_col
mixed	$a_value
	?string	$a_datatype Explicit data type, see DataType::TYPE_*

Definition at line 288 of file class.ilExcel.php.

References getCoordByColumnAndRow(), prepareValue(), and setDateFormat().

Referenced by ilSurveyEvaluationGUI\exportResultsDetailsExcel(), ilDclTextSelectionRecordFieldModel\fillExcelExport(), ilDclTextRecordFieldModel\fillExcelExport(), ilDclBaseRecordFieldModel\fillExcelExport(), ilSumScoreTableGUI\fillHeaderExcel(), ilDclTextFieldModel\fillHeaderExcel(), ilSCORMTrackingItemsTableGUI\fillHeaderExcel(), ilSCORM2004TrackingItemsTableGUI\fillHeaderExcel(), ilDclStandardField\fillHeaderExcel(), ilLPProgressTableGUI\fillHeaderExcel(), ilTrObjectUsersPropsTableGUI\fillHeaderExcel(), ilTrUserObjectsPropsTableGUI\fillHeaderExcel(), ilTrMatrixTableGUI\fillHeaderExcel(), ilDclBaseFieldModel\fillHeaderExcel(), ilBookingReservationsTableGUI\fillHeaderExcel(), ilTrSummaryTableGUI\fillHeaderExcel(), ilTable2GUI\fillHeaderExcel(), ilLPTableBaseGUI\fillMetaExcel(), ilDclBaseRecordModel\fillRecordFieldExcelExport(), ilSumScoreTableGUI\fillRowExcel(), ilPollAnswerTableGUI\fillRowExcel(), ilPollUserTableGUI\fillRowExcel(), ilUserLPTableGUI\fillRowExcel(), ilSCORMTrackingItemsTableGUI\fillRowExcel(), ilSCORM2004TrackingItemsTableGUI\fillRowExcel(), ILIAS\MyStaff\ListCompetences\Skills\ilMStListCompetencesSkillsTableGUI\fillRowExcel(), ILIAS\MyStaff\ListCertificates\ilMStListCertificatesTableGUI\fillRowExcel(), ilMStShowUserCoursesTableGUI\fillRowExcel(), ilLPObjectStatisticsTypesTableGUI\fillRowExcel(), ILIAS\MyStaff\ListUsers\ilMStListUsersTableGUI\fillRowExcel(), ilLPObjectStatisticsDailyTableGUI\fillRowExcel(), ilMStListCoursesTableGUI\fillRowExcel(), ilLPObjectStatisticsTableGUI\fillRowExcel(), ilLPProgressTableGUI\fillRowExcel(), ilTrObjectUsersPropsTableGUI\fillRowExcel(), ilTrUserObjectsPropsTableGUI\fillRowExcel(), ilTrMatrixTableGUI\fillRowExcel(), ilBookingReservationsTableGUI\fillRowExcel(), ilTrSummaryTableGUI\fillRowExcel(), ilTable2GUI\fillRowExcel(), and ilSurveyEvaluationGUI\parseResultsToExcel().

     : void {
        $coordinate = $this->getCoordByColumnAndRow($a_col, $a_row);

        if ($a_datatype !== null) {
            $this->workbook->getActiveSheet()->setCellValueExplicit(
                $coordinate,
                $this->prepareValue($a_value),
                $a_datatype
            );
        } elseif ($a_value instanceof ilDateTime) {
            $wb = $this->workbook->getActiveSheet()->setCellValue(
                $coordinate,
                $this->prepareValue($a_value)
            );
            $this->setDateFormat($wb->getCell($coordinate), $a_value);
        } elseif (is_numeric($a_value)) {
            $this->workbook->getActiveSheet()->setCellValueExplicit(
                $coordinate,
                $this->prepareValue($a_value),
                DataType::TYPE_NUMERIC
            );
        } else {
            $this->workbook->getActiveSheet()->setCellValueExplicit(
                $coordinate,
                $this->prepareValue($a_value),
                DataType::TYPE_STRING
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCellArray()

ilExcel::setCellArray	(	array	$a_values,
		string	$a_top_left = 'A1',
			$a_null_value = null
	)

Set cell values from array.

Parameters

	array<int,mixed|array<int,mixed>>	$a_values
string	$a_top_left
mixed	$a_null_value	Value in source array that stands for blank cell

Definition at line 330 of file class.ilExcel.php.

References prepareValue().

     : void {
        foreach ($a_values as $row_idx => $cols) {
            if (is_array($cols)) {
                foreach ($cols as $col_idx => $col_value) {
                    $a_values[$row_idx][$col_idx] = $this->prepareValue($col_value);
                }
            } else {
                $a_values[$row_idx] = $this->prepareValue($cols);
            }
        }

        $this->workbook->getActiveSheet()->fromArray($a_values, $a_null_value, $a_top_left);
    }

Here is the call graph for this function:

setCellByCoordinates()

ilExcel::setCellByCoordinates	(		$a_coords,
			$a_value
	)

Set cell value by coordinates.

Parameters

string	$a_coords	Coordinate of the cell, eg: 'A1'
mixed	$a_value

Definition at line 257 of file class.ilExcel.php.

References prepareValue(), and setDateFormat().

                                                             : void
    {
        if ($a_value instanceof ilDateTime) {
            $wb = $this->workbook->getActiveSheet()->setCellValue(
                $a_coords,
                $this->prepareValue($a_value)
            );
            $cell = $wb->getCell($a_coords);
            $this->setDateFormat($cell, $a_value);
        } elseif (is_numeric($a_value)) {
            $this->workbook->getActiveSheet()->setCellValueExplicit(
                $a_coords,
                $this->prepareValue($a_value),
                DataType::TYPE_NUMERIC
            );
        } else {
            $this->workbook->getActiveSheet()->setCellValueExplicit(
                $a_coords,
                $this->prepareValue($a_value),
                DataType::TYPE_STRING
            );
        }
    }

Here is the call graph for this function:

setColors()

ilExcel::setColors	(	string	$a_coords,
		string	$a_background,
		string	$a_font = null
	)

Set cell(s) colors.

Definition at line 495 of file class.ilExcel.php.

Referenced by ilSurveyEvaluationGUI\exportResultsDetailsExcel(), ilSurveyEvaluationGUI\parseResultsToExcel(), and ilAssExcelFormatHelper\setFormattedExcelTitle().

     : void {
        $opts = [
            'fill' => [
                'fillType' => Fill::FILL_SOLID,
                'color' => ['rgb' => $a_background]
            ]
        ];

        if ($a_font) {
            $opts['font'] = [
                'color' => ['rgb' => $a_font]
            ];
        }

        $this->workbook->getActiveSheet()->getStyle($a_coords)->applyFromArray($opts);
    }

Here is the caller graph for this function:

setDateFormat()

ilExcel::setDateFormat ( Cell  $a_cell,   $a_value  )

protected

Set date format of cell.

Parameters

Cell	$a_cell
mixed	$a_value

Definition at line 243 of file class.ilExcel.php.

Referenced by setCell(), and setCellByCoordinates().

                                                            : void
    {
        if ($a_value instanceof ilDate) {
            $a_cell->getStyle()->getNumberFormat()->setFormatCode('dd.mm.yyyy');
        } elseif ($a_value instanceof ilDateTime) {
            $a_cell->getStyle()->getNumberFormat()->setFormatCode('dd.mm.yyyy hh:mm:ss');
        }
    }

Here is the caller graph for this function:

setFormat()

ilExcel::setFormat

(

string

$a_format

)

Set file format.

Definition at line 105 of file class.ilExcel.php.

References getValidFormats().

Referenced by __construct().

                                               : void
    {
        if (in_array($a_format, $this->getValidFormats())) {
            $this->format = $a_format;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setGlobalAutoSize()

ilExcel::setGlobalAutoSize ( )

protected

Set all existing columns on all sheets to autosize.

Definition at line 389 of file class.ilExcel.php.

Referenced by prepareStorage().

                                          : void
    {
        // this may change the active sheet
        foreach ($this->workbook->getWorksheetIterator() as $worksheet) {
            $this->workbook->setActiveSheetIndex($this->workbook->getIndex($worksheet));
            $sheet = $this->workbook->getActiveSheet();
            $cellIterator = $sheet->getRowIterator()->current()->getCellIterator();
            $cellIterator->setIterateOnlyExistingCells(true);
            foreach ($cellIterator as $cell) {
                $sheet->getColumnDimension($cell->getColumn())->setAutoSize(true);
            }
        }
    }

Here is the caller graph for this function:

writeToFile()

ilExcel::writeToFile

(

string

$a_file

)

Save workbook to file.

Exceptions

Definition at line 464 of file class.ilExcel.php.

References prepareStorage().

                                               : void
    {
        $a_file = $this->prepareStorage($a_file);

        $writer = IOFactory::createWriter($this->workbook, $this->format);
        $writer->save($a_file);
    }

Here is the call graph for this function:

writeToTmpFile()

ilExcel::writeToTmpFile

(

)

Exceptions

Definition at line 475 of file class.ilExcel.php.

References $filename, and ilFileUtils\ilTempnam().

                                    : string
    {
        $writer = IOFactory::createWriter($this->workbook, $this->format);
        $filename = ilFileUtils::ilTempnam();
        $writer->save($filename);

        return $filename;
    }

Here is the call graph for this function:

Field Documentation

$format

string ilExcel::$format

protected

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

$lng

ilLanguage ilExcel::$lng

protected

Definition at line 61 of file class.ilExcel.php.

Referenced by prepareBooleanValue().

$noncharacters

array ilExcel::$noncharacters

private

Initial value:

= [
        '\x{FFFE}-\x{FFFF}',
        '\x{1FFFE}-\x{1FFFF}',
        '\x{2FFFE}-\x{2FFFF}',
        '\x{3FFFE}-\x{3FFFF}',
        '\x{4FFFE}-\x{4FFFF}',
        '\x{5FFFE}-\x{5FFFF}',
        '\x{6FFFE}-\x{6FFFF}',
        '\x{7FFFE}-\x{7FFFF}',
        '\x{8FFFE}-\x{8FFFF}',
        '\x{9FFFE}-\x{9FFFF}',
        '\x{AFFFE}-\x{AFFFF}',
        '\x{BFFFE}-\x{BFFFF}',
        '\x{CFFFE}-\x{CFFFF}',
        '\x{DFFFE}-\x{DFFFF}',
        '\x{EFFFE}-\x{EFFFF}',
        '\x{FFFFE}-\x{FFFFF}',
        '\x{10FFFE}-\x{10FFFF}',
        '\x{FDD0}-\x{FDEF}'
    ]

Definition at line 40 of file class.ilExcel.php.

$type

string ilExcel::$type

protected

Definition at line 63 of file class.ilExcel.php.

$workbook

Spreadsheet ilExcel::$workbook

protected

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

FORMAT_BIFF

const ilExcel::FORMAT_BIFF = 'Xls'

Definition at line 37 of file class.ilExcel.php.

FORMAT_XML

const ilExcel::FORMAT_XML = 'Xlsx'

Definition at line 36 of file class.ilExcel.php.

---

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

• Services/Excel/classes/class.ilExcel.php