Sloth Framework - Orm - Model Overview

Assume we have models defined in Defining Models

Retrieving A Record By Primary Key

    $user = User::first(1);
    echo $user->name;

Retrieving A Record By Conditions

    $user = User::first('email = ?', 'user@example.com');

By the convention, the Model property name is processed by camelCase. For example, if the users table has column created_time. To get the created_time value through model, you should use: $user->createdTime

Retrieving Multiple Records AKA Collection

    $users = User::all();

Retrieving Multiple Records By Primary Key List

    $users = User::all([1, 2, 3]);

Retrieving Multiple Records By Conditions

    $users = User::all(['status = ?' => 1]);
    // or
    $users = User::all()->where('status = ?', 1);

Almost all sql Select method is visible in Collection: select, distinct, calcFoundRows, where, orWhere, having, orHaving, orderBy, groupBy, limit, offset, join, leftJoin, rightJoin,

Sql querying in Collection is Lazy, it mean there are no query is executed until you interacting with the collection data. So you could adding more query filter to the collection later.

    $users = User::all(); // no sql query executing here
    $users->where('status = ?', 1); // no sql query executing here too
    $users->toArray(); // That is! The query executed is: SELECT users.* FROM users WHERE (status = 1)

The Model Collection class is implemented of Countable, IteratorAggregate, JsonSerializable, ArrayAccess. So you could counting, iterate, encode as json or interacting it as array style.

    $users = User::all();

    // Counting
    count($users);

    // json encoding
    json_encode($users);

    // iterate
    foreach ($users as $user) {
        echo $user->name;
    }

    // interacting as array
    $user = $users[0];