CakePHP 2.3でファイルのアップロード処理を作る

2013/07/01 2017/04/29

CakePHPでファイルアップロードを作る

ファイルアップロードの参考サイト

　
CakePHP 2.3でプログラム開発を行っていますが、ファイルのアップロード処理についてググっていたら、下記のサイトに行き当りました。
ほほー。ファイルアップロードにも Pluginがあるのか、と思ったものの、このページではプラグインに頼らない、と書いてありましたので、私も頼らずに実際に作ってみることにしました。（記事が書かれたのが 2011年2月ですので、その後のバージョンアップなどでどうなったかは分かりませんが。）
http://lambdagroove.blogspot.jp/2011/02/cakephp.html
　
簡単なファイルのアップロードであれば下記のページに従って作っていけば、簡単に出来上がります。
http://www.almondlab.jp/labs/1043
　
上記の方法では、実運用に際してファイルの削除処理などが必要になってくると思います。
　
また、ファイルの管理を煩雑にしないために、画像などのファイル情報を DBに保存したい、という場合もあるかと思います。
その場合は、下記のページが参考になりました。
http://c-brains.jp/blog/wsg/10/06/05-074544.php
　
ですが、このページの通りに作っていくと、「Viewファイルの記述がおかしい」というエラーになってしまいましたので、その前に作った簡易フォームのスクリプトを借りることにしました。
（CakePHP 2.0では echoのエイリアスである e()が使えなくなっていますので、そのほかの不具合もバージョンの違いによるものと思われます。）
　
　

CakePHPでファイルアップロードのサンプルコード

　
また、ファイルが jpeg固定でしたので、それを可変にし、ついでに元ファイルのファイル名、ファイルサイズといった情報も取得するために、テーブルを拡張したり、そのままではうまく画像が呼び出せなかったために、画像の確認するためのファイルなどを作りましたので、あわせてそちらも紹介いたします。
　
————–（テーブル）

CREATE TABLE `images` ( 
  `id`            int(11)     NOT NULL AUTO_INCREMENT, 
  `filename`      varchar(60) NOT NULL, 
  `contents`      mediumblob  NOT NULL, 
  `moto_filename` text        NOT NULL, 
  `filetype`      text        NOT NULL, 
  `filesize`      int(11)     NOT NULL, 
  PRIMARY KEY (`id`) 
);

CREATE TABLE `images` (

`id` int(11) NOT NULL AUTO_INCREMENT,

`filename` varchar(60) NOT NULL,

`contents` mediumblob NOT NULL,

`moto_filename` text NOT NULL,

`filetype` text NOT NULL,

`filesize` int(11) NOT NULL,

PRIMARY KEY (`id`)

);

————–
　
————–（/View/Images/index.ctp）

<div class="images form">
<?php echo $this->Form->create('Image', array('action' => 'add', 'type' => 'file')); ?><fieldset>
<legend><?php echo __('Add Image'); ?></legend>
<?php echo $this->Form->file('image'); ?>
</fieldset>
<?php echo $this->Form->end(__('画像を追加'));?>
</div><!-- form -->

<div class="uploads index">
<h2><?php echo __('Images'); ?></h2>
<table cellpadding="0" cellspacing="0">
<tr>
<th><?php echo __('id'); ?></th>
<th><?php echo __('file_name'); ?></th>
<th><?php echo __('contents'); ?></th>
</tr>

<?php foreach ($images as $image) : ?>
<tr>
<td><?php echo h($image['Image']['id']); ?></td>
<td><?php echo h($image['Image']['filename']); ?></td>
<td><?php echo $this -> Html->link(__("/images/contents/{$image['Image']['filename']}"), array('action' => "/contents/{$image['Image']['filename']}" ), array ( 'target' => '_blank' ) ); ?></td>
</tr>
<?php endforeach; ?>
</table>
</div><!-- index -->

<?php echo $this->Form->create('Image', array('action' => 'add', 'type' => 'file')); ?><fieldset>

<?php echo $this->Form->file('image'); ?>

</fieldset>

<?php echo $this->Form->end(__('画像を追加'));?>

</div>

<tr>

</tr>

<?php foreach ($images as $image) : ?>

<tr>

<td><?php echo $this -> Html->link(__("/images/contents/{$image['Image']['filename']}"), array('action' => "/contents/{$image['Image']['filename']}" ), array ( 'target' => '_blank' ) ); ?></td>

</tr>

<?php endforeach; ?>

</table>

</div>

————–
　
/View/Images/contents.ctp　は、ないとエラーになりますので作成する必要がありますが、中身は空のファイルになります。
————–（/View/Images/contents.ctp）
————–
　
　
/Controller/ImagesController.php　は、以下のようになります。
それぞれの処理の解説は、参考にしたバシャログさんのサイトを見ていただく方が分かりいいかと思います。
　
————–（/Controller/ImagesController.php）

<?php
class ImagesController extends AppController {

  public $helpers    = array ( 'Html', 'Form', 'Session' );
  public $components = array ( 'Session' );

  var $uses = array('Image');
  function index(){
    $images = $this->Image->find('all');
    $this->set(compact('images'));
  }

