¿Agregar un atributo personalizado a un modelo Laravel / Eloquent en carga?

Me gustaría poder agregar un atributo / propiedad personalizado a un modelo Laravel / Eloquent cuando se carga, de forma similar a cómo se podría lograr con el $model->open() método de RedBean .

Por ejemplo, en este momento, en mi controlador tengo:

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

Sería bueno poder omitir el ciclo y tener el atributo 'disponible' ya establecido y poblado.

Intenté usar algunos de los eventos del modelo descritos en la documentación para adjuntar esta propiedad cuando se carga el objeto, pero hasta ahora no he tenido éxito.

Notas:

• 'disponible' no es un campo en la tabla subyacente.
• $sessionsse devuelve como un objeto JSON como parte de una API y, por lo tanto, llamar a algo como $session->available()en una plantilla no es una opción

El problema es causado por el hecho de que el método Model's toArray()ignora cualquier acceso que no se relacione directamente con una columna en la tabla subyacente.

Como Taylor Otwell mencionó aquí , "Esto es intencional y por razones de rendimiento". Sin embargo, hay una manera fácil de lograr esto:

class EventSession extends Eloquent {

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

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

Todos los atributos enumerados en la propiedad $ appends se incluirán automáticamente en la matriz o en la forma JSON del modelo, siempre que haya agregado el descriptor de acceso apropiado.

Respuesta anterior (para versiones de Laravel <4.08):

La mejor solución que he encontrado es anular el toArray()método y establecer explícitamente el atributo:

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);    
    }

}

o, si tiene muchos accesos personalizados, recorra todos y aplíquelos:

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);    
    }

}

Lo último en la página de documentos de Laravel Eloquent es:

protected $appends = array('is_admin');

Eso se puede usar automáticamente para agregar nuevos accesos al modelo sin ningún trabajo adicional, como modificar métodos como ::toArray().

Basta con crear getFooBarAttribute(...)descriptor de acceso y añadir la foo_barde $appendsmatriz.

Si cambia el nombre de su getAvailability()método a getAvailableAttribute()su método, se convierte en un descriptor de acceso y podrá leerlo ->availabledirectamente en su modelo.

Documentos: https://laravel.com/docs/5.4/eloquent-mutators#accessors-and-mutators

EDITAR: Dado que su atributo es "virtual", no está incluido por defecto en la representación JSON de su objeto.

Pero encontré esto: ¿ Los accesos de modelos personalizados no se procesan cuando -> toJson () llama?

Para forzar que su atributo sea devuelto en la matriz, agréguelo como una clave a la matriz $ atributos.

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

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

No lo probé, pero debería ser bastante trivial para que lo intentes en tu configuración actual.

Tenía algo simular: tengo una imagen de atributo en mi modelo, que contiene la ubicación del archivo en la carpeta Almacenamiento. La imagen debe devolverse codificada en 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);
}

puede usar la setAttributefunción en Modelo para agregar un atributo personalizado

Digamos que tiene 2 columnas llamadas first_name y last_name en su tabla de usuarios y desea recuperar el nombre completo. puedes lograrlo con el siguiente código:

class User extends Eloquent {


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

ahora puedes obtener el nombre completo como:

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

Paso 1: Definir atributos en $appends
Paso 2: Definir el descriptor de acceso para esos atributos.
Ejemplo:

<?php
...

class Movie extends Model{

    protected $appends = ['cover'];

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

En mi modelo de suscripción, necesito saber si la suscripción está pausada o no. así es como lo hice

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

luego en la plantilla de vista, puedo usar $subscription->is_pausedpara obtener el resultado.

El getIsPausedAttributees el formato para establecer un atributo personalizado,

y usa is_pausedpara obtener o usar el atributo en su vista.

en mi caso, crear una columna vacía y configurar su accesor funcionó bien. mi descriptor de acceso llenando la edad del usuario desde la columna dob. La función toArray () también funcionó.

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