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

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

Message コメントをキャンセル

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

: CakePHP 2.3でOn Duplicate Key構文を実装

CakePHPで On Duplicate Key構文を Queryを利用して実装する方法をサンプルソース付きで解説します。

: CakePHP 2.3で saveの便利な使い方・サンプルソース付き

CakePHPのレコードを保存、更新する際に使う Saveを詳細解説します。

: CakePHP4、5でSELECT telephone as tel FROM usersの様にasでカラムに別名を付ける方法

CakePHP4、CakePHP5でクリエビルダーを利用してテーブルからレコードを取得する際、asを使用してカラムの別名で値を取得したい場合の対応方法を解説。また、別名にはハイフンやアスタリスクなど使用できない文字がある点も解説。

: CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

CakePHP3にComposerからインストールできないプラグインやライブラリなどを利用する方法、vendorにファイルを設置し、composer.jsonを更新し、それを呼び出す方法を詳細に解説。

: CakePHP3のビューで受取ったテーブルのオブジェクトを連想配列に変換する方法

コントローラーからビューに送ったテーブルのオブジェクトを連想配列に変換し、ビューの中で自由に使えるようにするメソッド「toArray()」の解説。連想配列に変換できれば利用度アップ！

: CakePHP4、CakePHP5系の認証処理でログインの有無の確認、ユーザ情報の取得の方法

CakePHP4系、5系のログイン認証の可否のチェック、および、ログインユーザの情報を取得する方法のまとめ。複数の方法があるが手続きが微妙に異なるためまとめてみた。

: CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説

responseの値を指定する方法は3系では「body」だが、4系では「withStringBody」になりる。加えてJSON形式なら「withType」で指定するなど4系では結構異なる処理がある。

: CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可

CakePHP3のユーザ管理、ログイン認証プラグインである「CakeDC/Users」のメッセージを日本語にする手順の解説とともに、日本語の翻訳ファイルを提供。ファイルを設置すれば日本語になる！