Eloquent ORM

Introduction
Basic Usage
Mass Assignment
Insert, Update, Delete
Soft Deleting
Timestamps
Query Scopes
Relationships
Querying Relations
Eager Loading
Inserting Related Models
Touching Parent Timestamps
Working With Pivot Tables
Collections
Accessors & Mutators
Date Mutators
Model Events
Model Observers
Converting To Arrays / JSON

Introduction

The Eloquent ORM included with Laravel provides a beautiful, simple ActiveRecord implementation for working with your database. Each database table has a corresponding "Model" which is used to interact with that table.

Before getting started, be sure to configure a database connection in app/config/database.php.

Basic Usage

To get started, create an Eloquent model. Models typically live in the app/models directory, but you are free to place them anywhere that can be auto-loaded according to your composer.json file.

Defining An Eloquent Model

class User extends Eloquent {}

Note that we did not tell Eloquent which table to use for our User model. The lower-case, plural name of the class will be used as the table name unless another name is explicitly specified. So, in this case, Eloquent will assume the User model stores records in the users table. You may specify a custom table by defining a table property on your model:

class User extends Eloquent {

	protected $table = 'my_users';

}

Note: Eloquent will also assume that each table has a primary key column named id. You may define a primaryKey property to override this convention. Likewise, you may define a connection property to override the name of the database connection that should be used when utilizing the model.

Once a model is defined, you are ready to start retrieving and creating records in your table. Note that you will need to place updated_at and created_at columns on your table by default. If you do not wish to have these columns automatically maintained, set the $timestamps property on your model to false.

Retrieving All Models

$users = User::all();

Retrieving A Record By Primary Key

$user = User::find(1);

var_dump($user->name);

Note: All methods available on the query builder are also available when querying Eloquent models.

Retrieving A Model By Primary Key Or Throw An Exception

Sometimes you may wish to throw an exception if a model is not found, allowing you to catch the exceptions using an App::error handler and display a 404 page.

$model = User::findOrFail(1);

$model = User::where('votes', '>', 100)->firstOrFail();

To register the error handler, listen for the ModelNotFoundException

use Illuminate\Database\Eloquent\ModelNotFoundException;

App::error(function(ModelNotFoundException $e)
{
	return Response::make('Not Found', 404);
});

Querying Using Eloquent Models

$users = User::where('votes', '>', 100)->take(10)->get();

foreach ($users as $user)
{
	var_dump($user->name);
}

Of course, you may also use the query builder aggregate functions.

Eloquent Aggregates

$count = User::where('votes', '>', 100)->count();

Mass Assignment

When creating a new model, you pass an array of attributes to the model constructor. These attributes are then assigned to the model via mass-assignment. This is convenient; however, can be a serious security concern when blindly passing user input into a model. If user input is blindly passed into a model, the user is free to modify any and all of the model's attributes. For this reason, all Eloquent models protect against mass-assignment by default.

To get started, set the fillable or guarded properties on your model.

The fillable property specifies which attributes should be mass-assignable. This can be set at the class or instance level.

Defining Fillable Attributes On A Model

class User extends Eloquent {

	protected $fillable = array('first_name', 'last_name', 'email');

}

In this example, only the three listed attributes will be mass-assignable.

The inverse of fillable is guarded, and serves as a "black-list" instead of a "white-list":

Defining Guarded Attributes On A Model

class User extends Eloquent {

	protected $guarded = array('id', 'password');

}

In the example above, the id and password attributes may not be mass assigned. All other attributes will be mass assignable. You may also block all attributes from mass assignment using the guard method:

Blocking All Attributes From Mass Assignment

protected $guarded = array('*');

Insert, Update, Delete

To create a new record in the database from a model, simply create a new model instance and call the save method.

Saving A New Model

$user = new User;

$user->name = 'John';

$user->save();

Note: Typically, your Eloquent models will have auto-incrementing keys. However, if you wish to specify your own keys, set the incrementing property on your model to false.

You may also use the create method to save a new model in a single line. The inserted model instance will be returned to you from the method. However, before doing so, you will need to specify either a fillable or guarded attribute on the model, as all Eloquent models protect against mass-assignment.

