Introduction
Eloquent ORM is a powerful Object-Relational Mapper designed for Laravel, but what if you want to use it without the full Laravel framework? Luckily, Eloquent can be implemented as a standalone package. In this tutorial, we’ll explore how to use Eloquent outside of Laravel with plenty of code examples.
Setting up the Environment
To begin using Eloquent by itself, you need to create a new project and set up Composer. If you don’t have Composer installed, see one of the following articles:
- How to set up PHP Composer in Windows
- How to Set Up PHP Composer in MacOS
- How to set up and configure PHP Composer in Ubuntu
Set up example project:
mkdir eloquent_standalone
cd eloquent_standalone
composer init
Next, add Eloquent as a dependency:
composer require illuminate/database
Once installed, bootstrap Eloquent:
use Illuminate\Database\Capsule\Manager as Capsule;
$capsule = new Capsule;
$capsule->addConnection([
'driver' => 'mysql',
'host' => 'localhost',
'database' => 'your_database',
'username' => 'your_username',
'password' => 'your_password',
'charset' => 'utf8',
'collation' => 'utf8_unicode_ci',
'prefix' => '',
]);
$capsule->bootEloquent();
Defining Models
With Eloquent bootstrapped, define models that extend Illuminate\Database\Eloquent\Model:
use Illuminate\Database\Eloquent\Model;
class User extends Model {}
class Post extends Model {}
These models will automatically map to the tables users and posts in the database.
Basic Operations
Creating Records
$user = new User();
$user->name = 'John Doe';
$user->email = '[email protected]';
$user->save();
// Output
echo $user->id; // The ID of the newly created user
Reading Records
$users = User::where('name', 'John Doe')->get();
// Output
foreach ($users as $user) {
echo $user->email;
}
Updating Records
$user = User::find(1);
$user->email = '[email protected]';
$user->save();
Deleting Records
$user = User::find(1);
$user->delete();
Advanced Features
Relationships
Define relationships directly within your models:
class Post extends Model {
public function user() {
return $this->belongsTo('User');
}
}
Use relationships to retrieve related records:
$post = Post::find(1);
$user = $post->user;
// Output
echo $user->name;
Mass Assignment
Using the create method:
User::create(['name' => 'Jane Doe', 'email' => '[email protected]']);
Accessors & Mutators
To automatically apply formatting to model attributes use accessors and mutators:
class User extends Model {
public function getNameAttribute($value) {
return ucfirst($value);
}
public function setNameAttribute($value) {
$this->attributes['name'] = strtolower($value);
}
}
In the example above, the user’s name is stored in lowercase but retrieved with the first letter capitalized.
Conclusion
As demonstrated, Eloquent can be a versatile ORM even outside Laravel. With these foundations, you can integrate it within other projects or micro-frameworks, taking advantage of its expressive syntax and powerful features.
