Windwalker Record is a simple ActiveRecord to operate database row.

New a instance.

use Windwalker\Record\Record;

// Record object for users table
$user = new Record('users');

Or create a class:

use Windwalker\Record\Record;

class UserRecord extends Record
    protected $table = 'users';

$user = new UserRecord;

Load A Record

$user->load(25); // Load by primary key

$user->load(array('alias' => $alias)); // Load by field name.

Check row exists

if (!$user->load(25))
    throw new RuntuneException('User not found');

Bind Data

$data = array(
    'name'     => 'Sakura',
    'username' => 'sakura',
    'alias'    => 'sakura',
    'password' => '1234',
    'desc'     => 'foo bar.'


$user->name; // Sakura

If we have a table with only 3 columns:


The fields which not in this table will be remove after binding data.

$user->alias; // null

That makes our fields in Record will always same as DB table.


Create A New Row

If primary not exists, Record will create a new row in table.

$data = array(
    'name'     => 'Sakura',
    'username' => 'sakura',
    'password' => '1234'



echo $user->id; // Auto generated id
Update A Existing Row

If primary key exists, Record will update it.

$data = array(
    'id'       => 30,
    'name'     => 'Sakura',
    'username' => 'sakura',
    'password' => '1234'




Check method help you validate data.

class UserRecord extends Record
    // ...

    public function check()
        if (!$this['name'])
            throw new InvalidArgumentException('Name empty.');

        return true;

Then we call check() before store().





$result = $user->delete(); // boolean

// OR delete by conditions

$result = $user->delete(30); // boolean
$result = $user->delete(array('username' => $username)); // boolean


NestedRecord is a tool help us handle Nested Set Model.

Create Table

Name: categories

Name Type Description Need For NestedRecord
id int Primary Key
parent_id int ID of Parent Node V
title varchar Category title
path varchar Node path V
lft int Left key V
rgt int Right key V
level int Node level V


Every nested set should have a root node.

$cat = new NestedRecord('categories');


NOTE: The root node id is 1.

Create Node

Set as first child of ROOT

    ->setLocation(1, NestedRecord::LOCATION_FIRST_CHILD)

Now we will have a new node and it id is 2. Create a new node as last child of 2.

    ->setLocation(2, NestedRecord::LOCATION_LAST_CHILD)

Available positions:


Move Node

Re Ordering
$cat->move(1); // move up
$cat->move(-1); // Move down
Move To Other Node

Move to node 3 as last child.

$cat->moveByReference(3, NestedRecord::LOCATION_LAST_CHILD);


If a tree was not correct, using rebuild to reset all lft, rgt of this branch.

$cat->rebuild(); // Rebuild node: 5 and it's children.


Method to get an array of nodes from a given node to its root.

$path = $cat->getPath();


Method to get a node and all its child nodes.

$records = $cat->getTree();


Record object supports hooks to add logic before or after any data operation.

class ArticleRecord extends Record
    protected $table = 'articles';

    public function onAfterLoad(Event $event)
        // Also load tags
        $this->tags = TagHelper::getAllTags();

Available events:

  • onBeforeLoad
  • onAfterLoad
  • onBeforeStore
  • onAfterStore
  • onBeforeDelete
  • onAfterDelete

See Events

If you found a typo or error, please help us improve this document.