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
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法
CakePHP3でtitleタグ、h1タグのテキストをデフォルトから変更する方法を解説。テンプレートファイルに「$this->assign()」でテキストを指定して「/Layout/defult.ctp」で受け取る。
-
CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応
CakePHP3のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。
-
CakePHP 2.3でファイルをアップロード・その2 ファイル名を乱数で設定
CakePHPのアップロードするファイル名を乱数で変更しセキュリティを高める方法を解説。
-
CakePHP3で保存前にバリデーション結果を取得する2つの方法
CakePHP3でデータベースに値を保存する前にバリデーションを行い、その結果によって処理を振り分ける方法について解説。「$topic->errors()」と「$topic->hasErrors()」の2つの方法がある。
-
CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法
CakePHP3のツリービヘイビアを使ったツリーカテゴリーの子階層も含めての検索を検索プラグイン「friendsofcake/search」を使って実現する方法を解説しました。
-
CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説
CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。
-
CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力
CakePHPの Modelや Controllerの変数の中身をログとして出力して見る方法を提供します。
-
CakePHP 2.3でOn Duplicate Key構文を実装
CakePHPで On Duplicate Key構文を Queryを利用して実装する方法をサンプルソース付きで解説します。
-
CakePHP3のcontroller内でテンプレート、レイアウトを変更する際の指定方法
CakePHP3でテンプレートファイルやレイアウトファイルをデフォルトのものから別のものに変更したい場合の指定方法を解説。
-
CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法
CakePHP3で検索をするプラグイン「friendsofcake/search」の検索条件のカスタマイズ方法の解説。検索項目を増やしたり、以上、以下での検索や、チェックボックスによる検索の方法などを解説。
Comment
参考になりました。
ありがとうございます。
ちなみにダウンロードの場合の箇所で、$excelだと動かず、$bookだと動きました。
$excel->setActiveSheetIndex(0);
$writer = PHPExcel_IOFactory::createWriter($excel, ‘Excel2007’);
とおりすがりさん、コメントありがとうございます。
お役に立てて何よりですが、ソースコードが間違っておりまして申し訳ありません。
指摘いただきました箇所、修正させていただきました。
ありがとうございました。今後ともよろしくお願いします!