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 コメントをキャンセル

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

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

ID以外のカラムでアソシエーション（連携）させるための考え方とサンプルソースを用いての説明を行っています。

: CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by（distinct）の実装方法

CakePHP2の検索プラグイン「CakeDC/Search」で、重複レコードを省くgroup by、distinctを使う方法についての解説。設定する場所はpaginatorの条件とするので、find()関数と同じ。

: CakePHP 2.3 主キー（ID）以外のキーで更新方法 updateAll

主キー（ID）以外のカラムをキーとして更新する方法、updateAllの使い方をサンプルを用いて解説します。

: CakePHP3のメール送信の処理・テンプレート使用・添付ファイル送信も解説

CakePHP3からメールを送信する方法解説。基本的な記述方法を基にして、テンプレートを使う方法、ファイルを添付する方法へと拡張しながら解説。

: CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定

CakePHP3の Authコンポーネントや CakeDC/Usersプラグインなどを利用したユーザ管理・認証システムにおいて、ログインしていなくても見ることができるページの設定方法を解説。

: Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説

CakePHP3で Google Analytics APIからレポートデータを取得する処理の解説。PHPのサンプルソースをCakePHP3で動くように改造。加えて、ディメンションやメトリックスを条件に設定する方法なども。

: CakePHP3の画像、ファイルアップロードプラグインUpload Plugin 3.0の設置解説・その１

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその1で基本的な導入方法の解説で読みながら簡単に導入が可能。