Setting The Guarded Attributes On The Model

class User extends Eloquent {

	protected $guarded = array('id', 'account_id');

}

Using The Model Create Method

$user = User::create(array('name' => 'John'));

To update a model, you may retrieve it, change an attribute, and use the save method:

Updating A Retrieved Model

$user = User::find(1);

$user->email = 'john@foo.com';

$user->save();

Sometimes you may wish to save not only a model, but also all of its relationships. To do so, you may use the push method:

Saving A Model And Relationships

$user->push();

You may also run updates as queries against a set of models:

$affectedRows = User::where('votes', '>', 100)->update(array('status' => 2));

To delete a model, simply call the delete method on the instance:

Deleting An Existing Model

$user = User::find(1);

$user->delete();

Deleting An Existing Model By Key

User::destroy(1);

User::destroy(1, 2, 3);

Of course, you may also run a delete query on a set of models:

$affectedRows = User::where('votes', '>', 100)->delete();

If you wish to simply update the timestamps on a model, you may use the touch method:

Updating Only The Model's Timestamps

$user->touch();

Soft Deleting

When soft deleting a model, it is not actually removed from your database. Instead, a deleted_at timestamp is set on the record. To enable soft deletes for a model, specify the softDelete property on the model:

class User extends Eloquent {

	protected $softDelete = true;

}

To add a deleted_at column to your table, you may use the softDeletes method from a migration:

$table->softDeletes();

Now, when you call the delete method on the model, the deleted_at column will be set to the current timestamp. When querying a model that uses soft deletes, the "deleted" models will not be included in query results. To force soft deleted models to appear in a result set, use the withTrashed method on the query:

Forcing Soft Deleted Models Into Results

$users = User::withTrashed()->where('account_id', 1)->get();

If you wish to only receive soft deleted models in your results, you may use the onlyTrashed method:

$users = User::onlyTrashed()->where('account_id', 1)->get();

To restore a soft deleted model into an active state, use the restore method:

$user->restore();

You may also use the restore method on a query:

User::withTrashed()->where('account_id', 1)->restore();

The restore method may also be used on relationships:

$user->posts()->restore();

If you wish to truly remove a model from the database, you may use the forceDelete method:

$user->forceDelete();

The forceDelete method also works on relationships:

$user->posts()->forceDelete();

To determine if a given model instance has been soft deleted, you may use the trashed method:

if ($user->trashed())
{
	//
}

Timestamps

By default, Eloquent will maintain the created_at and updated_at columns on your database table automatically. Simply add these datetime columns to your table and Eloquent will take care of the rest. If you do not wish for Eloquent to maintain these columns, add the following property to your model:

Disabling Auto Timestamps

class User extends Eloquent {

	protected $table = 'users';

	public $timestamps = false;

}

If you wish to customize the format of your timestamps, you may override the freshTimestamp method in your model:

Providing A Custom Timestamp Format

class User extends Eloquent {

	public function freshTimestamp()
	{
		return time();
	}

}

Query Scopes

Scopes allow you to easily re-use query logic in your models. To define a scope, simply prefix a model method with scope:

Defining A Query Scope

class User extends Eloquent {

	public function scopePopular($query)
	{
		return $query->where('votes', '>', 100);
	}

}

Utilizing A Query Scope

$users = User::popular()->orderBy('created_at')->get();

Relationships

Of course, your database tables are probably related to one another. For example, a blog post may have many comments, or an order could be related to the user who placed it. Eloquent makes managing and working with these relationships easy. Laravel supports four types of relationships:

One To One
One To Many
Many To Many
Polymorphic Relations

One To One

A one-to-one relationship is a very basic relation. For example, a User model might have one Phone. We can define this relation in Eloquent:

Defining A One To One Relation

class User extends Eloquent {

	public function phone()
	{
		return $this->hasOne('Phone');
	}

}

The first argument passed to the hasOne method is the name of the related model. Once the relationship is defined, we may retrieve it using Eloquent's dynamic properties:

