エス技研

WordPress、CakePHP、PHP、baserCMSなどの Web系システムを中心に情報を提供します!


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

      2017/11/03

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

 

PHPExcelをインストール

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

composer require phpoffice/phpexcel

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

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

 
また、「/composer.lock」には、ファイルのパスやバージョン、権限などの設定情報が追加されます。追加される情報はかなり多いので、ここでは割愛します。
 
 
[amazonjs asin=”4798048577″ locale=”JP” title=”PHPフレームワーク CakePHP 3入門”]
 

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

 

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

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

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

 
それぞれコメントを書いているので分かるかと思いますが、最初に、テンプレートとして取得するファイル名などを指定します。
 
テンプレートのファイルは「$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-Type: application/vnd.ms-excel');

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

 

 
 

CakePHP3の関連記事

CakePHPのpostlinkで生成した削除リンクをクリックしても処理が実行されない対処法
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」に関する記事一覧
 
 

 - CakePHP 3.x 4.x 5.x

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

Comment

  1. とおりすがり より:

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

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

    • エス技研 より:

      とおりすがりさん、コメントありがとうございます。
       
      お役に立てて何よりですが、ソースコードが間違っておりまして申し訳ありません。
      指摘いただきました箇所、修正させていただきました。
       
      ありがとうございました。今後ともよろしくお願いします!

Message

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

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

  関連記事

CakePHP4のクリエビルダーを使用してOR条件をAND条件でつなぐSQL文を作る方法
CakePHP4のクリエビルダーを使用してOR条件をAND条件でつなぐSQL文を作る方法

CakePHP4のクリエビルダーを使って複数のOR条件をANDでつなぐSQL文を作成する方法を解説。OR条件を記述したwhere句を2つつなげて記述する。

CakePHP4から外部のデータベースにアクセスする方法解説
CakePHP4から外部のデータベースにアクセスする方法解説

CakePHP4のシステムから他のシステムのデータベースにアクセスをし、SQL文を実行する方法を解説。try-catchでエラーを取得する方法も解説。

CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法
CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法

CakePHP3のツリービヘイビアを使ったツリーカテゴリーの子階層も含めての検索を検索プラグイン「friendsofcake/search」を使って実現する方法を解説しました。

CakePHP 2.3 Search Pluginで検索処理 その1設置方法

CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。

CakePHP 2.3 Search Pluginで検索処理 その5入力項目に複数項目入力した場合の AND検索、OR検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で複数項目を入力した場合の AND検索、OR検索についての解説です。

CakePHP3で他のテーブルのマスタテーブルからセレクトボックス(プルダウンリスト)を作る
CakePHP3で他のテーブルのマスタテーブルからセレクトボックス(プルダウンリスト)を作る

他のテーブルのマスタのレコードからプルダウンリストを作成し、選択できるようにするサンプルプログラムと解説。ORMの設定によりデータベースの値を取得し、配列を作成し optionsに与える。

Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法
Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法

CakePHP4のコマンド(シェル)に対して、環境変数を指定して実行する方法を解説。LinuxとWindows上のXAMPPとでは記述方法が異なるため、Windowsのsetコマンドについても詳細解説。

CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説
CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説

CakePHP4でコマンドプログラムからコンポーネントを呼び出す方法を解説。コントローラーから呼び出すときと大差はないが、use句でコンポーネントを指定する事がポイント。

CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得
CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得

URLやドメイン、フォルダへのパスの取得は、ビューではUrlHelperを使い、コントローラーではRouterクラスを使います。第2引数の指定でURLを取得することも可能。

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

CakePHP3でファイルをアップロードする処理を、php.netにある「エラーを起こさない」と説明がある処理を参考に作成。サンプルソースとその解説付きで、コピペでも動くし、カスタマイズも簡単!