CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法
2017/11/03
CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力
PHPExcelをインストール
composerコマンドを使って PHPExcelをインストールします。
1 |
composer require phpoffice/phpexcel |
composerコマンドの使い方については、「CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法」を参照してください。
composerコマンドを実行すると、「phpoffice/phpexcel」のパッケージがインストールされるだけではなく、CakePHP3で利用するために必要なファイルの更新も行ってくれます。
具体的には、ルートフォルダにある「/composer.json」「/composer.lock」ファイルが更新されます。
「/composer.json」には、「require」の値として、インストールしたパッケージの情報が追加されます。
1 2 3 4 |
"require": { : "phpoffice/phpexcel": "^1.8" }, |
また、「/composer.lock」には、ファイルのパスやバージョン、権限などの設定情報が追加されます。追加される情報はかなり多いので、ここでは割愛します。
CakePHP3でPHPExcelでエクセルファイルを読み込み、値を編集し、保存する処理のサンプル
CakePHP3でPHPExcelのプラグインを利用するために use句を記述
まず初めに、PHPExcelを利用するコントローラーに下記の「use句」を追記します。
1 |
use PHPExcel_IOFactory; |
設定にもよりますが、「/vendor/cakephp-plugins.php」や「/config/bootstrap.php」にプラグインをロードする処理を記述する必要はありません。
CakePHP3でPHPExcelを利用しエクセルファイルを出力する処理サンプル
ゼロからエクセルファイルを生成し、罫線を引いたり、セルの色を変更したり、という方法もありますが、より簡単な方法として、ここではあらかじめ作成したテンプレートファイルに、値を編集していく、という方法を解説します。
そのサンプルプログラムが以下になります。
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 |
public function download ( $id = null ){ $HogeHoge = $this->HogeHoges->get($id, [ 'contain' => [] ]); // 入出力の情報設定 $driPath = realpath(TMP) . "/excel/"; $inputPath = $driPath . "templete.xlsx"; $sheetName = "data_sheet"; $outputFile = "output_" . $id . ".xlsx"; $outputPath = $driPath . $outputFile; // Excalファイル作成 $reader = PHPExcel_IOFactory::createReader('Excel2007'); $book = $reader->load($inputPath); $sheet = $book->getSheetByName($sheetName); // データを配置 $sheet->setCellValue("B3","B3の位置"); $sheet->setCellValue("B4","B4の位置"); // 保存 $book->setActiveSheetIndex(0); $writer = PHPExcel_IOFactory::createWriter($book, 'Excel2007'); $writer->save($outputPath); return $this->redirect(['action' => 'index']); } |
それぞれコメントを書いているので分かるかと思いますが、最初に、テンプレートとして取得するファイル名などを指定します。
テンプレートのファイルは「$driPath」に編集していますが、「realpath(TMP) . "/excel/";
」としています。
「realpath(TMP)
」は、「/tmp」に当たります。
「/tmp」の中に「excel」というフォルダを作って、その中にテンプレートとなるエクセルファイルを設置します。
ファイルの保存先のフォルダのパスについては、下記の記事を参考にしてください。
CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数
CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得
2007形式(.xlsx形式)と 2003以前の形式(.xls形式)の切り替え
「$reader = PHPExcel_IOFactory::createReader('Excel2007');
」の「Excel2007」は、エクセルの 2007形式(.xlsx形式)で保存する指定です。
エクセルの 2003以前の形式(.xls形式)で保存する場合は、「Excel2007」の部分を「Excel5」に置き換えます。
ファイルを保存せずにダウンロードさせる方法
上記のサンプルは、所定のフォルダにエクセルファイルを保存する処理になっています。
ファイルを保存せずに、ダウンロードする場合は、「保存」の処理 3行を下記のものに差し替えます。(ソースコードに間違いがありましたので修正しました。2017.11.03)
1 2 3 4 5 6 7 8 9 |
// ダウンロード header('Content-Type: application/octet-stream'); header('Content-Disposition: attachment;filename="' . $outputFile . '"'); header('Cache-Control: max-age=0'); $book->setActiveSheetIndex(0); $writer = PHPExcel_IOFactory::createWriter($book, 'Excel2007'); $writer->save('php://output'); exit; |
上記の処理の
1 |
header('Content-Type: application/octet-stream'); |
は
1 |
header('Content-Type: application/vnd.ms-excel'); |
でも動作します。
ただ、ブラウザによっては、自動的にブラウザで開こうとしてしまうことがありますので、「application/octet-stream」の方がお勧めです。
また、ダウンロード処理の場合は、最後の行の「exit();」が必要です。
この「exit();」がないと「読み取れなかった内容を修復または削除することにより、ファイルを開くことができました。」「ファイルレベルの検証と修復が完了しました。このブックの一部が修復されたか、破棄された可能性があります。」と表示されてしまいますので、忘れないようにしましょう。
CakePHP3の関連記事
CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールするCakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介
CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
その他の「CakePHP3」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
CakePHP4、CakePHP5のメッセージ日本語化の設定(国際化と地域化の機能の使い方の解説)
CakePHP4の英語のメッセージを日本語化(多言語化)する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。
-
-
CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法
CakePHP4でテンプレートやレイアウトファイルをデフォルトから変更する場合は「render()」を使用するが、記述場所はできるだけコントローラー内の最後の方に書く方がいい。
-
-
CakePHP3で「SQLSTATE[23000]: Integrity constraint violation」「SQLSTATE[42S22]: Column not found」などのエラーが出たときの確認するポイント
CakePHP3の開発で発生する「SQLSTATE[23000]: Integrity constraint violation」「SQLSTATE[42S22]: Column not found」のエラーには特有の原因もあるため、その説明と対処方法の解説。
-
-
CakePHP 2.3でファイルをアップロード・その2 ファイル名を乱数で設定
CakePHPのアップロードするファイル名を乱数で変更しセキュリティを高める方法を解説。
-
-
CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定
CakePHP3でOGPを設定する方法を解説。metaタグを編集するHTMLヘルパーを利用してOGPのタグを編集する。また、エレメントとして分割することでメンテナンス性も向上させる。
-
-
CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説
CakePHP3で静的なページを設置する場合の方法(webrootとpagesとを活用する方法)を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。
-
-
CakePHP4のFrozenDateで1ヵ月前、先月、今月1日、来月末の日付などを算出する方法
CakePHPには「FrozenDate」の日付を扱う関数が用意されている。これを利用して、1ヶ月後、月末日、月初日、5日後などを指定して日付を取得できる。それを解説。
-
-
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3でデフォルトのソート条件を設定しつつ画面上でユーザがソート条件を選択したときもソート処理を実行させる方法を解説。ソート条件はページネーションの処理として実装。
-
-
CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応
CakePHP3.7でCookieを保存、取り出し、削除する方法を解説。CakePHP3でのCookieの取り扱いはバージョンごとに変更されるため、環境に合わせた方法を探す必要がある。
-
-
CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除
CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。
Comment
参考になりました。
ありがとうございます。
ちなみにダウンロードの場合の箇所で、$excelだと動かず、$bookだと動きました。
$excel->setActiveSheetIndex(0);
$writer = PHPExcel_IOFactory::createWriter($excel, ‘Excel2007’);
とおりすがりさん、コメントありがとうございます。
お役に立てて何よりですが、ソースコードが間違っておりまして申し訳ありません。
指摘いただきました箇所、修正させていただきました。
ありがとうございました。今後ともよろしくお願いします!