  /**
   * 画像を登録する
   */
  function add(){
    $limit = 1024 * 1024;
    debug($this->data);

    // 画像の容量チェック
    if ($this->data['Image']['image']['size'] > $limit){
      $this->Session->setFlash('1MB以内の画像が登録可能です。');
      $this->redirect('index');
    }
    // アップロードされた画像か
    if (!is_uploaded_file($this->data['Image']['image']['tmp_name'])){
      $this->Session->setFlash('アップロードされた画像ではありません。');
      $this->redirect('index');
    }
    // 保存
    $image = array(
      'Image' => array(
        'filename' => md5(microtime()) . '.' . $extension = end(explode('.', $this->data['Image']['image']['name'])),
        'contents'      => file_get_contents($this->data['Image']['image']['tmp_name']),
        'moto_filename' => $this->data['Image']['image']['name'],
        'filetype'      => $this->data['Image']['image']['type'],
        'filesize'      => $this->data['Image']['image']['size'],
      )
    );
    $this->Image->save($image);
    $this->Session->setFlash('画像をアップロードしました。');
    $this->redirect('index');
  }

  function contents($filename) {
    $this->layout = false;
    $image = $this->Image->findByFilename($filename);
    if (empty($image)) {
      $this->cakeError('error404');
    }
    header('Content-type: ' . $image['Image']['filetype'] );
    echo $image['Image']['contents'];
  }
}

<?php

class ImagesController extends AppController {

public $helpers = array ( 'Html', 'Form', 'Session' );

public $components = array ( 'Session' );

var $uses = array('Image');

function index(){

$images = $this->Image->find('all');

$this->set(compact('images'));

}

/**

* 画像を登録する

function add(){

$limit = 1024 * 1024;

debug($this->data);

// 画像の容量チェック

if ($this->data['Image']['image']['size'] > $limit){

$this->Session->setFlash('1MB以内の画像が登録可能です。');

$this->redirect('index');

}

// アップロードされた画像か

if (!is_uploaded_file($this->data['Image']['image']['tmp_name'])){

$this->Session->setFlash('アップロードされた画像ではありません。');

$this->redirect('index');

}

// 保存

$image = array(

'Image' => array(

'filename' => md5(microtime()) . '.' . $extension = end(explode('.', $this->data['Image']['image']['name'])),

'contents' => file_get_contents($this->data['Image']['image']['tmp_name']),

'moto_filename' => $this->data['Image']['image']['name'],

'filetype' => $this->data['Image']['image']['type'],

'filesize' => $this->data['Image']['image']['size'],

)

);

$this->Image->save($image);

$this->Session->setFlash('画像をアップロードしました。');

$this->redirect('index');

}

function contents($filename) {

$this->layout = false;

$image = $this->Image->findByFilename($filename);

if (empty($image)) {

$this->cakeError('error404');

}

header('Content-type: ' . $image['Image']['filetype'] );

echo $image['Image']['contents'];

}

————–
　
　

MIMEタイプの追加について

　
また、今回追加した MIMEタイプなどの情報は、下記サイトを参考にして作成しました。
http://vitafacio.sakura.ne.jp/wordpress/?p=35
　
　

CakePHP2 実践入門 (WEB+DB PRESS plus)

ファイルアップロードの表示側の処理

　
また、http://localhost/cake/images/contents/xxxxxxxx.jpg　のような形式では文字化けしたような文字が表示され、なぜかうまく表示されずさんざん悩んだのですが、それを改善させる方法を見つけることはできませんでした。
PDFや、csvファイルは問題なく表示されますが、jpeg、gifなどの画像ファイルが正しく表示されないという不具合でしたので、おそらく「header(‘Content-type:…….」の出力部分がうまく処理されていないのだろうと思うのですが．．．
　
　
ただ、実際の使用方法に近い記述の方法で確認したところ、正しく表示されましたので、それで良しとしたところもあります。
　
————–（/webroot/test.php）

<img src="./images/contents/xxxxxxxx.jpg">

1	<img src="./images/contents/xxxxxxxx.jpg">

————–
　
上記のファイルを作成し、webrootにおいてアクセスすると画像ファイルも無事に表示されましたので、画像も正しくアップロードされていることが確認できました。
　
　

ファイル名を乱数にしてセキュリティを向上させる方法

　
ファイル名を乱数や、指定の値に変更し、セキュリティを向上させる方法も書いていますので、こちらも参考にしてください。
CakePHP 2.3でファイルをアップロード・その2　ファイル名を乱数で設定

- CakePHP 3.x 4.x

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

Message コメントをキャンセル

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

: CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説

CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。

: CakePHP4のCakeDC/Usersのログイン時のリダイレクトとユーザ権限管理の設定解説

CakeDC謹製UsersプラグインのCakePHP4版の紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。

: CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。

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

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

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

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

: VirtualBoxにCakePHP3を設置。必要なCentOS、Apache、PHP、MySQL、Composerをインストールし設定する

VirtualBoxにCentOS、Apache、MySQL、PHPをインストールするところから初めてCakePHP3の開発環境を構築する手順を詳細解説。この記事1つで全ての設定が完了する。

: CakePHP 2.3　デバッグキット（DebugKit）超初心者向けフォロー講座

CakePHP初心者に向けてデバッグキット（DebugKit）のインストール方法、はまりポイントを解説。

: CakePHP 2.3 コマンドラインからPHPのシェル実行の方法解説

CakePHP 2.3でコマンドラインから CakePHPで記述した処理を実行する方法を解説します。

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

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

: CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。CakePHP4で使う場合のUsersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。