README

Sumire is a small PDO Mapper for PHP 8.2+.

It keeps the runtime surface intentionally small: PDO handles the database connection, PHP attributes describe your entities, and Sumire provides a light persistence and repository layer on top.

use Sumire\Database;

$database = Database::connect(new PDO('sqlite::memory:'));
$database->persist($user);

$found = $database->repository(User::class)->find(1);

Documentation

The main documentation lives in the GitHub Wiki:

• Overview
• Getting Started
• Entity Mapping
• Database API
• Repository API
• Connection API
• Examples
• Database Notes
• Development

The Wiki source is mirrored in docs/wiki so changes can be reviewed through pull requests.

Installation

composer require wind111-lang/sumire

Requirements

• PHP 8.2+
• ext-pdo
• One PDO driver for your database:
  • SQLite: pdo_sqlite
  • MySQL: pdo_mysql
  • PostgreSQL: pdo_pgsql

Development

composer dump-autoload
composer ci

For the full local workflow, see Development.