fast excel reader
v2.22.1
FastExcelReader является частью проекта FastExcelPhp, который состоит из
Эта библиотека спроектирована так, чтобы быть легкой, сверхбыстрой и требует минимального использования памяти.
FastExcelReader может читать электронные таблицы, совместимые с Excel, в формате XLSX (Office 2007+). Он только считывает данные, но делает это очень быстро и с минимальным использованием памяти.
Функции
Используйте composer для установки FastExcelReader в ваш проект:
composer require avadim/fast-excel-reader
Перейти к:
Больше примеров вы можете найти в папке /demo.
use avadim FastExcelReader Excel ;
$ file = __DIR__ . ' /files/demo-00-simple.xlsx ' ;
// Open XLSX-file
$ excel = Excel:: open ( $ file );
// Read all values as a flat array from current sheet
$ result = $ excel -> readCells ();Вы получите этот массив:
Array
(
[A1] => 'col1'
[B1] => 'col2'
[A2] => 111
[B2] => 'aaa'
[A3] => 222
[B3] => 'bbb'
)
// Read all rows in two-dimensional array (ROW x COL)
$ result = $ excel -> readRows ();Вы получите этот массив:
Array
(
[1] => Array
(
['A'] => 'col1'
['B'] => 'col2'
)
[2] => Array
(
['A'] => 111
['B'] => 'aaa'
)
[3] => Array
(
['A'] => 222
['B'] => 'bbb'
)
)
// Read all columns in two-dimensional array (COL x ROW)
$ result = $ excel -> readColumns ();Вы получите этот массив:
Array
(
[A] => Array
(
[1] => 'col1'
[2] => 111
[3] => 222
)
[B] => Array
(
[1] => 'col2'
[2] => 'aaa'
[3] => 'bbb'
)
)
$ sheet = $ excel -> sheet ();
foreach ( $ sheet -> nextRow () as $ rowNum => $ rowData ) {
// $rowData is array ['A' => ..., 'B' => ...]
$ addr = ' C ' . $ rowNum ;
if ( $ sheet -> hasImage ( $ addr )) {
$ sheet -> saveImageTo ( $ addr , $ fullDirectoryPath );
}
// handling of $rowData here
// ...
}
// OR
foreach ( $ sheet -> nextRow () as $ rowNum => $ rowData ) {
// handling of $rowData here
// ...
// get image list from current row
$ imageList = $ sheet -> getImageListByRow ();
foreach ( $ imageList as $ imageInfo ) {
$ imageBlob = $ sheet -> getImageBlob ( $ imageInfo [ ' address ' ]);
}
}
// OR
foreach ( $ sheet -> nextRow ([ ' A ' => ' One ' , ' B ' => ' Two ' ], Excel:: KEYS_FIRST_ROW ) as $ rowNum => $ rowData ) {
// $rowData is array ['One' => ..., 'Two' => ...]
// ...
}Альтернативный способ чтения построчно
// Init internal read generator
$ sheet -> reset ([ ' A ' => ' One ' , ' B ' => ' Two ' ], Excel:: KEYS_FIRST_ROW );
// read the first row
$ rowData = $ sheet -> readNextRow ();
var_dump ( $ rowData );
// read the next 3 rows
for ( $ i = 0 ; $ i < 3 ; $ i ++) {
$ rowData = $ sheet -> readNextRow ();
var_dump ( $ rowData );
}
// Reset internal generator and read all rows
$ sheet -> reset ([ ' A ' => ' One ' , ' B ' => ' Two ' ], Excel:: KEYS_FIRST_ROW );
$ result = [];
while ( $ rowData = $ sheet -> readNextRow ()) {
$ result [] = $ rowData ;
}
var_dump ( $ result ); // Read rows and use the first row as column keys
$ result = $ excel -> readRows ( true );Вы получите такой результат:
Array
(
[2] => Array
(
['col1'] => 111
['col2'] => 'aaa'
)
[3] => Array
(
['col1'] => 222
['col2'] => 'bbb'
)
)
Необязательный второй аргумент указывает ключи массива результатов.
// Rows and cols start from zero
$ result = $ excel -> readRows ( false , Excel:: KEYS_ZERO_BASED );Вы получите такой результат:
Array
(
[0] => Array
(
[0] => 'col1'
[1] => 'col2'
)
[1] => Array
(
[0] => 111
[1] => 'aaa'
)
[2] => Array
(
[0] => 222
[1] => 'bbb'
)
)
Допустимые значения режима результатов
| параметры режима | описания |
|---|---|
| КЛЮЧИ_ОРИГИНАЛ | строки из «1», столбцы из «A» (по умолчанию) |
| KEYS_ROW_ZERO_BASED | строки с 0 |
| KEYS_COL_ZERO_BASED | столбцы с 0 |
| KEYS_ZERO_BASED | строки с 0, столбцы с 0 (то же самое, что KEYS_ROW_ZERO_BASED + KEYS_COL_ZERO_BASED) |
| KEYS_ROW_ONE_BASED | строки с 1 |
| KEYS_COL_ONE_BASED | столбцы из 1 |
| KEYS_ONE_BASED | строки с 1, столбцы с 1 (то же самое, что KEYS_ROW_ONE_BASED + KEYS_COL_ONE_BASED) |
Дополнительные параметры, которые можно комбинировать с режимами результатов
| параметры | описания |
|---|---|
| KEYS_FIRST_ROW | то же, что истина в первом аргументе |
| KEYS_RELATIVE | индекс из верхней левой ячейки области (не листа) |
| KEYS_SWAP | поменять местами строки и столбцы |
Например
$ result = $ excel -> readRows ([ ' A ' => ' bee ' , ' B ' => ' honey ' ], Excel:: KEYS_FIRST_ROW | Excel:: KEYS_ROW_ZERO_BASED );Вы получите такой результат:
Array
(
[0] => Array
(
[bee] => 111
[honey] => 'aaa'
)
[1] => Array
(
[bee] => 222
[honey] => 'bbb'
)
)
По умолчанию библиотека уже пропускает пустые ячейки и пустые строки. Пустые ячейки — это ячейки, в которых ничего не записано, а пустые строки — это строки, в которых все ячейки пусты. Если ячейка содержит пустую строку, она не считается пустой. Но вы можете изменить это поведение и пропускать ячейки с пустыми строками.
$ sheet = $ excel -> sheet ();
// Skip empty cells and empty rows
foreach ( $ sheet -> nextRow () as $ rowNum => $ rowData ) {
// handle $rowData
}
// Skip empty cells and cells with empty strings
foreach ( $ sheet -> nextRow ([], Excel:: TREAT_EMPTY_STRING_AS_EMPTY_CELL ) as $ rowNum => $ rowData ) {
// handle $rowData
}
// Skip empty cells and empty rows (rows containing only whitespace characters are also considered empty)
foreach ( $ sheet -> nextRow ([], Excel:: TRIM_STRINGS | Excel:: TREAT_EMPTY_STRING_AS_EMPTY_CELL ) as $ rowNum => $ rowData ) {
// handle $rowData
}Другой способ
$ sheet -> reset ([], Excel:: TRIM_STRINGS | Excel:: TREAT_EMPTY_STRING_AS_EMPTY_CELL );
$ rowData = $ sheet -> readNextRow ();
// do something
$ rowData = $ sheet -> readNextRow ();
// handle next row
// ... use avadim FastExcelReader Excel ;
$ file = __DIR__ . ' /files/demo-02-advanced.xlsx ' ;
$ excel = Excel:: open ( $ file );
$ result = [
' sheets ' => $ excel -> getSheetNames () // get all sheet names
];
$ result [ ' #1 ' ] = $ excel
// select sheet by name
-> selectSheet ( ' Demo1 ' )
// select area with data where the first row contains column keys
-> setReadArea ( ' B4:D11 ' , true )
// set date format
-> setDateFormat ( ' Y-m-d ' )
// set key for column 'C' to 'Birthday'
-> readRows ([ ' C ' => ' Birthday ' ]);
// read other arrays with custom column keys
// and in this case we define range by columns only
$ columnKeys = [ ' B ' => ' year ' , ' C ' => ' value1 ' , ' D ' => ' value2 ' ];
$ result [ ' #2 ' ] = $ excel
-> selectSheet ( ' Demo2 ' , ' B:D ' )
-> readRows ( $ columnKeys );
$ result [ ' #3 ' ] = $ excel
-> setReadArea ( ' F5:H13 ' )
-> readRows ( $ columnKeys );Вы можете установить область чтения по определенным именам в книге. Например, если в книге определены заголовки имени с диапазоном Demo1!$B$4:$D$4 , вы можете читать ячейки с этим именем.
$ excel -> setReadArea ( ' Values ' );
$ cells = $ excel -> readCells ();Обратите внимание: поскольку значение содержит имя листа, этот лист становится листом по умолчанию.
Вы можете установить область чтения на листе
$ sheet = $ excel -> getSheet ( ' Demo1 ' )-> setReadArea ( ' Headers ' );
$ cells = $ sheet -> readCells ();Но если вы попытаетесь использовать это имя на другом листе, вы получите ошибку.
$ sheet = $ excel -> getSheet ( ' Demo2 ' )-> setReadArea ( ' Headers ' );
// Exception: Wrong address or range "Values" При необходимости вы можете полностью контролировать процесс чтения с помощью метода readSheetCallback() с callback-функцией.
use avadim FastExcelReader Excel ;
$ excel = Excel:: open ( $ file );
$ result = [];
$ excel -> readCallback ( function ( $ row , $ col , $ val ) use (& $ result ) {
// Any manipulation here
$ result [ $ row ][ $ col ] = ( string ) $ val ;
// if the function returns true then data reading is interrupted
return false ;
});
var_dump ( $ result ); По умолчанию все значения даты и времени возвращаются как отметка времени. Но вы можете изменить это поведение, используя dateFormatter()
$ excel = Excel:: open ( $ file );
$ sheet = $ excel -> sheet ()-> setReadArea ( ' B5:D7 ' );
$ cells = $ sheet -> readCells ();
echo $ cells [ ' C5 ' ]; // -2205187200
// If argument TRUE is passed, then all dates will be formatted as specified in cell styles
// IMPORTANT! The datetime format depends on the locale
$ excel -> dateFormatter ( true );
$ cells = $ sheet -> readCells ();
echo $ cells [ ' C5 ' ]; // '14.02.1900'
// You can specify date format pattern
$ excel -> dateFormatter ( ' Y-m-d ' );
$ cells = $ sheet -> readCells ();
echo $ cells [ ' C5 ' ]; // '1900-02-14'
// set date formatter function
$ excel -> dateFormatter ( fn ( $ value ) => gmdate ( ' m/d/Y ' , $ value ));
$ cells = $ sheet -> readCells ();
echo $ cells [ ' C5 ' ]; // '02/14/1900'
// returns DateTime instance
$ excel -> dateFormatter ( fn ( $ value ) => ( new DateTime ())-> setTimestamp ( $ value ));
$ cells = $ sheet -> readCells ();
echo get_class ( $ cells [ ' C5 ' ]); // 'DateTime'
// custom manipulations with datetime values
$ excel -> dateFormatter ( function ( $ value , $ format , $ styleIdx ) use ( $ excel ) {
// get Excel format of the cell, e.g. '[$-F400]h:mm:ss AM/PM'
$ excelFormat = $ excel -> getFormatPattern ( $ styleIdx );
// get format converted for use in php functions date(), gmdate(), etc
// for example the Excel pattern above would be converted to 'g:i:s A'
$ phpFormat = $ excel -> getDateFormatPattern ( $ styleIdx );
// and if you need you can get value of numFmtId for this cell
$ style = $ excel -> getCompleteStyleByIdx ( $ styleIdx , true );
$ numFmtId = $ style [ ' format-num-id ' ];
// do something and write to $result
$ result = gmdate ( $ phpFormat , $ value );
return $ result ;
});Иногда, если формат ячейки указан как дата, но не содержит дату, библиотека может неправильно интерпретировать это значение. Чтобы этого избежать, вы можете отключить форматирование даты.
Здесь ячейка B1 содержит строку «3.2», а ячейка B2 содержит дату 03 февраля 2024 г., но в обеих ячейках установлен формат даты.
$ excel = Excel:: open ( $ file );
// default mode
$ cells = $ sheet -> readCells ();
echo $ cell [ ' B1 ' ]; // -2208798720 - the library tries to interpret the number 3.2 as a timestamp
echo $ cell [ ' B2 ' ]; // 1706918400 - timestamp of 2024-02-03
// date formatter is on
$ excel -> dateFormatter ( true );
$ cells = $ sheet -> readCells ();
echo $ cell [ ' B1 ' ]; // '03.01.1900'
echo $ cell [ ' B2 ' ]; // '3.2'
// date formatter is off
$ excel -> dateFormatter ( false );
$ cells = $ sheet -> readCells ();
echo $ cell [ ' B1 ' ]; // '3.2'
echo $ cell [ ' B2 ' ]; // 1706918400 - timestamp of 2024-02-03 // Returns count images on all sheets
$ excel -> countImages ();
// Returns count images on sheet
$ sheet -> countImages ();
// Returns image list of sheet
$ sheet -> getImageList ();
// Returns image list of specified row
$ sheet -> getImageListByRow ( $ rowNumber );
// Returns TRUE if the specified cell has an image
$ sheet -> hasImage ( $ cellAddress );
// Returns mime type of image in the specified cell (or NULL)
$ sheet -> getImageMimeType ( $ cellAddress );
// Returns inner name of image in the specified cell (or NULL)
$ sheet -> getImageName ( $ cellAddress );
// Returns an image from the cell as a blob (if exists) or NULL
$ sheet -> getImageBlob ( $ cellAddress );
// Writes an image from the cell to the specified filename
$ sheet -> saveImage ( $ cellAddress , $ fullFilenamePath );
// Writes an image from the cell to the specified directory
$ sheet -> saveImageTo ( $ cellAddress , $ fullDirectoryPath );Библиотека пытается определить типы значений ячеек, и в большинстве случаев делает это правильно. Таким образом, вы получаете числовые или строковые значения. Значения даты по умолчанию возвращаются в виде отметки времени. Но вы можете изменить это поведение, установив формат даты (см. параметры форматирования функции php date()).
$ excel = Excel:: open ( $ file );
$ result = $ excel -> readCells ();
print_r ( $ result );В приведенном выше примере выводится:
Array
(
[B2] => -2205187200
[B3] => 6614697600
[B4] => -6845212800
)
$ excel = Excel:: open ( $ file );
$ excel -> setDateFormat ( ' Y-m-d ' );
$ result = $ excel -> readCells ();
print_r ( $ result );В приведенном выше примере выводится:
Array
(
[B2] => '1900-02-14'
[B3] => '2179-08-12'
[B4] => '1753-01-31'
)
Обычно функции чтения возвращают только значения ячеек, но вы можете читать значения с помощью стилей. В этом случае для каждой ячейки будет возвращено не скалярное значение, а массив вида ['v' => скалярное_значение , 's' => style_array , 'f' => формула ]
$ excel = Excel:: open ( $ file );
$ sheet = $ excel -> sheet ();
$ rows = $ sheet -> readRowsWithStyles ();
$ columns = $ sheet -> readColumnsWithStyles ();
$ cells = $ sheet -> readCellsWithStyles ();
$ cells = $ sheet -> readCellsWithStyles ();Или вы можете читать только стили (без значений)
$ cells = $ sheet -> readCellStyles ();
/*
array (
'format' =>
array (
'format-num-id' => 0,
'format-pattern' => 'General',
),
'font' =>
array (
'font-size' => '10',
'font-name' => 'Arial',
'font-family' => '2',
'font-charset' => '1',
),
'fill' =>
array (
'fill-pattern' => 'solid',
'fill-color' => '#9FC63C',
),
'border' =>
array (
'border-left-style' => NULL,
'border-right-style' => NULL,
'border-top-style' => NULL,
'border-bottom-style' => NULL,
'border-diagonal-style' => NULL,
),
)
*/
$ cells = $ sheet -> readCellStyles ( true );
/*
array (
'format-num-id' => 0,
'format-pattern' => 'General',
'font-size' => '10',
'font-name' => 'Arial',
'font-family' => '2',
'font-charset' => '1',
'fill-pattern' => 'solid',
'fill-color' => '#9FC63C',
'border-left-style' => NULL,
'border-right-style' => NULL,
'border-top-style' => NULL,
'border-bottom-style' => NULL,
'border-diagonal-style' => NULL,
)
*/Но мы не рекомендуем использовать эти методы с большими файлами.
Каждый лист вашего файла XLSX может содержать набор правил проверки данных. Чтобы получить их, вы можете вызвать getDataValidations на своем листе.
$ excel = Excel:: open ( $ file );
$ sheet = $ excel -> sheet ();
$ validations = $ sheet -> getDataValidations ();
/*
[
[
'type' => 'list',
'sqref' => 'E2:E527',
'formula1' => '"Berlin,Cape Town,Mexico City,Moscow,Sydney,Tokyo"',
'formula2' => null,
], [
'type' => 'decimal',
'sqref' => 'G2:G527',
'formula1' => '0.0',
'formula2' => '999999.0',
],
]
*/ Получите ширину определенного столбца на листе:
$ excel = Excel:: open ( $ file );
$ sheet = $ excel -> selectSheet ( ' SheetName ' );
// Get the width of column 1 (column 'A')
$ columnWidth = $ sheet -> getColumnWidth ( 1 );
echo $ columnWidth ; // Example: 11.85 Получить высоту определенной строки на листе:
$ excel = Excel:: open ( $ file );
$ sheet = $ excel -> selectSheet ( ' SheetName ' );
// Get the height of row 1
$ rowHeight = $ sheet -> getRowHeight ( 1 );
echo $ rowHeight ; // Example: 15 Получите информацию о панели закрепления для листа:
$ excel = Excel:: open ( $ file );
$ sheet = $ excel -> selectSheet ( ' SheetName ' );
// Get the freeze pane configuration
$ freezePaneConfig = $ sheet -> getFreezePaneInfo ();
print_r ( $ freezePaneConfig );
/*
Example Output:
Array
(
[xSplit] => 0
[ySplit] => 1
[topLeftCell] => 'A2'
)
*/ Получите информацию о цвете вкладки для листа:
Copy code
$ excel = Excel:: open ( $ file );
$ sheet = $ excel -> selectSheet ( ' SheetName ' );
// Get the tab color configuration
$ tabColorConfig = $ sheet -> getTabColorInfo ();
print_r ( $ tabColorConfig );
/*
Example Output:
Array
(
[theme] => '2'
[tint] => '-0.499984740745262'
)
*/ Вы можете использовать следующие методы:
Sheet::getMergedCells() -- Возвращает все объединенные диапазоныSheet::isMerged(string $cellAddress) — Проверяет, объединена ли ячейкаSheet::mergedRange(string $cellAddress) — Возвращает диапазон объединения указанной ячейкиНапример
if ( $ sheet -> isMerged ( ' B3 ' )) {
$ range = $ sheet -> mergedRange ( ' B3 ' );
}getSheetNames() — возвращает массив имен всех листов.sheet(?string $name = null) -- Возвращает лист по умолчанию или указанный лист.getSheet(string $name, ?string $areaRange = null, ?bool $firstRowKeys = false) -- Получить лист по имениgetSheetById(int $sheetId, ?string $areaRange = null, ?bool $firstRowKeys = false) -- Получить лист по идентификаторуgetFirstSheet(?string $areaRange = null, ?bool $firstRowKeys = false) -- Получить первый листselectSheet(string $name, ?string $areaRange = null, ?bool $firstRowKeys = false) — выбирает лист по умолчанию по имени и возвращает егоselectSheetById(int $sheetId, ?string $areaRange = null, ?bool $firstRowKeys = false) — выбирает лист по умолчанию по идентификатору и возвращает егоselectFirstSheet(?string $areaRange = null, ?bool $firstRowKeys = false) — выбирает первый лист по умолчанию и возвращает его.getDefinedNames() — возвращает определенные имена книги.name() -- Возвращает имя строкиisActive() — активный рабочий листisHidden() — если рабочий лист скрытisVisible() — если рабочий лист виденstate() — возвращает строковое состояние рабочего листа (используется в isHidden() и isVisible() ).dimension() — возвращает размер рабочей области по умолчанию из свойств листа.countRows() — подсчитывает строки из измеренияcountColumns() — подсчитывает столбцы из измеренияfirstRow() — номер первой строкиfirstCol() — первая буква столбцаreadFirstRow() — возвращает значения ячеек первой строки в виде массива.readFirstRowWithStyles() — возвращает значения и стили ячеек 1-й строки в виде массива.getColumnWidth(int) — возвращает ширину заданного номера столбца.getFreezePaneConfig() — возвращает массив, содержащий конфигурацию области закрепления.getTabColorConfiguration() — возвращает массив, содержащий конфигурацию цвета табуляции. Если вы найдете этот пакет полезным, вы можете дать мне звезду на GitHub.
Или вы можете пожертвовать мне :)
