Accessors And Mutators In PHP Laravel

Accessors and mutators allow you to modify Eloquent attribute values when you fetch or set them on model instances.

For Eg: If you would like to transform or manipulate data before storing or while fetching from the database tables than you can you Mutators and Accessors respectively.

NOTE: Accessors & Mutators only works on eloquent models.

---

Accessors (Will start with get)

The accessor will be called automatically by Eloquent when attempting to retrieve the value of the attribute.

To define an accessor, create a getFooAttribute method on your model where Foo is the "studly" cased (meaning every word first letter will be capital, Eg: first_name of table column will become FirstName) name of the column you wish to access.

Eg: I want to add accessor to capitalize the first_name column of my table while fetching from the table then we need to create getFirstNameAttribute() method in our model

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
  public function getFirstNameAttribute($firstName)
  {
    return ucfirst($firstName);
  }
}

Example

/** Here in table my name was saved like channaveer */
$user = User::find(1);

/** By using model first_name Laravel will automatically use accessor and manipulate the data before presenting you */
$user->first_name; /** Now the first_name will be Channaveer */

Return New Computed Values

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

---

Mutator (Will start with set)

The Mutators will be called automatically by Eloquent when you want to store any value of the attribute in the database table.

To define a mutator, define a setFooAttribute method on your model where Foo is the "studly" (meaning every word first letter will be capital, Eg: first_name of table column will become FirstName) cased name of the column you wish to write.

Eg: I want to add a mutator to lowercase the first_name column of my table while storing to table then we need to create setFirstNameAttribute() method in our model.

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
  public function setFirstNameAttribute($firstName)
  {
    $this->attributes['first_name'] = strtolower($firstName);
  }
}

---

Conclusion

Hopefully, you will start implementing in your project and take advantage of it.

Random Articles For You

Send SMS With Amazon SNS (Simple Notification Service) Using PHP

Writing Clean Code In PHP

Accessors & Mutators In Laravel. Problem In Set Attribute While Saving/Updating Data & How To Resolve It

Why namespace And use Keywords Used In PHP

What Is Method Chaining In PHP?

Upload File From Frontend Server {GuzzleHttp} To REST API Server In PHP {Laravel}

Create Zip File On The Fly With Streaming Download In PHP Laravel

Supervisor For Laravel Queue Scheduling

@stack @push and @prepend In Laravel Blade

Securely SSH Your Server & Push Files With FileZilla

Why You Should Run Cronjobs In Laravel?

Use Different PHP Versions In Ubuntu / Linux

Hotlink Protection In Nginx

Laravel Custom Maintenance Page

Factory States For Clean And Fluent Laravel Testing