README

Active Record ORM for the Forjix framework with relationships support.

Installation

composer require forjix/orm

Defining Models

use Forjix\Orm\Model;

class User extends Model
{
    protected string $table = 'users';

    protected array $fillable = ['name', 'email'];

    protected array $hidden = ['password'];
}

Basic Operations

// Create
$user = User::create([
    'name' => 'John',
    'email' => 'john@example.com',
]);

// Find
$user = User::find(1);
$user = User::findOrFail(1);

// Query
$users = User::where('active', true)
    ->orderBy('name')
    ->get();

// Update
$user->name = 'Jane';
$user->save();

// Delete
$user->delete();

Relationships

Has One

class User extends Model
{
    public function profile(): HasOne
    {
        return $this->hasOne(Profile::class);
    }
}

Has Many

class User extends Model
{
    public function posts(): HasMany
    {
        return $this->hasMany(Post::class);
    }
}

Belongs To

class Post extends Model
{
    public function user(): BelongsTo
    {
        return $this->belongsTo(User::class);
    }
}

Belongs To Many

class User extends Model
{
    public function roles(): BelongsToMany
    {
        return $this->belongsToMany(Role::class);
    }
}

Eager Loading

$users = User::with('posts', 'profile')->get();

License

GPL-3.0