【Laravel】ソフトデリートカラムのカスタマイズ

Question

テーブルにdeleted_atカラムを追加するソフトデリート機能を有効にできると思いますが、
このカラム名を**delete_flag（1=削除）**のように独自のカラムに変更することは可能でしょうか？

既にdelete_flagが使用されているのでカラム名をdeleted_at置き換えるというのは難しい状況です。

調べても公式ドキュメントにも記載されていませんし、そのような記事も見つけられなかったので質問させてください。
よろしくお願いいたします。

Answer 1

下記の様にtraitをオーバーライドしてみては如何でしょうか？
ざっと検証した限りでは、問題なく稼働している様に思いますが…

Model

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;


class testTable extends Model
{
    use SoftDeletes;
    protected $table = 'testTable';
    public $timestamps = false;
    
    /**
     * ソフトデリートの判定カラムを上書き
     * @return string
     */
    public function getDeletedAtColumn(): string
    {
        return 'delete_flg';
    }
    /**
     * 
     * @return void
     */
    public function runSoftDelete() 
    {
        $query = $this->newQueryWithoutScopes()->where($this->getKeyName(), $this->getKey());

        $time = $this->freshTimestamp();

        //$columns = [$this->getDeletedAtColumn() => $this->fromDateTime($time)];
        $columns = [$this->getDeletedAtColumn() => true];

        //$this->{$this->getDeletedAtColumn()} = $time;
        $this->{$this->getDeletedAtColumn()} = true;

        if ($this->timestamps && ! is_null($this->getUpdatedAtColumn())) {
            $this->{$this->getUpdatedAtColumn()} = $time;

            $columns[$this->getUpdatedAtColumn()] = $this->fromDateTime($time);
        }

        $query->update($columns);
    }
}

migrate

<?php

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class TestTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('testTable', function (Blueprint $table) {
            $table->increments('id');
            $table->string('name');
            $table->boolean('delete_flg')->nullable();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('testTable');
    }
}

Answer 2

SoftDeletesトレートのソースです。
https://github.com/laravel/framework/blob/5.5/src/Illuminate/Database/Eloquent/SoftDeletes.php

論理削除に使うカラム名は内部的にgetDeletedAtColumnメソッドで取得していますが

public function getDeletedAtColumn()
{
    return defined('static::DELETED_AT') ? static::DELETED_AT : 'deleted_at';
}

論理削除を使うモデルに、DELETED_ATというオブジェクト定数が定義されていればそれを使い、
定義されていなければdeleted_atを使うという実装になっています。
なので、論理削除を使うモデルに定数追加でいけそうです（すいませんが手元で試せてはいません）

const DELETED_AT = 'delete_flag';

Comments

[Archsted]

あ、申し訳ないです。delete_flagは日付じゃなくて0/1の数値型なんですね。
ちょっと確認します。

[退会済みユーザー]

マジックメソッド __set でどうにかなんじゃね

[Archsted]

確かに値の変換は__setでいけそうですね。ただSoftDeletes内部でグローバルスコープに登録してるSoftDeletingScopeで、削除判定にwhereNullをクエリビルダに追加しているので、0/1管理になってたら無理っぽいです。このスコープを模して作ったスコープをSoftDeletesトレートのbootSoftDeletes()をオーバーライドして設定すればできるでしょうけど・・・

ということですいません、私の上の回答は今回のケースでは取り下げとさせてください。

[退会済みユーザー]

そこは __get でもどうにかして 0 の場合 null とか

[naga3]

http://tnamao.hatenablog.com/entry/2015/09/01/013007
すこし古い記事ですが結構面倒な感じがします。
いっそEloquentの機能使わないほうが楽かも

Answer 3

以前似たようなことに遭遇したときの解法です。
ご参考までにどうぞ。
https://qiita.com/sh-ogawa/items/8c1e9beee7c19be99862

Answer 4

回答者の方々からのご意見をいただき、私のスキルでは、結構時間がかかりそうかつ、プロダクションでの動作を保証できかねると判断したため、当該機能を見送ることとしました。
ご回答くださった方、本当にありがとうございました。みなさんの考え方について今後の何かの参考にさせていただきます。