$phone = User::find(1)->phone;

The SQL performed by this statement will be as follows:

select * from users where id = 1

select * from phones where user_id = 1

Take note that Eloquent assumes the foreign key of the relationship based on the model name. In this case, Phone model is assumed to use a user_id foreign key. If you wish to override this convention, you may pass a second argument to the hasOne method:

return $this->hasOne('Phone', 'custom_key');

To define the inverse of the relationship on the Phone model, we use the belongsTo method:

Defining The Inverse Of A Relation

class Phone extends Eloquent {

	public function user()
	{
		return $this->belongsTo('User');
	}

}

One To Many

An example of a one-to-many relation is a blog post that "has many" comments. We can model this relation like so:

class Post extends Eloquent {

	public function comments()
	{
		return $this->hasMany('Comment');
	}

}

Now we can access the post's comments through the dynamic property:

$comments = Post::find(1)->comments;

If you need to add further constraints to which comments are retrieved, you may call the comments method and continue chaining conditions:

$comments = Post::find(1)->comments()->where('title', '=', 'foo')->first();

Again, you may override the conventional foreign key by passing a second argument to the hasMany method:

return $this->hasMany('Comment', 'custom_key');

To define the inverse of the relationship on the Comment model, we use the belongsTo method:

Defining The Inverse Of A Relation

class Comment extends Eloquent {

	public function post()
	{
		return $this->belongsTo('Post');
	}

}

Many To Many

Many-to-many relations are a more complicated relationship type. An example of such a relationship is a user with many roles, where the roles are also shared by other users. For example, many users may have the role of "Admin". Three database tables are needed for this relationship: users, roles, and role_user. The role_user table is derived from the alphabetical order of the related model names, and should have user_id and role_id columns.

We can define a many-to-many relation using the belongsToMany method:

class User extends Eloquent {

	public function roles()
	{
		return $this->belongsToMany('Role');
	}

}

Now, we can retrieve the roles through the User model:

$roles = User::find(1)->roles;

If you would like to use an unconventional table name for your pivot table, you may pass it as the second argument to the belongsToMany method:

return $this->belongsToMany('Role', 'user_roles');

You may also override the conventional associated keys:

return $this->belongsToMany('Role', 'user_roles', 'user_id', 'foo_id');

Of course, you may also define the inverse of the relationship on the Role model:

class Role extends Eloquent {

	public function users()
	{
		return $this->belongsToMany('User');
	}

}

Polymorphic Relations

Polymorphic relations allow a model to belong to more than one other model, on a single association. For example, you might have a photo model that belongs to either a staff model or an order model. We would define this relation like so:

class Photo extends Eloquent {

	public function imageable()
	{
		return $this->morphTo();
	}

}

class Staff extends Eloquent {

	public function photos()
	{
		return $this->morphMany('Photo', 'imageable');
	}

}

class Order extends Eloquent {

	public function photos()
	{
		return $this->morphMany('Photo', 'imageable');
	}

}

Now, we can retrieve the photos for either a staff member or an order:

Retrieving A Polymorphic Relation

$staff = Staff::find(1);

foreach ($staff->photos as $photo)
{
	//
}

However, the true "polymorphic" magic is when you access the staff or order from the Photo model:

Retrieving The Owner Of A Polymorphic Relation

$photo = Photo::find(1);

$imageable = $photo->imageable;

The imageable relation on the Photo model will return either a Staff or Order instance, depending on which type of model owns the photo.

To help understand how this works, let's explore the database structure for a polymorphic relation:

Polymorphic Relation Table Structure

staff
	id - integer
	name - string

orders
	id - integer
	price - integer

photos
	id - integer
	path - string
	imageable_id - integer
	imageable_type - string

The key fields to notice here are the imageable_id and imageable_type on the photos table. The ID will contain the ID value of, in this example, the owning staff or order, while the type will contain the class name of the owning model. This is what allows the ORM to determine which type of owning model to return when accessing the imageable relation.

Querying Relations

When accessing the records for a model, you may wish to limit your results based on the existence of a relationship. For example, you wish to pull all blog posts that have at least one comment. To do so, you may use the has method:

