ez-php/orm

ORM module for the ez-php framework — Active Record style models with a fluent query builder and schema builder

1.3.0 2026-03-29 22:47 UTC

Requires

• php: ^8.5
• ez-php/cache: ^1.0
• ez-php/console: ^1.0
• ez-php/contracts: ^1.0

Requires (Dev)

• ez-php/docker: ^1.0
• ez-php/testing-application: ^1.0
• friendsofphp/php-cs-fixer: ^3.94
• phpstan/phpstan: ^2.1
• phpstan/phpstan-deprecation-rules: ^2.0
• phpstan/phpstan-strict-rules: ^2.0
• phpunit/phpunit: ^13.0

MIT

• Andreas Uretschnig

• framework
• database
• orm
• php
• active-record
• query-builder
• schema-builder
• ez-php

README

ORM module for the ez-php framework — Active Record style models with a fluent query builder and schema builder.

Requirements

• PHP 8.5+
• ext-pdo
• ez-php/framework 0.*

Installation

composer require ez-php/orm

Setup

Register the service provider:

$app->register(\EzPhp\Orm\ModelServiceProvider::class);
$app->register(\EzPhp\Orm\Schema\SchemaServiceProvider::class);

Usage

Defining a model

use EzPhp\Orm\Model;

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

Querying

$user  = User::find(1);
$users = User::where('active', true)->orderBy('name')->get();
$count = User::count();

Persisting

$user = new User(['name' => 'Alice', 'email' => '[e-mail]']);
$user->save();

$user->name = 'Bob';
$user->save();

$user->delete();

Soft deletes

Enable soft deletes by setting $softDeletes = true on the model and adding a deleted_at column to the table:

class Post extends Model
{
    protected static string $table = 'posts';
    protected static bool $softDeletes = true;
}

Schema::create('posts', function (Blueprint $table) {
    $table->id();
    $table->string('title');
    $table->timestamps();
    $table->timestamp('deleted_at')->nullable();
});

delete() now sets deleted_at to the current timestamp instead of removing the row. All standard queries (query(), where(), all(), find()) automatically add WHERE deleted_at IS NULL, so soft-deleted rows are invisible by default.

$post->delete();        // sets deleted_at — row stays in the DB
$post->isDeleted();     // true

$post->restore();       // clears deleted_at — row is visible again
$post->forceDelete();   // hard-deletes regardless of $softDeletes

To include soft-deleted rows in a query:

Post::withTrashed()->where('user_id', 42)->get();  // all rows, deleted or not
Post::onlyTrashed()->get();                         // only soft-deleted rows

Relations

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

$post->author; // lazy-loaded User

Schema builder

Schema::create('users', function (Blueprint $table) {
    $table->id();
    $table->string('name');
    $table->string('email')->unique();
    $table->timestamps();
});

License

MIT — Andreas Uretschnig