README

一个用于读取Excel/CSV表的干净且美观的API。这是一个围绕box/spout包的包装器。

安装

composer require mahmud/sheet

要求

• php: ^7.1.3
• box/spout: ^3.0

用法

简单示例

假设我们有一个如下所示的csv文件。

use Mahmud\Sheet\SheetReader;

SheetReader::makeFromCsv('/path-to-csv-file/example-file.csv')
            ->delimiter(",")                        // Optional: You can set delimiter for CSV file
            ->ignoreRow(0)                          // Optional: Skip the header row
            ->columns(['id', 'name', 'age'])        // Arbitary column name that will be mapped sequentially for each row
            ->onEachRow(function($row, $index){
                // This callback will be executed for each row
                var_dump($row);     // Current row in associative array
                var_dump($index);   // Current index of the row
            })->read();

中间件

您可以使用中间件修改每行的数据。请看以下示例

use Mahmud\Sheet\SheetReader;

SheetReader::makeFromCsv('/path-to-csv-file/example-file.csv')
            ->delimiter(",")
            ->ignoreRow(0)
            ->columns(['id', 'name', 'age'])
            ->applyMiddleware(function($row, $index){
                $row['age'] = $row['age'] . " Years";
                
                return $row;
            })
            ->onEachRow(function($row, $index){
                var_dump($row);
            })->read();

使用类作为中间件的另一个示例

class AgeMiddleware{
    public function handle($row, $index) {
        $row['age'] = $row['age'] . " Years";
    
        return $row;
    }
}

SheetReader::makeFromCsv('/path-to-csv-file/example-file.csv')
            ->delimiter(",")
            ->ignoreRow(0)
            ->columns(['id', 'name', 'age'])
            ->applyMiddleware(new AgeMiddleware)
            ->onEachRow(function($row, $index){
                var_dump($row);
            })->read();

您也可以传递中间件的数组

SheetReader::makeFromCsv('/path-to-csv-file/example-file.csv')
            ->delimiter(",")
            ->ignoreRow(0)
            ->columns(['id', 'name', 'age'])
            ->applyMiddleware([
                new AgeMiddleware,
                new AnotherMiddleware,
            ])
            ->onEachRow(function($row, $index){
                var_dump($row);
            })->read();

如果从中间件返回null，则该行将被跳过，不会传递到onEachRow处理程序。

SheetReader::makeFromCsv('/path-to-csv-file/example-file.csv')
            ->delimiter(",")
            ->ignoreRow(0)
            ->columns(['id', 'name', 'age'])
            ->applyMiddleware(function($row){
                if($row['id'] == 1){
                    return null;
                }
                
                return $row;
            })
            ->onEachRow(function($row, $index){
                var_dump($row);
            })->read();

统计总行数

$total = SheetReader::makeFromCsv('/path-to-csv-file/example-file.csv')
                        ->totalRows();
                        
var_dump($total);       // 4