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 5.x

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

Message コメントをキャンセル

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

: CakePHP3、CakePHP4、CakePHP5のバージョンを指定してインストールする詳細な手順を解説

CakePHP3のバージョンを指定してインストールする方法を詳細解説。CakePHP3のインストールはComposerを使うため設定もほぼ自動で完了。データベースの接続情報を記載すればアプリ開発のベースが整う。

: CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ

CakeDC謹製Usersプラグインの紹介。UserHelperを利用し、ログアウトのリンクや権限があるときのみ表示されるリンク、プロフィールページへのリンク、reCAPTCHAの設置方法などを解説。

: CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法

CakePHP3でデフォルトのソート条件を設定しつつ画面上でユーザがソート条件を選択したときもソート処理を実行させる方法を解説。ソート条件はページネーションの処理として実装。

: CakePHPで Auto Incrementを外すと Duplicate entry ‘0’ for keyのエラーが出るかも

CakePHPでAuto Incrementの設定を変更したときに「Duplicate entry ‘0’ for key」のエラーが出た。原因はModel内で IDを編集する処理の追加を忘れていたからだった。

: CakePHP5系で認証機能のAuthenticationプラグインをインストール・エラー発生注意

CakePHPのユーザ認証に使用するオフィシャルなプラグインAuthenticationだが、CakePHP5系では Authentication Ver.3系を使う必要があるが、公式ChiffonBookが間違えている。

: CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定

CakePHP3でOGPを設定する方法を解説。metaタグを編集するHTMLヘルパーを利用してOGPのタグを編集する。また、エレメントとして分割することでメンテナンス性も向上させる。

: CakePHP3のInsert On Duplicate Key Update（upsert）構文を解説・バルク処理も

CakePHP3で Insert … On Duplicate Key Update構文（upsert）を実行する方法を解説。バルク処理の方法も用意されているため大量処理の場合も対応可能。

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

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