ロード時にLaravel / Eloquentモデルにカスタム属性を追加しますか？

RedBeanの $model->open()メソッドで実現できる方法と同様に、ロード時にLaravel / Eloquentモデルにカスタム属性/プロパティを追加できるようにしたいと思います。

たとえば、現時点では、私のコントローラーには次のものが含まれています。

public function index()
{
    $sessions = EventSession::all();
    foreach ($sessions as $i => $session) {
        $sessions[$i]->available = $session->getAvailability();
    }
    return $sessions;
}

ループを省略して、 'available'属性を既に設定および設定できると便利です。

ドキュメントで説明されているいくつかのモデルイベントを使用して、オブジェクトの読み込み時にこのプロパティをアタッチしようとしましたが、これまでのところ成功していません。

ノート：

• 「利用可能」は、基になるテーブルのフィールドではありません。
• $sessionsAPIの一部としてJSONオブジェクトとして返されているため$session->available()、テンプレートのようなものを呼び出すことはオプションではありません

この問題は、Model'のtoArray()メソッドが、基になるテーブルの列に直接関連しないすべてのアクセサーを無視するために発生します。

Taylor Otwellがここで述べたように、「これは意図的なものであり、パフォーマンス上の理由によるものです。」ただし、これを実現する簡単な方法があります。

class EventSession extends Eloquent {

    protected $table = 'sessions';
    protected $appends = array('availability');

    public function getAvailabilityAttribute()
    {
        return $this->calculateAvailability();  
    }
}

$ appendsプロパティにリストされている属性は、適切なアクセサーを追加した場合、モデルの配列またはJSON形式に自動的に含まれます。

古い答え（Laravelバージョン<4.08の場合）：

私が見つけた最良の解決策は、toArray()メソッドをオーバーライドし、属性を明示的に設定することです：

class Book extends Eloquent {

    protected $table = 'books';

    public function toArray()
    {
        $array = parent::toArray();
        $array['upper'] = $this->upper;
        return $array;
    }

    public function getUpperAttribute()
    {
        return strtoupper($this->title);    
    }

}

または、カスタムアクセサーが多数ある場合は、それらをすべてループして適用します。

class Book extends Eloquent {

    protected $table = 'books';

    public function toArray()
    {
        $array = parent::toArray();
        foreach ($this->getMutatedAttributes() as $key)
        {
            if ( ! array_key_exists($key, $array)) {
                $array[$key] = $this->{$key};   
            }
        }
        return $array;
    }

    public function getUpperAttribute()
    {
        return strtoupper($this->title);    
    }

}

Laravel Eloquentのドキュメントページの最後は次のとおりです。

protected $appends = array('is_admin');

これを自動的に使用して、のようなメソッドを変更するなどの追加作業なしで、モデルに新しいアクセサーを追加できます::toArray()。

getFooBarAttribute(...)アクセサを作成しfoo_barて$appends配列に追加する だけです。

getAvailability()メソッドの名前をメソッドに変更するgetAvailableAttribute()と、アクセサーになり->available、モデルで直接使用してメソッドを読み取ることができます。

ドキュメント：https : //laravel.com/docs/5.4/eloquent-mutators#accessors-and-mutators

編集：属性は「仮想」であるため、デフォルトではオブジェクトのJSON表現に含まれません。

しかし、私はこれを見つけました：-> toJson（）が呼び出されたときにカスタムモデルのアクセサーが処理されませんか？

属性を配列で強制的に返すには、属性をキーとして$ attributes配列に追加します。

class User extends Eloquent {
    protected $attributes = array(
        'ZipCode' => '',
    );

    public function getZipCodeAttribute()
    {
        return ....
    }
}

私はそれをテストしませんでした、しかしあなたがあなたの現在のセットアップで試すのはかなり簡単なはずです。

私は何か似ています：モデルに属性画像があり、これにはStorageフォルダー内のファイルの場所が含まれています。画像はbase64エンコードで返される必要があります

//Add extra attribute
protected $attributes = ['picture_data'];

//Make it available in the json response
protected $appends = ['picture_data'];

//implement the attribute
public function getPictureDataAttribute()
{
    $file = Storage::get($this->picture);
    $type = Storage::mimeType($this->picture);
    return "data:" . $type . ";base64," . base64_encode($file);
}

setAttributeモデルの関数を使用してカスタム属性を追加できます

usersテーブルにfirst_nameとlast_nameという2つの列があり、フルネームを取得したいとします。あなたは次のコードで達成することができます：

class User extends Eloquent {


    public function getFullNameAttribute()
    {
        return $this->first_name.' '.$this->last_name;
    }
}

今、あなたはフルネームを次のように得ることができます：

$user = User::find(1);
$user->full_name;

ステップ1：$appends
ステップ2：属性のアクセサーを定義するで属性を定義します。
例：

<?php
...

class Movie extends Model{

    protected $appends = ['cover'];

    //define accessor
    public function getCoverAttribute()
    {
        return json_decode($this->InJson)->cover;
    }

私のサブスクリプションモデルでは、サブスクリプションが一時停止されているかどうかを知る必要があります。これが私がやった方法です

public function getIsPausedAttribute() {
    $isPaused = false;
    if (!$this->is_active) {
        $isPaused = true;
    }
}

次に、ビューテンプレートで$subscription->is_paused、結果を取得するために使用できます 。

getIsPausedAttributeカスタム属性を設定するためのフォーマットであり、

そして使用していますis_pausedあなたのビューで属性を取得または使用します。

私の場合、空の列を作成し、そのアクセサーを設定するとうまくいきました。私のアクセサーは、ドブ列からユーザーの年齢を入力します。toArray（）関数も機能しました。

public function getAgeAttribute()
{
  return Carbon::createFromFormat('Y-m-d', $this->attributes['dateofbirth'])->age;
}