Add a custom attribute to a Laravel Eloquent model on load

Question

I d like to be able to add a custom attribute property to an Laravel Eloquent model when it is loaded  similar to how that might be achieved with RedBean s  model- gt open   method   For instance  at the moment  in my controller I have   public function index          sessions   EventSession  all        foreach   sessions as  i   gt   session             sessions  i - gt available    session- gt getAvailability              return  sessions      It would be nice to be able to omit the loop and have the  available  attribute already set and populated   I ve tried using some of the model events described in the documentation to attach this property when the object loads  but without success so far   Notes     available  is not a field in the underlying table   sessions is being returned as a JSON object as part of an API  and therefore calling something like  session- gt available   in a template isn t an option

User · Answer

in my case  creating an empty column and setting its accessor worked fine  my accessor filling user s age from dob column  toArray   function worked too   public function getAgeAttribute       return Carbon  createFromFormat  Y-m-d    this- gt attributes  dateofbirth   - gt age

User · Answer

I had something simular  I have an attribute picture in my model  this contains the location of the file in the Storage folder  The image must be returned base64 encoded    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- gt picture        type   Storage  mimeType  this- gt picture       return  data      type     base64     base64 encode  file

User · Answer

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- gt 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  lt  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- gt upper          return  array             public function getUpperAttribute                 return strtoupper  this- gt 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- gt getMutatedAttributes   as  key                        if     array key exists  key   array                      array  key     this- gt   key                                      return  array             public function getUpperAttribute                 return strtoupper  this- gt title

User · Answer

The last thing on the Laravel Eloquent doc page is   protected  appends   array  is admin      That can be used automatically to add new accessors to the model without any additional work like modifying methods like   toArray      Just create getFooBarAttribute      accessor and add the foo bar to   appends array

User · Answer

you can use setAttribute function in Model to add a custom attribute

User · Answer

If you rename your getAvailability   method to getAvailableAttribute   your method becomes an accessor and you ll be able to read it using - gt available straight on your model   Docs  https   laravel com docs 5 4 eloquent-mutators accessors-and-mutators  EDIT  Since your attribute is  virtual   it is not included by default in the JSON representation of your object   But I found this  Custom model accessors not processed when - toJson   called     In order to force your attribute to be returned in the array  add it as a key to the  attributes array   class User extends Eloquent       protected  attributes   array           ZipCode    gt                  public function getZipCodeAttribute                 return                I didn t test it  but should be pretty trivial for you to try in your current setup

User · Answer

Step 1  Define attributes in  appends Step 2  Define accessor for that attributes  Example    lt  php      class Movie extends Model       protected  appends     cover           define accessor     public function getCoverAttribute                 return json decode  this- gt InJson - gt cover

User · Answer

Let say you have 2 columns named first name and last name in your users table and you want to retrieve full name  you can achieve with the following code    class User extends Eloquent         public function getFullNameAttribute                 return  this- gt first name      this- gt last name            now you can get full name as    user   User  find 1    user- gt full name

User · Answer

In my subscription model  I need to know the subscription is paused or not  here is how I did it  public function getIsPausedAttribute          isPaused   false      if    this- gt is active             isPaused   true            then in the view template I can use   subscription- gt is paused to get the result    The getIsPausedAttribute is the format to set a custom attribute   and uses is paused to get or use the attribute in your view

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

Examples related to php

Examples related to orm

Examples related to laravel

Examples related to eloquent