models.md

Working with Models

A model in WabiORM is any plain class. By default, the framework infers the information about how to related the class to the database, but you can add annotations to instruct it, too.

/**
 * By default, the framework will infer this classes records will be in a
 * `posts` table with an `id` column.
 */ 
class Post {

}

class MyModel {
    /**
     * This tells the framework that the primary key for the model is something
     * other than `id`.
     */
    public function withPrimaryKey(): string {
        return 'guid';
    }

    /**
     * This tells the framework to look for MyModel instances in
     * `a_custom_table`.
     */
    public function withTableName(): string {
        return 'a_custom_table';
    }
}

Because any plain class can work with the framework, any methods and properties will still work. Because this wraps PDO, any public properties will be hydrated for you automatically, although you don't need to define them before use.

Persistence

WabiORM comes with some basic helpers for persisting data:

use function WabiORM\{create, delete, update};

$newPost = new Post();
$newPost->title = 'This is my title';

$newPost->id = create($newPost);
$newPost->description = 'This is some content!';
update($newPost);

delete($newPost);

Note: you can use save() to either create or update, based on whether the primary key of the model is null.

Selecting records

As noted in the documentation on queries, WabiORM does not ship with a query builder. However, it does provide a mechanism for writing queries with the intention that users can write specific handlers.

use function WabiORM\read;

class Letter {
    public $id;

    public $is_pending;
}

function find_pending_letters(): array {
    // The query will be parsed by q().
    // The 'table' parameter will be automatically available to us.
    return read(
        Letter::class, 'select * from {*table} where is_pending = true'
    );
}

The goal of this is to allow for very specific functions which return specific data. It fits with some of the ideas with functional programming.