CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

2017/01/23 2017/11/03

CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力

PHPExcelをインストール

　
composerコマンドを使って PHPExcelをインストールします。
　

composer require phpoffice/phpexcel

1	composer require phpoffice/phpexcel

　
composerコマンドの使い方については、「CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法」を参照してください。
　
composerコマンドを実行すると、「phpoffice/phpexcel」のパッケージがインストールされるだけではなく、CakePHP3で利用するために必要なファイルの更新も行ってくれます。
　
具体的には、ルートフォルダにある「/composer.json」「/composer.lock」ファイルが更新されます。
　
「/composer.json」には、「require」の値として、インストールしたパッケージの情報が追加されます。

    "require": {
         ：
        "phpoffice/phpexcel": "^1.8"
    },

"require": {

：

"phpoffice/phpexcel": "^1.8"

　
また、「/composer.lock」には、ファイルのパスやバージョン、権限などの設定情報が追加されます。追加される情報はかなり多いので、ここでは割愛します。
　
　

PHPフレームワーク CakePHP 3入門

CakePHP3でPHPExcelでエクセルファイルを読み込み、値を編集し、保存する処理のサンプル

CakePHP3でPHPExcelのプラグインを利用するために use句を記述

　
まず初めに、PHPExcelを利用するコントローラーに下記の「use句」を追記します。

use PHPExcel_IOFactory;

1	use PHPExcel_IOFactory;

　
設定にもよりますが、「/vendor/cakephp-plugins.php」や「/config/bootstrap.php」にプラグインをロードする処理を記述する必要はありません。
　
　

CakePHP3でPHPExcelを利用しエクセルファイルを出力する処理サンプル

　
ゼロからエクセルファイルを生成し、罫線を引いたり、セルの色を変更したり、という方法もありますが、より簡単な方法として、ここではあらかじめ作成したテンプレートファイルに、値を編集していく、という方法を解説します。
　
そのサンプルプログラムが以下になります。
　

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']);
}

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）
　

    // ダウンロード
    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;

// ダウンロード

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;

　
上記の処理の

    header('Content-Type: application/octet-stream');

1	header('Content-Type: application/octet-stream');

は

    header('Content-Type: application/vnd.ms-excel');

1	header('Content-Type: application/vnd.ms-excel');

でも動作します。
ただ、ブラウザによっては、自動的にブラウザで開こうとしてしまうことがありますので、「application/octet-stream」の方がお勧めです。
　
また、ダウンロード処理の場合は、最後の行の「exit();」が必要です。
この「exit();」がないと「読み取れなかった内容を修復または削除することにより、ファイルを開くことができました。」「ファイルレベルの検証と修復が完了しました。このブックの一部が修復されたか、破棄された可能性があります。」と表示されてしまいますので、忘れないようにしましょう。
　

　

　
　

- CakePHP 2.x　3.x CakePHP3

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Comment

とおりすがりより:

2017年11月2日 11:36 AM

参考になりました。
ありがとうございます。

ちなみにダウンロードの場合の箇所で、$excelだと動かず、$bookだと動きました。
$excel->setActiveSheetIndex(0);
$writer = PHPExcel_IOFactory::createWriter($excel, ‘Excel2007’);

返信
- エス技研より:
  
  2017年11月3日 8:16 PM
  
  とおりすがりさん、コメントありがとうございます。
  　
  お役に立てて何よりですが、ソースコードが間違っておりまして申し訳ありません。
  指摘いただきました箇所、修正させていただきました。
  　
  ありがとうございました。今後ともよろしくお願いします！
  
  返信

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3で画像・ファイルのアップロード処理を自作・解説付き・その２

ファイルのアップロード機能の自作サンプルコードとその解説のその２。アップロード機能に関連するファイルの更新や削除の処理や画像、フォルダのパスの指定方法などを含めて解説。

: CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合の詳細ページの注意点

ID以外のカラムでアソシエーション（連携）させて詳細ページを表示させる際の考え方と注意点をサンプルソースを用いて解説しています。

: CakePHP3でレコードを保存（追加、更新、Insert、Update）する複数の方法を紹介

CakePHP3でレコードを追加、更新（Insert、Update）する記述方法を解説。1件ずつ処理、全件をまとめて処理、条件に該当する複数件のレコードを処理方法をサンプルコードを用いて解説。

: CakePHP3のForm Helperの使い方のまとめ

CakePHP3になりフォームヘルパーの使い方も大きく変わりましたので、使い方をまとめました。基本的な使い方からプラスアルファの便利な使い方まで紹介。

: CakePHP3のインストールでURL rewriting……のエラーが！その解決方法解説

CakePHP3をインストールしたら URL rewriting is not properly configured.のエラーが。原因は.htaccessが有効になっていないこと。httpd.confに設定を追加すればOK。

: CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

CakePHP3にComposerからインストールできないプラグインやライブラリなどを利用する方法、vendorにファイルを設置し、composer.jsonを更新し、それを呼び出す方法を詳細に解説。

: CakePHP 2.3で確認画面付きのお問い合わせフォームの作り方

CakePHPで確認画面付きのお問い合わせフォーム、メールフォームの作り方をサンプルを提示しながら解説。

: CakePHP 2.3　Search Pluginで検索処理　その４前方一致検索、後方一致検索、不等号による検索、between句による範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で前方一致検索、後方一致検索、不等号による検索、between句による範囲検索の解説です。

: URL短縮サービス「TTTオンライン（https://ttt.onl）」公開

URL短縮サービス「TTTオンライン（https://ttt.onl）」を公開。メールやSNSでは使いにくい長いURLを短いURLに変換するサービス。QRコードも。Google URL Shortenerが2019年3月にサービス終了。

: CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応

CakePHP3のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。