webアプリケーションで、検索結果や売上データなどを、
エクセルファイル（xlsx）に出力する場合があるかと思います。
cakephpにも、エクセルファイルを扱うプラグインがいくつかあります。
その中でも、特に有名なものは、
・phpexcel
・phpspreadsheet
ではないでしょうか？
本記事では、phpspreadsheetのプラグインを利用したエクセルファイルの入出力方法について、
導入からサンプルプログラムを解説しています。
phpspreadsheetのインストール
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
[hoge/ex]$ composer require phpoffice/phpspreadsheet Using version ^1.12 for phpoffice/phpspreadsheet ./composer.json has been updated Loading composer repositories with package information Updating dependencies (including require-dev) Package operations: 3 installs, 0 updates, 0 removals - Installing markbaker/matrix (1.2.1): Downloading (100%) - Installing markbaker/complex (1.5.0): Downloading (100%) - Installing phpoffice/phpspreadsheet (1.12.0): Loading from cache phpoffice/phpspreadsheet suggests installing mpdf/mpdf (Option for rendering PDF with PDF Writer) phpoffice/phpspreadsheet suggests installing dompdf/dompdf (Option for rendering PDF with PDF Writer) phpoffice/phpspreadsheet suggests installing tecnickcom/tcpdf (Option for rendering PDF with PDF Writer) phpoffice/phpspreadsheet suggests installing jpgraph/jpgraph (Option for rendering charts, or including charts with PDF or HTML Writers) Package phpunit/php-token-stream is abandoned, you should avoid using it. No replacement was suggested. Package phpunit/phpunit-mock-objects is abandoned, you should avoid using it. No replacement was suggested. Package zendframework/zend-diactoros is abandoned, you should avoid using it. Use laminas/laminas-diactoros instead. Writing lock file Generating autoload files > Cake\Composer\Installer\PluginInstaller::postAutoloadDump [hoge/ex]$ |
エクセルファイル出力
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
<?php namespace App\Controller; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Reader\Xls as XlsReader; use PhpOffice\PhpSpreadsheet\Reader\Xlsx as Reader; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; use PhpOffice\PhpSpreadsheet\Style\NumberFormat; use PhpOffice\PhpSpreadsheet\Style\Border; use PhpOffice\PhpSpreadsheet\Style\Alignment; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use Cake\Http\CallbackStream; use PhpOffice\PhpSpreadsheet\Writer\Pdf; use App\Controller\AppController; /** * Samples Controller */ class SamplesController extends AppController { /** * Index method * * @return \Cake\Http\Response|null */ public function index() { // スプレッドシートを作成 $spreadsheet = new Spreadsheet(); // ファイルのプロパティを設定 $spreadsheet->getProperties() ->setTitle('タイトル') ->setSubject('サブタイトル') ->setCreator('作成者') ->setCompany('会社名') ->setManager('管理者') ->setCategory('分類') ->setDescription('コメント') ->setKeywords('キーワード'); $spreadsheet->setActiveSheetIndex(0) ->setCellValue('B1', 'Hello') ->setCellValue('C1', 'world!') ->setCellValue('D1', 'hogehoge') ->setCellValue('F1', 'fugafuga'); $sheet = $spreadsheet->getActiveSheet(); $sheet ->setCellValue('B3', 100) ->setCellValue('C3', 50) ->setCellValue('D3', '=B3 + C3'); // テキストの中央寄せ $sheet->getStyle('B1:C1')->applyFromArray(['alignment'=>['horizontal'=>Alignment::HORIZONTAL_CENTER]]); // 列の横幅を設定 $sheet->getColumnDimension('C')->setWidth(8); // セルを連結 $sheet->mergeCells('D1:E1'); // テキストの縦寄せ $sheet->getStyle('D1:E1')->getAlignment()->setVertical(Alignment::VERTICAL_TOP); // テキストの折り返しを設定 $sheet->getStyle('D1')->getAlignment()->setWrapText(true); // 配列の形で値を設定 $dataList = [ [NULL, 2018, 2019, 2020], ['Q1', 10, 20, 30], ['Q2', 40, 50, 50], ['Q3', 60, 70, 80], ['Q4', 90, 100, 110], ]; $sheet->fromArray($dataList, NULL, 'B6', true); // 枠線を設定 $sheet->getStyle('B6:E10')->getBorders()->getOutline()->setBorderStyle(Border::BORDER_THIN); // バッファをクリア ob_end_clean(); $fileName = "sample.xlsx"; // ダウンロード header('Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'); header('Content-Disposition: attachment;filename="'.$fileName.'"'); header('Cache-Control: cache, must-revalidate'); $writer = new Xlsx($spreadsheet); $writer->save('php://output'); exit(); } } |
実行結果
エクセルファイルの読込
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
<?php namespace App\Controller; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Reader\Xls as XlsReader; use PhpOffice\PhpSpreadsheet\Reader\Xlsx as Reader; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; use PhpOffice\PhpSpreadsheet\Style\NumberFormat; use PhpOffice\PhpSpreadsheet\Style\Border; use PhpOffice\PhpSpreadsheet\Style\Alignment; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use Cake\Http\CallbackStream; use PhpOffice\PhpSpreadsheet\Writer\Pdf; use App\Controller\AppController; /** * Samples Controller */ class SamplesController extends AppController { /** * Index method * * @return \Cake\Http\Response|null */ public function index() { // スプレッドシートを作成 $spreadsheet = new Spreadsheet(); $driPath = WWW_ROOT . 'excel' . DS; $inputPath = $driPath . "template.xlsx"; $excel = \PhpOffice\PhpSpreadsheet\IOFactory::load($inputPath); $spreadsheet= $excel->getActiveSheet(0); $spreadsheet->setActiveSheetIndex(0) ->setCellValue('B1', 'Hello') ->setCellValue('C1', 'world!') ->setCellValue('D1', 'hogehoge') ->setCellValue('F1', 'fugafuga'); $fileName = "sample.xlsx"; // ダウンロード header('Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'); header('Content-Disposition: attachment;filename="'.$fileName.'"'); header('Cache-Control: cache, must-revalidate'); $writer = new Xlsx($spreadsheet); $writer->save('php://output'); exit(); } } |
まとめ
CakePHPでのエクセルファイルの入出力は、プラグインを利用することで、非常に簡単に実装することが可能です。
業務で本格的に利用する場合には、エクセルのテンプレートを読み込んで、値を埋め込むという利用方法が良いと思います。
詳しい利用方法は、公式のgithubを参考にすると良いでしょう。
公式
GitHub - PHPOffice/PhpSpreadsheet: A pure PHP library for reading and writing spreadsheet files
A pure PHP library for reading and writing spreadsheet files - PHPOffice/PhpSpreadsheet
github.com
