Accessors and mutators in Laravel - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is an accessor in Laravel Eloquent?

An accessor is a method that modifies a model attribute's value when you retrieve it. It lets you change how data looks when you get it from the database.

beginner

What is a mutator in Laravel Eloquent?

A mutator is a method that modifies a model attribute's value before saving it to the database. It lets you change data automatically when you set it.

intermediate

How do you define an accessor method in a Laravel model?

Create a method named get{AttributeName}Attribute() in your model. For example, getFullNameAttribute() modifies the full_name attribute when accessed.

intermediate

How do you define a mutator method in a Laravel model?

Create a method named set{AttributeName}Attribute() in your model. For example, setPasswordAttribute() modifies the password before saving.

beginner

Why use accessors and mutators in Laravel?

They help keep your data clean and consistent by automatically changing values when you get or set them. This saves you from repeating code everywhere.

Which method name defines an accessor for the 'name' attribute in Laravel?

A mutateName

B setNameAttribute

C accessName

D getNameAttribute

Accessor methods start with 'get', followed by the attribute name and 'Attribute'.

What does a mutator do in Laravel?

A Changes attribute value when retrieving it

B Deletes an attribute from the model

C Changes attribute value before saving it

D Creates a new model instance

Mutators modify attribute values before saving to the database.

If you want to automatically hash a password before saving, which method should you use?

A setPasswordAttribute

B getPasswordAttribute

C hashPassword

D savePassword

Use a mutator named setPasswordAttribute to modify the password before saving.

What will Laravel do if you define getFullNameAttribute() in your model?

A Modify the full_name attribute when accessed

B Create a new database column called full_name

C Automatically save full_name to the database

D Ignore the method

Accessors modify attribute values when you get them from the model.

Which of these is NOT a benefit of using accessors and mutators?

A Keep data consistent

B Automatically create database tables

C Avoid repeating code

D Modify data format easily

Accessors and mutators do not create database tables; they only modify data values.

Explain how to create and use an accessor in a Laravel model. Include naming and purpose.

Think about how you want to change data when you get it from the model.

Describe the role of mutators in Laravel and give an example of when to use one.

Consider how to change data before it goes into the database.

Practice

1. What is the main purpose of an accessor in a Laravel model?

easy

A. To modify the value when saving a model attribute

B. To validate model data before saving

C. To define relationships between models

D. To modify the value when retrieving a model attribute

Solution

1. Step 1: Understand what an accessor does

   An accessor changes how you get or read a model attribute's value.

2. Step 2: Differentiate from mutator

   A mutator changes the value when setting or saving, not getting.

3. Final Answer:

   To modify the value when retrieving a model attribute -> Option D

4. Quick Check:

   Accessor = get attribute value [OK]

Hint: Accessor modifies data on get, mutator on set [OK]

Common Mistakes:

• Confusing accessor with mutator
• Thinking accessor validates data
• Mixing up relationships with accessors

2. Which of the following is the correct way to define an accessor for the name attribute in a Laravel model?

easy

A. public function name() { return $this->attributes['name']; }

B. public function setNameAttribute($value) { $this->attributes['name'] = strtolower($value); }

C. public function getNameAttribute($value) { return strtoupper($value); }

D. public function get_name() { return $this->name; }

Solution

1. Step 1: Recall accessor naming convention

   Accessors use the format get{Attribute}Attribute with the attribute name capitalized.

2. Step 2: Check method signature and return

   The method receives the raw value and returns the modified value.

3. Final Answer:

   public function getNameAttribute($value) { return strtoupper($value); } -> Option C

4. Quick Check:

   Accessor method = getNameAttribute [OK]

Hint: Accessor method name starts with get and ends with Attribute [OK]

Common Mistakes:

• Using set prefix for accessor
• Wrong method naming like get_name
• Not returning a value

3. Given the following Laravel model code, what will $user->full_name output?

class User extends Model {
  public function getFullNameAttribute() {
    return $this->first_name . ' ' . $this->last_name;
  }
}
$user = new User();
$user->first_name = 'Jane';
$user->last_name = 'Doe';
echo $user->full_name;

medium

A. JaneDoe

B. Jane Doe

C. Error: Undefined property full_name

D. null

Solution

1. Step 1: Understand the accessor method

   The method getFullNameAttribute concatenates first_name and last_name with a space.

2. Step 2: Check assigned values and output

   first_name is 'Jane', last_name is 'Doe', so full_name returns 'Jane Doe'.

3. Final Answer:

   Jane Doe -> Option B

4. Quick Check:

   Accessor combines names with space [OK]

Hint: Accessor returns combined attributes as expected [OK]

Common Mistakes:

• Forgetting space between names
• Expecting property to exist without accessor
• Confusing method name with property

4. Identify the error in this mutator method for the email attribute:

public function setEmailAttribute($email) {
  $this->email = strtolower($email);
}

medium

A. Should assign to $this->attributes['email'], not $this->email

B. Method name should be getEmailAttribute

C. Missing return statement

D. Mutators cannot modify email attribute

Solution

1. Step 1: Check mutator assignment syntax

   Mutators must assign to $this->attributes['attribute'], not directly to $this->attribute.

2. Step 2: Confirm method name and behavior

   Method name setEmailAttribute is correct; no return needed.

3. Final Answer:

   Should assign to $this->attributes['email'], not $this->email -> Option A

4. Quick Check:

   Mutator assigns to attributes array [OK]

Hint: Mutators assign to attributes array, not direct property [OK]

Common Mistakes:

• Assigning directly to $this->property
• Using accessor naming for mutator
• Expecting return value in mutator

5. You want to store a user's phone number in a Laravel model, but always save it without spaces or dashes. Which mutator method correctly achieves this?

public function setPhoneNumberAttribute($value) {
  // Remove spaces and dashes
  $clean = str_replace([' ', '-'], '', $value);
  // Save cleaned number
  ???
}

hard

A. $this->attributes['phone_number'] = $clean;

B. $this->phone_number = $clean;

C. return $clean;

D. $this->setAttribute('phone_number', $value);

Solution

1. Step 1: Understand mutator assignment

   Mutators must assign cleaned value to $this->attributes['phone_number'] to save properly.

2. Step 2: Check other options

   Assigning to $this->phone_number is incorrect; returning value or calling setAttribute with original value won't clean data.

3. Final Answer:

   $this->attributes['phone_number'] = $clean; -> Option A

4. Quick Check:

   Mutator saves cleaned value to attributes array [OK]

Hint: Mutator cleans input and assigns to attributes array [OK]

Common Mistakes:

• Assigning directly to property instead of attributes
• Returning value instead of assigning
• Using original value instead of cleaned