Checking Relations When Selecting

$posts = Post::has('comments')->get();

You may also specify an operator and a count:

$posts = Post::has('comments', '>=', 3)->get();

Dynamic Properties

Eloquent allows you to access your relations via dynamic properties. Eloquent will automatically load the relationship for you, and is even smart enough to know whether to call the get (for one-to-many relationships) or first (for one-to-one relationships) method. It will then be accessible via a dynamic property by the same name as the relation. For example, with the following model $phone:

class Phone extends Eloquent {

	public function user()
	{
		return $this->belongsTo('User');
	}

}

$phone = Phone::find(1);

Instead of echoing the user's email like this:

echo $phone->user()->first()->email;

It may be shortened to simply:

echo $phone->user->email;

Eager Loading

Eager loading exists to alleviate the N + 1 query problem. For example, consider a Book model that is related to Author. The relationship is defined like so:

class Book extends Eloquent {

	public function author()
	{
		return $this->belongsTo('Author');
	}

}

Now, consider the following code:

foreach (Book::all() as $book)
{
	echo $book->author->name;
}

This loop will execute 1 query to retrieve all of the books on the table, then another query for each book to retrieve the author. So, if we have 25 books, this loop would run 26 queries.

Thankfully, we can use eager loading to drastically reduce the number of queries. The relationships that should be eager loaded may be specified via the with method:

foreach (Book::with('author')->get() as $book)
{
	echo $book->author->name;
}

In the loop above, only two queries will be executed:

select * from books

select * from authors where id in (1, 2, 3, 4, 5, ...)

Wise use of eager loading can drastically increase the performance of your application.

Of course, you may eager load multiple relationships at one time:

$books = Book::with('author', 'publisher')->get();

You may even eager load nested relationships:

$books = Book::with('author.contacts')->get();

In the example above, the author relationship will be eager loaded, and the author's contacts relation will also be loaded.

Eager Load Constraints

Sometimes you may wish to eager load a relationship, but also specify a condition for the eager load. Here's an example:

$users = User::with(array('posts' => function($query)
{
	$query->where('title', 'like', '%first%');
}))->get();

In this example, we're eager loading the user's posts, but only if the post's title column contains the word "first".

Lazy Eager Loading

It is also possible to eagerly load related models directly from an already existing model collection. This may be useful when dynamically deciding whether to load related models or not, or in combination with caching.

$books = Book::all();

$books->load('author', 'publisher');

Inserting Related Models

You will often need to insert new related models. For example, you may wish to insert a new comment for a post. Instead of manually setting the post_id foreign key on the model, you may insert the new comment from its parent Post model directly:

Attaching A Related Model

$comment = new Comment(array('message' => 'A new comment.'));

$post = Post::find(1);

$comment = $post->comments()->save($comment);

In this example, the post_id field will automatically be set on the inserted comment.

Associating Models (Belongs To)

When updating a belongsTo relationship, you may use the associate method. This method will set the foreign key on the child model:

$account = Account::find(10);

$user->account()->associate($account);

$user->save();

Inserting Related Models (Many To Many)

You may also insert related models when working with many-to-many relations. Let's continue using our User and Role models as examples. We can easily attach new roles to a user using the attach method:

Attaching Many To Many Models

$user = User::find(1);

$user->roles()->attach(1);

You may also pass an array of attributes that should be stored on the pivot table for the relation:

$user->roles()->attach(1, array('expires' => $expires));

Of course, the opposite of attach is detach:

$user->roles()->detach(1);

You may also use the sync method to attach related models. The sync method accepts an array of IDs to place on the pivot table. After this operation is complete, only the IDs in the array will be on the intermediate table for the model:

Using Sync To Attach Many To Many Models

$user->roles()->sync(array(1, 2, 3));

You may also associate other pivot table values with the given IDs:

Adding Pivot Data When Syncing

$user->roles()->sync(array(1 => array('expires' => true)));

Sometimes you may wish to create a new related model and attach it in a single command. For this operation, you may use the save method:

