fast excel reader
v2.22.1
FastExcelReader は、以下で構成される FastExcelPhp プロジェクトの一部です。
このライブラリは軽量かつ超高速になるように設計されており、必要なメモリ使用量は最小限に抑えられます。
FastExcelReader は、 XLSX 形式 (Office 2007 以降) の Excel 互換スプレッドシートを読み取ることができます。データを読み取るだけですが、メモリ使用量を最小限に抑えながら非常に高速に読み取ります。
特徴
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'
)
)
オプションの 2 番目の引数は、結果の配列キーを指定します。
// 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'
)
)
結果モードの許容値
| モードオプション | 説明 |
|---|---|
| KEYS_ORIGINAL | 行は「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 | 最初の引数のtrueと同じ |
| 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 の名前Headersが定義されている場合、この名前でセルを読み取ることができます。
$ 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()とコールバック関数を使用して読み取りプロセスを完全に制御できます。
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 には日付 2024-02-03 が含まれていますが、両方のセルが日付形式に設定されています。
$ 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 );ライブラリはセル値の型を判断しようとし、ほとんどの場合、正しく判断します。したがって、数値または文字列値を取得します。デフォルトでは、日付値はタイムスタンプとして返されます。ただし、日付形式を設定することでこの動作を変更できます (date() php 関数の形式オプションを参照)。
$ 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' => scalar_value 、 's' => style_array 、 'f' => Formula ] のような配列が返されます。
$ 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) -- ID でシートを取得します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) -- ID でデフォルトのシートを選択し、それを返しますselectFirstSheet(?string $areaRange = null, ?bool $firstRowKeys = false) -- 最初のシートをデフォルトとして選択し、それを返しますgetDefinedNames() -- ワークブックの定義された名前を返します。name() -- 文字列の名前を返します。isActive() -- アクティブなワークシートisHidden() -- ワークシートが非表示の場合isVisible() -- ワークシートが表示されている場合state() -- ワークシートの文字列状態を返します ( isHidden()およびisVisible()で使用されます)dimension() -- シートのプロパティからデフォルトの作業領域の寸法を返します。countRows() -- ディメンションから行をカウントします。countColumns() -- ディメンションから列をカウントします。firstRow() -- 最初の行番号firstCol() -- 最初の列の文字readFirstRow() -- 1行目のセルの値を配列として返すreadFirstRowWithStyles() -- 1 行目のセルの値とスタイルを配列として返します。getColumnWidth(int) -- 指定された列番号の幅を返します。getFreezePaneConfig() -- フリーズ ペイン構成を含む配列を返します。getTabColorConfiguration() -- タブのカラー設定を含む配列を返します。 このパッケージが役立つと思われた場合は、GitHub でスターを付けていただけます。
または、私に寄付してください:)
