eyecatch_cakephp_20160912_cmp

CakePHP

CakePHP 1.3.x、で CSVファイルのエクスポート機能を作ってみた。

2015/01/11

過去に CakePHP1.3 で作成したシステムにCSVファイルのエクスポート機能を追加してほしいときたので、機能追加してみました。
忘備録も兼ねたポストで次回に備えたいと思います。

『CSV Helper』でCSVを作成する

今回は CakePHPのバージョンが 1.3.22だったので、ヘルパーである『CSV Helper』を使ってみたいと思います。

ダウンロードというか、公開されているページはこちら。
CSV Helper (PHP 5) :: The Bakery: Everything CakePHP

CsvHelper

公開されているものを転載します。
最後の「?>」は要らないので、書きません。

アクションを作成

ダウンロード機能を実装するコントローラーに、ダウンロード用アクションを作成します。
そのまんま、download としてみました。

ヘルパー設定に「Csv」を記述するのを忘れずに。

サンプルのアクションは、都道府県と、欲しいデータ(ユーザ)の一覧を取得しています。
抽出したデータと、表の一行目の配列をセットしてビューに渡します。

app/controllers/users_controller.php

ビューファイル

最後にビューファイルの作成です。

app/views/download.ctp

コントローラーから渡されたデータを foreach() でグリグリと回しているだけです。

基本的に、CakePHPで作成したアプリケーションの文字コードはUTF-8だと思いますので、csvにする時に、sjisに変換しています。
機種依存文字などが含まれる場合は、sjis-win あたりがの方が良いかと思います。

これで、http://your-domain.com/users/download にアクセスすれば、設定したファイル名のCSVファイルをダウンロードします。

余談

本当は、この機能を管理画面(/admin/users/download)で使いたかったのですが、プレフィックスルーティンで管理画面を制御していたために、コントローラー側でレイアウトを無効としても、無効にならず、管理画面用のレイアウトファイルをcsvファイルとして出力するという事態に陥ってしまい、1時間ほどあーでもないこーでもないとやってました。

完全に社内、しかもローカルのサーバでしか運用しないので、フロント側のURLとしても問題なかったのですが、
プレフィックスルーティンを使っている場合は、このURLの場合はプレフィックスルーティンを無効にする、といった手段を講じる必要がありそうです。

とりあえずこれは未来のtoogieへのメッセージ。
絶対に同じことで悩んでそうなので(苦笑)

CakePHP2.x系統での場合もまた記事にしたいと思います。

-CakePHP
-, , , ,