README

Piko Db Record is a lightweight Active Record implementation built on top of PDO.

It has been tested with:

• SQLite
• MySQL
• PostgreSQL
• MSSQL

Installation

It is recommended to install Piko Db Record with Composer:

composer require piko/db-record

Documentation

https://piko-framework.github.io/docs/db-record.html

Usage

First, ensure autoloading is available:

require 'vendor/autoload.php';

Define your model (attributes)

use Piko\DbRecord;
use Piko\DbRecord\Attribute\Table;
use Piko\DbRecord\Attribute\Column;

#[Table(name: 'contact')]
class Contact extends DbRecord
{
    #[Column(primaryKey: true)]
    public ?int $id = null;

    #[Column]
    public ?string $firstname = null;

    #[Column]
    public ?string $lastname = null;

    #[Column]
    public ?bool $active = false;
}

Optional: map DB columns to different PHP property names

use Piko\DbRecord;
use Piko\DbRecord\Attribute\Table;
use Piko\DbRecord\Attribute\Column;

#[Table(name: 'contact')]
class ContactMapped extends DbRecord
{
    #[Column(name: 'id', primaryKey: true)]
    public ?int $contactId = null;

    #[Column(name: 'firstname')]
    public ?string $firstName = null;

    #[Column(name: 'lastname')]
    public ?string $lastName = null;

    #[Column(name: 'active')]
    public ?bool $isActive = false;
}

You can then use either mapped property names ($contact->firstName) or underlying column names ($contact->firstname).

Optional: custom cast types (float, decimal, datetime_immutable, datetime_mutable, json)

use DateTimeImmutable;
use Piko\DbRecord;
use Piko\DbRecord\Attribute\Table;
use Piko\DbRecord\Attribute\Column;

#[Table(name: 'contact')]
class ContactAdvancedTypes extends DbRecord
{
    #[Column(primaryKey: true)]
    public ?int $id = null;

    #[Column(type: 'float')]
    public ?float $income = null;

    #[Column(name: 'name', type: 'json')]
    public ?array $nameData = null;

    #[Column(name: 'lastname', type: 'datetime_immutable')]
    public ?DateTimeImmutable $lastSeenAt = null;

    #[Column(name: 'firstname', type: 'decimal', scale: 4)]
    public ?string $balance = null;
}

• float values are cast to PHP float.
• decimal values are normalized as strings. With scale, values are rounded/formatted to that precision.
• datetime_immutable values are cast to DateTimeImmutable.
• datetime_mutable values are cast to DateTime.
• json values are stored as JSON strings and exposed as PHP arrays.

datetime remains supported as an alias of datetime_immutable for backward compatibility.

Optional: legacy/manual schema (including string primary keys)

use Piko\DbRecord;

class ContactStringPk extends DbRecord
{
    protected string $tableName = 'contact';
    protected string $primaryKey = 'firstname';

    protected array $schema = [
        'firstname' => self::TYPE_STRING,
        'lastname'  => self::TYPE_STRING,
    ];
}

With non-integer primary keys, set the key before save() when creating a new row:

$contact = new ContactStringPk($db);
$contact->firstname = 'pk_insert';
$contact->lastname = 'Doe';
$contact->save(); // INSERT with provided primary key

Setup database connection

Create a PDO instance and initialize schema:

$db = new PDO('sqlite::memory:');
$db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);

$query = <<<SQL
CREATE TABLE contact (
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  firstname TEXT,
  lastname TEXT,
  active INTEGER DEFAULT 0
)
SQL;

$db->exec($query);

Recommended: always enable PDO::ATTR_ERRMODE = PDO::ERRMODE_EXCEPTION. DbRecord throws explicit contextual exceptions when SQL operations fail (PersistenceException for SQL execution, SchemaException for mapping/schema issues, RecordNotFoundException for missing rows). Exception mode still gives the clearest SQL diagnostics.

Perform CRUD operations

Create

Create a new record and save it to the database:

$contact = new Contact($db);
$contact->firstname = 'John';
$contact->lastname = 'Doe';
$contact->active = true;
$contact->save();

echo "Contact id: {$contact->id}"; // Contact id : 1

Read

$contact = (new Contact($db))->load(1);

var_dump($contact->firstname); // John

$exists = (new Contact($db))->exists(1); // true

Update

$contact->lastname = 'Doe Jr.';
$contact->save();

Delete

$contact->delete();

Known limitations

• Composite primary keys are not supported.
• save() updates all mapped columns (no dirty-field tracking yet).
• For auto-increment integer primary keys, inserted IDs are filled from PDO::lastInsertId() when available.
• For non-integer (e.g. string) primary keys, your application typically provides the key value.
• save() performs an INSERT when the primary key is null or does not exist in database yet; otherwise it performs an UPDATE.

Running tests

Run full checks (all database targets + coding standards + static analysis):

composer tests

Run tests for one database only:

composer phpunit:sqlite
composer phpunit:mysql
composer phpunit:pgsql
composer phpunit:mssql

Support

If you encounter issues or have questions, feel free to open an issue on GitHub.