PHP Класс Kimai_Export_ExcelExporter

Автор: Florian Lentsch ([email protected])
Наследование: extends PHPExcel
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$columns_dict array dictionary value: column name as in extensions/ki_export/templates/scripts/main.php key: true if active, else false
$customTimeformat string strftime format string for fields of type time
$exportData_arr array the data rows to be exported
$kga array Kimai Global Array

Защищенные свойства (Protected)

Свойство Тип Описание
$COLUMN_CONFIG array Column configuration: columns_dict> => [ 'fieldName' => exportData_arr - defaults to the same field name as in $this->columns> 'type' => 'langLabel' => kga['lang'] - defaults to the same as the field name in $this->columns> 'sum' => boolean - if true, sums will be generated for this field ]
$activeColumns_arr array contains names (as in $this->columns_dict) of active columns
$anySumsWereAdded boolean true, if there are any active columns with sums, else false
$dateFormat string excel format string for fields of type date
$sheet PHPExcel_Worksheet the first (and only) worksheet
$timeFormat string excel format string for fields of type time

Открытые методы

Метод Описание
render ( array $kga, array $exportData_arr, array $columns_dict, string $customTimeformat ) generates an .xlsx file containing time sheets to be exported the file will be sent to the browser for download/viewing

Защищенные методы

Метод Описание
addCellBorders ( ) add cell borders
doLayouting ( ) do layouting (cell borders, font styles, background colors, cell sizing, page setup)
excelAddr ( integer $x, integer $y ) : string get excel field address by supplying coordinates (e.g. '1/1' becomes 'B2')
excelColumnAddr ( integer $n ) : string get excel column letter by index (e.g. '2' becomes 'C') using this over PHPExcels built-in methods, because they are partly 1-based instead of 0-based
excelRange ( $x1, $y1, $x2, $y2 ) : string get excel field range by supplying coordinates
formatDataRowsByType ( ) cell formatting (number/text/date .
formatHeaders ( ) format the headers (additional cell borders, background color, alignment)
formatSums ( ) format the sums row if there are any sums (borders and background color)
initialize ( ) initial PHPExcel settings; build $this->activeColumns_arr
renderExcel ( ) renders the excel and sends it to the browser
writeDataRows ( ) write the data rows for all active columns
writeHeaders ( ) write the headers for all active columns
writeSums ( ) write sums for active columns only if configured in self::$COLUMN_CONFIG

Описание методов

addCellBorders() защищенный Метод

add cell borders
protected addCellBorders ( )

doLayouting() защищенный Метод

do layouting (cell borders, font styles, background colors, cell sizing, page setup)
protected doLayouting ( )

excelAddr() защищенный статический Метод

get excel field address by supplying coordinates (e.g. '1/1' becomes 'B2')
protected static excelAddr ( integer $x, integer $y ) : string
$x integer horizontal coordinate
$y integer vertical coordinate
Результат string excel field address

excelColumnAddr() защищенный статический Метод

get excel column letter by index (e.g. '2' becomes 'C') using this over PHPExcels built-in methods, because they are partly 1-based instead of 0-based
protected static excelColumnAddr ( integer $n ) : string
$n integer column index
Результат string excel column letter

excelRange() защищенный статический Метод

get excel field range by supplying coordinates
protected static excelRange ( $x1, $y1, $x2, $y2 ) : string
Результат string excel field range

formatDataRowsByType() защищенный Метод

..) as configured in self::$COLUMN_CONFIG
protected formatDataRowsByType ( )

formatHeaders() защищенный Метод

format the headers (additional cell borders, background color, alignment)
protected formatHeaders ( )

formatSums() защищенный Метод

format the sums row if there are any sums (borders and background color)
protected formatSums ( )

initialize() защищенный Метод

initial PHPExcel settings; build $this->activeColumns_arr
protected initialize ( )

render() публичный Метод

generates an .xlsx file containing time sheets to be exported the file will be sent to the browser for download/viewing
public render ( array $kga, array $exportData_arr, array $columns_dict, string $customTimeformat )
$kga array Kimai Global Array
$exportData_arr array the data rows to be exported
$columns_dict array dictionary of columns: column name => active (true/false)
$customTimeformat string strftime format string for fields of type time (for dates $this->kga['conf']['date_format_1'] will be used)

renderExcel() защищенный Метод

renders the excel and sends it to the browser
protected renderExcel ( )

writeDataRows() защищенный Метод

write the data rows for all active columns
protected writeDataRows ( )

writeHeaders() защищенный Метод

write the headers for all active columns
protected writeHeaders ( )

writeSums() защищенный Метод

write sums for active columns only if configured in self::$COLUMN_CONFIG
protected writeSums ( )

Описание свойств

$COLUMN_CONFIG защищенное статическое свойство

Column configuration: columns_dict> => [ 'fieldName' => exportData_arr - defaults to the same field name as in $this->columns> 'type' => 'langLabel' => kga['lang'] - defaults to the same as the field name in $this->columns> 'sum' => boolean - if true, sums will be generated for this field ]
protected static array $COLUMN_CONFIG
Результат array

$activeColumns_arr защищенное свойство

contains names (as in $this->columns_dict) of active columns
protected array $activeColumns_arr
Результат array

$anySumsWereAdded защищенное свойство

true, if there are any active columns with sums, else false
protected bool $anySumsWereAdded
Результат boolean

$columns_dict публичное свойство

dictionary value: column name as in extensions/ki_export/templates/scripts/main.php key: true if active, else false
public array $columns_dict
Результат array

$customTimeformat публичное свойство

strftime format string for fields of type time
public string $customTimeformat
Результат string

$dateFormat защищенное свойство

excel format string for fields of type date
protected string $dateFormat
Результат string

$exportData_arr публичное свойство

the data rows to be exported
public array $exportData_arr
Результат array

$kga публичное свойство

Kimai Global Array
public array $kga
Результат array

$sheet защищенное свойство

the first (and only) worksheet
protected PHPExcel_Worksheet $sheet
Результат PHPExcel_Worksheet

$timeFormat защищенное свойство

excel format string for fields of type time
protected string $timeFormat
Результат string