$role = new Role(array('name' => 'Editor'));

User::find(1)->roles()->save($role);

In this example, the new Role model will be saved and attached to the user model. You may also pass an array of attributes to place on the joining table for this operation:

User::find(1)->roles()->save($role, array('expires' => $expires));

Touching Parent Timestamps

When a model belongsTo another model, such as a Comment which belongs to a Post, it is often helpful to update the parent's timestamp when the child model is updated. For example, when a Comment model is updated, you may want to automatically touch the updated_at timestamp of the owning Post. Eloquent makes it easy. Just add a touches property containing the names of the relationships to the child model:

class Comment extends Eloquent {

	protected $touches = array('post');

	public function post()
	{
		return $this->belongsTo('Post');
	}

}

Now, when you update a Comment, the owning Post will have its updated_at column updated:

$comment = Comment::find(1);

$comment->text = 'Edit to this comment!';

$comment->save();

Working With Pivot Tables

As you have already learned, working with many-to-many relations requires the presence of an intermediate table. Eloquent provides some very helpful ways of interacting with this table. For example, let's assume our User object has many Role objects that it is related to. After accessing this relationship, we may access the pivot table on the models:

$user = User::find(1);

foreach ($user->roles as $role)
{
	echo $role->pivot->created_at;
}

Notice that each Role model we retrieve is automatically assigned a pivot attribute. This attribute contains a model representing the intermediate table, and may be used as any other Eloquent model.

By default, only the keys will be present on the pivot object. If your pivot table contains extra attributes, you must specify them when defining the relationship:

return $this->belongsToMany('Role')->withPivot('foo', 'bar');

Now the foo and bar attributes will be accessible on our pivot object for the Role model.

If you want your pivot table to have automatically maintained created_at and updated_at timestamps, use the withTimestamps method on the relationship definition:

return $this->belongsToMany('Role')->withTimestamps();

To delete all records on the pivot table for a model, you may use the detach method:

Deleting Records On A Pivot Table

User::find(1)->roles()->detach();

Note that this operation does not delete records from the roles table, but only from the pivot table.

Collections

All multi-result sets returned by Eloquent either via the get method or a relationship return an Eloquent Collection object. This object implements the IteratorAggregate PHP interface so it can be iterated over like an array. However, this object also has a variety of other helpful methods for working with result sets.

For example, we may determine if a result set contains a given primary key using the contains method:

Checking If A Collection Contains A Key

$roles = User::find(1)->roles;

if ($roles->contains(2))
{
	//
}

Collections may also be converted to an array or JSON:

$roles = User::find(1)->roles->toArray();

$roles = User::find(1)->roles->toJson();

If a collection is cast to a string, it will be returned as JSON:

$roles = (string) User::find(1)->roles;

Eloquent collections also contain a few helpful methods for looping and filtering the items they contain:

Iterating & Filtering Collections

$roles = $user->roles->each(function($role)
{

});

$roles = $user->roles->filter(function($role)
{

});

Applying A Callback To Each Collection Object

$roles = User::find(1)->roles;

$roles->each(function($role)
{
	//	
});

Sorting A Collection By A Value

$roles = $roles->sortBy(function($role)
{
	return $role->created_at;
});

Sometimes, you may wish to return a custom Collection object with your own added methods. You may specify this on your Eloquent model by overriding the newCollection method:

Returning A Custom Collection Type

class User extends Eloquent {

	public function newCollection(array $models = array())
	{
		return new CustomCollection($models);
	}

}

Accessors & Mutators

Eloquent provides a convenient way to transform your model attributes when getting or setting them. Simply define a getFooAttribute method on your model to declare an accessor. Keep in mind that the methods should follow camel-casing, even though your database columns are snake-case:

Defining An Accessor

class User extends Eloquent {

	public function getFirstNameAttribute($value)
	{
		return ucfirst($value);
	}

}

In the example above, the first_name column has an accessor. Note that the value of the attribute is passed to the accessor.

Mutators are declared in a similar fashion:

Defining A Mutator

class User extends Eloquent {

