flames is an Event Driven ORM for PHP based on Django and built with xpspl.

Currently flames supports only MySQL.

Download zip from master.

Include in configuration.

<?php

require_once 'flames/src/flames.php'

This quick introduction will get you up and running!

Before you begin make sure you have installed flames and have a MySQL database ready to use.

Add a connection to flames using the flames\Connections::add method, providing a valid flames driver.

Here we create a flames\driver\MySQL driver just as you would a PDO connection.

<?php
$db = new flames\driver\MySQL(
    'mysql:dbname=DBNAME;host=localhost;port=3306', 
    'username', 
    'password'
);
// Tell flames about the connection, this will also set it as the default
flames\Connections::add($db);

Models are created by extending the flames\Model class.

Here we will create a simple User model with the fields of username and password.

<?php
class User extends flames\Model {
    public $username = ['char'];
    public $password = ['password'];
}

Note the use of the password field for later.

You can now tell flames to create this table for you automatically by using the create_table method.

<?php
$user = new User();
$user->create_table();

This results in the following SQL:

CREATE TABLE `user` (
  `user_id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `username` varchar(225) DEFAULT NULL,
  `password` varchar(75) DEFAULT NULL,
  PRIMARY KEY (`user_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

Notice the user_id, flames will automatically add primary key columns for your models if one is not detected using the model name with _id appended.

Insert a new record by creating a new model object, set it's property and call the save() method.

<?php
$user = new User();
$user->username = 'xpspl';
$user->password = 'myPa$$word';
$user->save()->exec();
// We now have an id
echo $user->user_id;

This results in the following SQL: ( broken for sanity )

INSERT INTO user 
( `username`, `password` ) 
VALUES 
( "xpspl", "9353be3c53a16e869ab988db92f8ee1d3ef0287b" )

Notice the password field is hashed?

flames will automatically hash this field ( by default using sha1 ) when talking to the database.

Also note the call to exec that must be called to execute the query.

Now that we have a record in the database let's select it.

<?php
$user = User::find([
    'username' => 'xpspl',
    'password' => 'myPa$$word'
])->first();
echo "Hello, ".$user->username;

This results in the following SQL: ( broken for sanity )

SELECT `user_id`, `username`, `password` 
FROM user 
WHERE 
`username` = "xpspl" 
AND 
`password` = "9353be3c53a16e869ab988db92f8ee1d3ef0287b"

Notice the automatically hashed password?

The return is a flames\query\results\Wrapper we chained the result selecting the first record using the first() method, you can also count(), use foreach iteration and use direct array indexing $record[0] on a Wrapper.

Updating records is performed simply by calling the save() method on a found model result.

<?php
$user = User::find([
    'username' => 'xpspl',
    'password' => 'myPa$$word'
])->first();
// Set their username to "pigface"
$user->username = "pigface";
$user->save()->exec();

This results in the following SQL:

UPDATE user SET `username` = "xpspl" WHERE `user_id` = 1

Notice we only updated the user field, flames will only update fields that have changed since retrieval.

Deleting a record is identical to that of updating only you call the delete() method on the found result.

<?php
$user = User::find([
    'username' => 'xpspl',
    'password' => 'myPa$$word'
])->first();
$user->delete()->exec();

This results in the following SQL:

DELETE FROM user WHERE `user_id` = 1