Skip to content

Getting started

Installation

composer require formal/orm

Setup

use Formal\ORM\Manager;
use Innmind\Filesystem\Adapter\InMemory;

$orm = Manager::filesystem(InMemory::emulateFilesystem());

use Formal\ORM\Manager;
use Innmind\Filesystem\Adapter\Filesystem;
use Innmind\Url\Path;

$orm = Manager::filesystem(Filesystem::mount(Path::of('some/directory/')));

In the rest of this documentation the variable $orm will reference this Manager object.

While you learn how to use this ORM the filesystem storage is enough, you'll learn later on how to use other adapters. As the examples names suggest one is ephemeral meaning nothing is persisted to the filesystem allowing you to run your code without side effects. On the other hand the persistent storage will store the data to your filesystem and you'll need to delete the data when the aggregate class will change.