Add a custom attribute to a Laravel / Eloquent model on load?

by

The problem is caused by the fact that the Model‘s toArray() method ignores any accessors which do not directly relate to a column in the underlying table.

As Taylor Otwell mentioned here, “This is intentional and for performance reasons.” However there is an easy way to achieve this:

class EventSession extends Eloquent {

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

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

Any attributes listed in the $appends property will automatically be included in the array or JSON form of the model, provided that you’ve added the appropriate accessor.

Old answer (for Laravel versions < 4.08):

The best solution that I’ve found is to override the toArray() method and either explicity set the attribute:

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

}

or, if you have lots of custom accessors, loop through them all and apply them:

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

}

More Related Contents:

  1. Get Specific Columns Using “With()” Function in Laravel Eloquent
  2. Get the Query Executed in Laravel 3/4
  3. How to Make Laravel Eloquent “IN” Query?
  4. Laravel Eloquent sort by relation table column
  5. Laravel Many to many self referencing table only works one way
  6. Laravel one to many relation with a one to one relation
  7. Automatically deleting related rows in Laravel (Eloquent ORM)
  8. How do I get the query builder to output its raw SQL query as a string?
  9. How to query between two dates using Laravel and Eloquent?
  10. Bulk Insertion in Laravel using eloquent ORM
  11. Laravel Check If Related Model Exists
  12. How can I convert many statement mysql to laravel eloquent?
  13. Laravel, sync() – how to sync an array and also pass additional pivot fields?
  14. Laravel Model with Two Primary Keys update [duplicate]
  15. Laravel eager loading with limit
  16. Laravel OrderBy relationship count
  17. Laravel 5.2 – Use a String as a Custom Primary Key for Eloquent Table becomes 0
  18. Laravel Eloquent: How to order results of related models?
  19. Laravel 4: how to “order by” using Eloquent ORM [duplicate]
  20. How to set a default attribute value for a Laravel / Eloquent model?
  21. How to alias the name of a column in Eloquent
  22. Laravel – Database, Table and Column Naming Conventions?
  23. Order By before Group By using Eloquent (Laravel)
  24. How to Merge Two Eloquent Collections?
  25. Difference between Eloquent\Model::get() and all()
  26. Laravel 4.1: How to paginate eloquent eager relationship?
  27. Laravel Eloquent: How to get only certain columns from joined tables
  28. Find or Create with Eloquent
  29. How to get last insert id in Eloquent ORM laravel
  30. Merge ‘with’ and ‘whereHas’ in Laravel 5

Leave a Comment