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

2017/03/19 2017/10/28

CakePHP3で画像・ファイルのアップロード処理を作る

　
「CakePHP3でファイルのアップロード処理を自作・解説付き・その１」で CakePHP3でファイルをアップロードする処理を作成しました。
　
ただ、「CakePHP3でファイルのアップロード処理を自作・解説付き・その１」で解説した処理では、アップロードはできても、レコードやファイルを更新する処理や、削除をする処理に対応していませんでしたので、実用に耐えうるようにするために、追加で必要な処理を作成しました。
　
今回は、その追加の処理の解説です。
　
　

CakePHP3で画像・ファイルのアップロードするサンプルソースコード

edit.ctpの更新

　
入力された情報を更新する入力画面「edit.ctp」を更新します。
　
更新する対象のファイルは、以下になります。
/src/Template/News/edit.ctp
　
追加するソースコードは下記になります。
　

if ($news->file){
    echo '<img src="' . UPLOAD_IMG_NEWS . $news->file . '">';
    echo $this->Form->input("file_before",["type"=>"hidden",
                                            "value"=>$news->file]);
    echo $this->Form->input("delete",["type"=>"submit",
                                      "name"=>"file_delete",
                                      "value"=>"delete"]);
}
//  ↓このファイル登録の前に↑これを追加
echo $this->Form->input('file',["type"=>"file"]);

if ($news->file){

echo '<img src="' . UPLOAD_IMG_NEWS . $news->file . '">';

echo $this->Form->input("file_before",["type"=>"hidden",

"value"=>$news->file]);

echo $this->Form->input("delete",["type"=>"submit",

"name"=>"file_delete",

"value"=>"delete"]);

}

// ↓このファイル登録の前に↑これを追加

echo $this->Form->input('file',["type"=>"file"]);

　
追加すると下記ようなイメージになります。
きれいに並べるためには CSSなどの調整をしてください。

　
　
画像を登録した Newsの記事を更新しようとすると、すでに登録されている画像が表示されます。（登録した画像がない場合は表示されません。）
　
そして、画像を更新したい場合は、そのまま新たな画像ファイルを指定して、「submit」を実行します。
画像を削除するだけの場合は「Delete」ボタンをクリックすることで画像の削除だけが行われる、という処理を想定しています。
　
また、実際の更新処理も実行しますので、そのほかの項目を更新している場合は、更新があった項目の更新も実行します。
　
既存登録の画像については「file_before」という名称の hiddenの値として保持して処理を続けています。
　
既存登録画像を表示する際の画像のパスの指定の方法は、「CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得」に記事を書いていまして、Formヘルパーについては「CakePHP3のForm Helperの使い方のまとめ」に記事を書いていますので、そちらも参考にしてください。
　
　

PHPフレームワーク CakePHP 3入門

NewsController.phpの editアクションの更新

NewsController.phpのサンプルソースコード

　
今回の機能拡張のメインの個所になる「NewsController.php」の editアクションの変更部分です。
　
更新する対象のファイルは、以下になります。
/src/Controller/NewsController.php
　
更新するソースコードは下記になります。
　

    public function edit($id = null)
    {
        $news = $this->News->get($id, [
            'contain' => []
        ]);
        if ($this->request->is(['patch', 'post', 'put'])) {
            $news = $this->News->patchEntity($news, $this->request->data);

            $dir = realpath(WWW_ROOT . "/upload_img");
            // deleteボタンがクリックされたとき
            if(isset($this->request->data["file_delete"])){
                try {
                    $del_file = new File($dir . "/". $this->request->data["file_before"]);
                    // ファイル削除処理実行
                    if($del_file->delete()) {
                        $news['file'] = "";
                    } else {
                        $news['file'] = $this->request->data["file_before"];
                        throw new RuntimeException('ファイルの削除ができませんでした.');
                    }
                } catch (RuntimeException $e){
                    $this->Flash->error(__($e->getMessage()));
                }
            } else {
                // ファイルが入力されたとき
                if($this->request->data["file"]["name"]){
                    $limitFileSize = 1024 * 1024;
                    try {
                        $news['file'] = $this->file_upload($this->request->data['file'], $dir, $limitFileSize);
                        // ファイル更新の場合は古いファイルは削除
                        if (isset($this->request->data["file_before"])){
                            // ファイル名が同じ場合は削除を実行しない
                            if ($this->request->data["file_before"] != $news['file']){
                                $del_file = new File($dir . "/". $this->request->data["file_before"]);
                                if(!$del_file->delete()) {
                                    $this->log("ファイル更新時に下記ファイルが削除できませんでした。",LOG_DEBUG);
                                    $this->log($this->request->data["file_before"],LOG_DEBUG);
                                }
                            }
                        }
                           
                    } catch (RuntimeException $e){
                        // アップロード失敗の時、既登録ファイルがある場合はそれを保持
                        if (isset($this->request->data["file_before"])){
                            $news['file'] = $this->request->data["file_before"];
                        }
                        $this->Flash->error(__('ファイルのアップロードができませんでした.'));
                        $this->Flash->error(__($e->getMessage()));
                    }
                } else {
                    // ファイルは入力されていないけど登録されているファイルがあるとき
                    if (isset($this->request->data["file_before"])){
                        $news['file'] = $this->request->data["file_before"];
                    }
                }
            }

            if ($this->News->save($news)) {
                $this->Flash->success(__('The news has been saved.'));

                if(isset($this->request->data["file_delete"])){
                    $this->set(compact('news'));
                    return $this->redirect(['action' => 'edit', $id]);
                } else {
                    return $this->redirect(['action' => 'index']);
                }
            }
            $this->Flash->error(__('The news could not be saved. Please, try again.'));
        }
        $this->set(compact('news'));
        $this->set('_serialize', ['news']);
    }

