Додати навантажений атрибут до моделі Laravel / Eloquent при завантаженні?

Я хотів би мати змогу додати спеціальний атрибут / властивість до моделі Laravel / Eloquent, коли вона завантажується, подібно до того, як це можна досягти методом RedBean $model->open() .

Наприклад, на даний момент у своєму контролері я маю:

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

Було б непогано мати можливість пропустити цикл і мати атрибут 'available' вже встановлений і заповнений.

Я намагався використовувати деякі події моделі, описані в документації, щоб прикріпити цю властивість, коли об'єкт завантажується, але поки що без успіху.

Примітки:

• "Доступно" - це не поле в нижній таблиці.
• $sessionsповертається як об’єкт JSON як частина API, а тому викликати щось на зразок $session->available()шаблону не є варіантом

Проблема викликана тим, що метод Model's 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 красномовною є:

protected $appends = array('is_admin');

Це можна використовувати автоматично для додавання нових аксесуарів до моделі без будь-яких додаткових робіт, таких як модифікація методів, таких як ::toArray().

Просто створіть getFooBarAttribute(...)збрую і додайте foo_barв $appendsмасив.

Якщо перейменувати getAvailability()метод getAvailableAttribute()ваш метод стає збруя , і ви будете мати можливість читати його з допомогою ->availableпрямо на моделі.

Документи: https://laravel.com/docs/5.4/eloquent-mutators#accessors-and-mutators

EDIT: Оскільки ваш атрибут "віртуальний", він за замовчуванням не включається в представлення JSON вашого об'єкта.

Але я виявив це: користувацькі моделі аксесуарів не обробляються, коли -> toJson () викликається?

Щоб змусити ваш атрибут повернути в масив, додайте його як ключ до масиву $ атрибутів.

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функцію в моделі, щоб додати спеціальний атрибут

Скажімо, у таблиці користувачів у вас є 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для отримання або використання атрибута у вашому перегляді.

у моєму випадку створення порожнього стовпця та налаштування його аксесуара спрацювало чудово. мій користувач, що заповнює вік користувача з колонки "dob". функція toArray () також працювала.

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