	public function setFirstNameAttribute($value)
	{
		$this->attributes['first_name'] = strtolower($value);
	}

}

Date Mutators

By default, Eloquent will convert the created_at, updated_at, and deleted_at columns to instances of Carbon, which provides an assortment of helpful methods, and extends the native PHP DateTime class.

You may customize which fields are automatically mutated, and even completely disable this mutation, by overriding the getDates method of the model:

public function getDates()
{
	return array('created_at');
}

When a column is considered a date, you may set its value to a UNIX timetamp, date string (Y-m-d), date-time string, and of course a DateTime / Carbon instance.

To totally disable date mutations, simply return an empty array from the getDates method:

public function getDates()
{
	return array();
}

Model Events

Eloquent models fire several events, allowing you to hook into various points in the model's lifecycle using the following methods: creating, created, updating, updated, saving, saved, deleting, deleted. If false is returned from the creating, updating, or saving events, the action will be cancelled:

Cancelling Save Operations Via Events

User::creating(function($user)
{
	if ( ! $user->isValid()) return false;
});

Eloquent models also contain a static boot method, which may provide a convenient place to register your event bindings.

Setting A Model Boot Method

class User extends Eloquent {

	public static function boot()
	{
		parent::boot();

		// Setup event bindings...
	}

}

Model Observers

To consolidate the handling of model events, you may register a model observer. An observer class may have methods that correspond to the various model events. For example, creating, updating, saving methods may be on an observer, in addition to any other model event name.

So, for example, a model observer might look like this:

class UserObserver {

	public function saving($model)
	{
		//
	}

	public function saved($model)
	{
		//
	}

}

You may register an observer instance using the observe method:

User::observe(new UserObserver);

Converting To Arrays / JSON

When building JSON APIs, you may often need to convert your models and relationships to arrays or JSON. So, Eloquent includes methods for doing so. To convert a model and its loaded relationship to an array, you may use the toArray method:

Converting A Model To An Array

$user = User::with('roles')->first();

return $user->toArray();

Note that entire collections of models may also be converted to arrays:

return User::all()->toArray();

To convert a model to JSON, you may use the toJson method:

Converting A Model To JSON

return User::find(1)->toJson();

Note that when a model or collection is cast to a string, it will be converted to JSON, meaning you can return Eloquent objects directly from your application's routes!

Returning A Model From A Route

Route::get('users', function()
{
	return User::all();
});

Sometimes you may wish to limit the attributes that are included in your model's array or JSON form, such as passwords. To do so, add a hidden property definition to your model:

Hiding Attributes From Array Or JSON Conversion

class User extends Eloquent {

	protected $hidden = array('password');

}

Alternatively, you may use the visible property to define a white-list:

protected $visible = array('first_name', 'last_name');

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

eloquent.md

eloquent.md

Eloquent ORM

Introduction

Basic Usage

Mass Assignment

Insert, Update, Delete

Soft Deleting

Timestamps

Query Scopes

Relationships

One To One

One To Many

Many To Many

Polymorphic Relations

Querying Relations

Dynamic Properties

Eager Loading

Eager Load Constraints

Lazy Eager Loading

Inserting Related Models

Associating Models (Belongs To)

Inserting Related Models (Many To Many)

Touching Parent Timestamps

Working With Pivot Tables

Collections

Accessors & Mutators

Date Mutators

Model Events

Model Observers

Converting To Arrays / JSON

Files

eloquent.md

Latest commit

History

eloquent.md

File metadata and controls

Eloquent ORM

Introduction

Basic Usage

Mass Assignment

Insert, Update, Delete

Soft Deleting

Timestamps

Query Scopes

Relationships

One To One

One To Many

Many To Many

Polymorphic Relations

Querying Relations

Dynamic Properties

Eager Loading

Eager Load Constraints

Lazy Eager Loading

Inserting Related Models

Associating Models (Belongs To)

Inserting Related Models (Many To Many)

Touching Parent Timestamps

Working With Pivot Tables

Collections

Accessors & Mutators

Date Mutators

Model Events

Model Observers

Converting To Arrays / JSON