public function edit($id = null)

{

$news = $this->News->get($id, [

'contain' => []

]);

if ($this->request->is(['patch', 'post', 'put'])) {

$news = $this->News->patchEntity($news, $this->request->data);

$dir = realpath(WWW_ROOT . "/upload_img");

// deleteボタンがクリックされたとき

if(isset($this->request->data["file_delete"])){

try {

$del_file = new File($dir . "/". $this->request->data["file_before"]);

// ファイル削除処理実行

if($del_file->delete()) {

$news['file'] = "";

} else {

$news['file'] = $this->request->data["file_before"];

throw new RuntimeException('ファイルの削除ができませんでした.');

}

} catch (RuntimeException $e){

$this->Flash->error(__($e->getMessage()));

}

} else {

// ファイルが入力されたとき

if($this->request->data["file"]["name"]){

$limitFileSize = 1024 * 1024;

try {

$news['file'] = $this->file_upload($this->request->data['file'], $dir, $limitFileSize);

// ファイル更新の場合は古いファイルは削除

if (isset($this->request->data["file_before"])){

// ファイル名が同じ場合は削除を実行しない

if ($this->request->data["file_before"] != $news['file']){

$del_file = new File($dir . "/". $this->request->data["file_before"]);

if(!$del_file->delete()) {

$this->log("ファイル更新時に下記ファイルが削除できませんでした。",LOG_DEBUG);

$this->log($this->request->data["file_before"],LOG_DEBUG);

}

} catch (RuntimeException $e){

// アップロード失敗の時、既登録ファイルがある場合はそれを保持

if (isset($this->request->data["file_before"])){

$news['file'] = $this->request->data["file_before"];

}

$this->Flash->error(__('ファイルのアップロードができませんでした.'));

$this->Flash->error(__($e->getMessage()));

}

} else {

// ファイルは入力されていないけど登録されているファイルがあるとき

if (isset($this->request->data["file_before"])){

$news['file'] = $this->request->data["file_before"];

}

if ($this->News->save($news)) {

$this->Flash->success(__('The news has been saved.'));

if(isset($this->request->data["file_delete"])){

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

return $this->redirect(['action' => 'edit', $id]);

} else {

return $this->redirect(['action' => 'index']);

}

$this->Flash->error(__('The news could not be saved. Please, try again.'));

}

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

$this->set('_serialize', ['news']);

}

NewsController.phpの変更点の解説

　
変更点にはそれぞれコメントを入れていますので、個別に確認していただければわかりかとは思いますが、解説をしていきます。
　
9行目は、アップロードするファイルを保存するフォルダを指定します。
各フォルダのパスの指定の仕方は、「CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数」に記事を書いていますので、そちらを参考にしてください。
　
11行目は、「delete」ボタンがクリックされたか、否かの判定です。
あんまり見かけない処理のような気もしますが、submitボタンにも name、valueを指定することができ、クリックされたボタンがどのボタンなのかを判定することができます。
その処理を利用して、「delete」ボタンがクリックされた場合と、通常の「submit」ボタンがクリックされた場合とで処理を分けています。
　
13行目で、Fileクラスで削除処理対象のファイルを指定して、15行目で削除の実行を行います。
そして、削除実行が正常に処理できたか、否かによって振り分け処理を行っています。
　
Fileクラス、Folderクラスに関しては、下記のページを参考にしてください。
https://book.cakephp.org/3.0/ja/core-libraries/file-folder.html
　
26行目からの処理は、ファイルをアップロードする処理です。
29行目の「file_upload()」関数は、「CakePHP3でファイルのアップロード処理を自作・解説付き・その１」で解説した、自作のファイルアップロード処理ですのでそちらの解説を参照してください。
「file_upload()」関数の中身は特に変わりません。
　
31行目は、新しいファイルが送信されてきた場合、既存登録のファイルがあった場合は、それを削除する必要がありますので、その削除処理を実行しています。
ただし、ここでは、削除処理を実行しても削除できなかった場合は、処理を中断させるのではなく、ログファイルにログを出力するだけで、処理を継続する仕様にしています。
処理を中断させる必要がある場合は改修をしてください。
　
52行目は、新しいファイルが送信されなかった場合で、既存登録のファイルがある場合は、既存登録のファイルを削除せずに保存しなおすための処理になります。
　
61行目からの処理は、ファイルを削除する「delete」ボタンがクリックされた場合は、更新の入力画面に戻るためのリダイレクト処理を設定しています。
　
　

NewsController.phpの addアクションは変更なし

　
今回の機能拡張では「NewsController.php」の addアクションは「CakePHP3でファイルのアップロード処理を自作・解説付き・その１」で解説した変更箇所から変更する箇所はありません。
　
ですが、改めて addアクションも記載しておきます。
　

    public function add()
    {
        $news = $this->News->newEntity();
        if ($this->request->is('post')) {
            $news = $this->News->patchEntity($news, $this->request->data);

            $dir = realpath(WWW_ROOT . "/upload_img");
            // ファイルが入力されたとき
            if($this->request->data["file"]["name"]){

                $limitFileSize = 1024 * 1024;
                try {
                    $news['file'] = $this->file_upload($this->request->data['file'], $dir, $limitFileSize);
                } catch (RuntimeException $e){
                    $this->Flash->error(__('ファイルのアップロードができませんでした.'));
                    $this->Flash->error(__($e->getMessage()));
                }
            }

            if ($this->News->save($news)) {
                $this->Flash->success(__('The news has been saved.'));

                return $this->redirect(['action' => 'index']);
            }
            $this->Flash->error(__('The news could not be saved. Please, try again.'));
        }
        $this->set(compact('news'));
        $this->set('_serialize', ['news']);
    }

public function add()

{

$news = $this->News->newEntity();

if ($this->request->is('post')) {

$news = $this->News->patchEntity($news, $this->request->data);

$dir = realpath(WWW_ROOT . "/upload_img");

// ファイルが入力されたとき

if($this->request->data["file"]["name"]){

$limitFileSize = 1024 * 1024;

try {

$news['file'] = $this->file_upload($this->request->data['file'], $dir, $limitFileSize);

} catch (RuntimeException $e){

$this->Flash->error(__('ファイルのアップロードができませんでした.'));

$this->Flash->error(__($e->getMessage()));

}

if ($this->News->save($news)) {

$this->Flash->success(__('The news has been saved.'));

return $this->redirect(['action' => 'index']);

}

$this->Flash->error(__('The news could not be saved. Please, try again.'));

}

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

$this->set('_serialize', ['news']);

}

NewsController.phpの deleteアクションの更新

　
更新、登録に続いて、次はレコードの削除となる「NewsController.php」の deleteアクションの変更部分です。
　
更新するソースコードは下記になります。
　

    public function delete($id = null)
    {
        $this->request->allowMethod(['post', 'delete']);
        $news = $this->News->get($id);

        $dir = realpath(WWW_ROOT . "/upload_img");
        try {
            $del_file = new File($dir . "/". $news->file_name);
            // ファイル削除処理実行
            if($del_file->delete()) {
                $news['file'] = "";
            } else {
                throw new RuntimeException('ファイルの削除ができませんでした.');
            }
        } catch (RuntimeException $e){
            $this->log($e->getMessage(),LOG_DEBUG);
            $this->log($news->file_name,LOG_DEBUG);
        }

        if ($this->News->delete($news)) {
            $this->Flash->success(__('The news has been deleted.'));
        } else {
            $this->Flash->error(__('The news could not be deleted. Please, try again.'));
        }

        return $this->redirect(['action' => 'index']);
    }

public function delete($id = null)

{

$this->request->allowMethod(['post', 'delete']);

$news = $this->News->get($id);

$dir = realpath(WWW_ROOT . "/upload_img");

try {

$del_file = new File($dir . "/". $news->file_name);

// ファイル削除処理実行

if($del_file->delete()) {

$news['file'] = "";

} else {

throw new RuntimeException('ファイルの削除ができませんでした.');

}

} catch (RuntimeException $e){

$this->log($e->getMessage(),LOG_DEBUG);

$this->log($news->file_name,LOG_DEBUG);

}

if ($this->News->delete($news)) {

$this->Flash->success(__('The news has been deleted.'));

} else {

$this->Flash->error(__('The news could not be deleted. Please, try again.'));

}

return $this->redirect(['action' => 'index']);

}

　
ファイルが削除できない場合は、デバッグログに出力する処理だけにしています。
あまり発生しないと思っていることと、ファイルが消せなくてもレコードが消せれば良しとしよう、と判断しているためです。
厳密な処理を行うために処理を止めたい場合は、厳密なエラー処理を記述してください。
　

CakePHP3で画像・ファイルのアップロードする処理のまとめ

　
CakePHP3で画像やファイルのアップロードを行う処理を自作してみました。
　
CakePHP3が、Post送信されたファイルも扱いやすい形で処理してくれますので、その後のファイルのコントロールのスムーズに処理をすることができます。
　
サムネイルファイルを作成する機能などはありませんので、大きなファイルをアップロードすることを想定する場合などは、さらに追加の機能なども必要であろうと思いますが、ファイルのアップロードの処理について理解を深めるには、プラグインを使わずに一度自分で作ってみるのもいいんじゃないかと思います。
　
作成する上での関連記事は以下の通りとなります。
　
「CakePHP3のForm Helperの使い方のまとめ」
「CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数」
「CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得」
「CakePHP3でファイルのアップロード処理を自作・解説付き・その１」
　
　

- CakePHP 3.x 4.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP 2.3　bakeの超初心者向けフォロー講座

CakePHP 2.3　bakeの超初心者向けフォロー講座

: CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応

CakePHP3.7でCookieを保存、取り出し、削除する方法を解説。CakePHP3でのCookieの取り扱いはバージョンごとに変更されるため、環境に合わせた方法を探す必要がある。

: CakePHP3でQRコードを作成、表示するライブラリ「cakePHP-QR-Code-Helper」

CakePHPでQRコードを生成するライブラリ「cakePHP-QR-Code-Helper」の紹介。GDライブラリのインストールも必要ないHelperとして提供されているため、ファイルを設置すればすぐに使用可能。

: CakePHP3の検索プラグイン「friendsofcake/search」の設置方法・CakePHP3.6対応

CakePHP3で検索を担うプラグイン「friendsofcake/search」の紹介。基本的な設置方法の紹介のほか、処理の記述方法のバリエーション、エラーの解説など。CakeDC/searchより導入は簡単！

: CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説

CakePHP3でパンくずの指定方法の解説。2つのヘルパーがあるが簡単なHTMLヘルパーを使った方法を、実際の状況に合わせて3つのパターン（エレメント化、ブロック化）にして解説。

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

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

: CakePHP3チュートリアルで日付と時刻のDateTimeでエラーが出たときの対処方法

CakePHP3のブックマークチュートリアルには記載ミスもあり、そのまま動かない個所もある。CakePHP3では namespaceを使うようになったので、classを呼び出すときに￥を追加する必要が！

: CakePHP3で生の SQLの実行はConnectionManagerを使う

CakePHP3で生の SQL文を実行する方法を解説。クリエビルダーを使う場合は TableRegistryを利用するが、SQLを実行する場合は ConnectionManagerを使う。プリペアードステートメントの使用方法も解説。

: CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その２

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその2でバリデーションなどの実用的なカスタマイズ方法を解説。

: CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う

CakePHP3、CakePHP4では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。