Models

Model files live in app/Models under the App\Models namespace. They extend the base Model class which wraps the database driver.

Basic Model

Define the table your model works with.

<?php
namespace App\Models;

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

The primary column defaults to id. Override it if your table uses a different one.

protected $primaryColumn = 'uuid';

Reading Records

// Get all users
$users = User::all();

// Get a user by primary key
$user = User::orm()->find($id);

The ORM Instance

User::orm() returns a table instance for the users table. Everything from the database driver is available on it.

User::orm()->where('name', '%Hadi%', 'LIKE')->get();

User::orm()->insert([
    'name' => 'John doe',
    'email' => 'john@email.com',
]);

User::orm()->update(
    ['name' => 'Habib Hadi'],
    ['id' => 1]
);

User::orm()->delete(['id' => 4]);

The Raw Connection

User::raw() returns the database connection itself. Use it for raw queries or other tables, see Database for the full API.

$users = User::raw()->query("SELECT * FROM users")->get();

Database Configuration

The connection is read from the database key in config/config.php. Set it to null if you do not need a database.

"database" => [
    "host" => "localhost",
    "name" => "roolith_cms",
    "user" => "root",
    "pass" => "",
],

Generating Models

php roolith generate model Product

See Generator.