README

micro activerecord library in PHP(only 400 lines with comments), support chain calls and relations(HAS_ONE, HAS_MANY, BELONGS_TO).

中文版.

Documentation

API Reference

CRUD functions

setDb(\PDO $db)

set the DB connection.

ActiveRecord::setDb(new PDO('sqlite:test.db'));

insert() : boolean|\ActiveRecord

function to build insert SQL, and insert current record into database. if insert success return current object, other wise return false.

$user = new User();
$user->name = 'demo';
$user->password = md5('demo');
$user->insert();

find(integer $id = null) : boolean|\ActiveRecord

function to find one record and assign in to current object. If call this function using $id param, will find record by using this id. If not set, just find the first record in database. if find record, assign in to current object and return it, other wise return "false".

$user->notnull('id')->orderby('id desc')->find();

findAll() : array

function to find all records in database. return array of ActiveRecord

$user->findAll();

update() : boolean|\ActiveRecord

function to build update SQL, and update current record in database, just write the dirty data into database. if update success return current object, other wise return false.

$user->notnull('id')->orderby('id desc')->find();
$user->email = 'test@example.com';
$user->update();

delete() : boolean

function to delete current record in database.

reset() : \ActiveRecord

function to reset the $params and $sqlExpressions. return $this, can using chain method calls.

dirty(array $dirty = array()) : \ActiveRecord

function to SET or RESET the dirty data. The dirty data will be set, or empty array to reset the dirty data.

SQL part functions

select()

function to set the select columns.

$user->select('id', 'name')->find();

from()

function to set the table to find record

$user->select('id', 'name')->from('user')->find();

join()

function to set the table to find record

$user->join('contact', 'contact.user_id = user.id')->find();

where()

function to set where conditions

$user->where('id=1 AND name="demo"')->find();

group()/groupby()

$user->select('count(1) as count')->groupby('name')->findAll();

order()/orderby()

$user->orderby('name DESC')->find();

limit()

$user->orderby('name DESC')->limit(0, 1)->find();

WHERE conditions

equal()/eq()

$user->eq('id', 1)->find();

notequal()/ne()

$user->ne('id', 1)->find();

greaterthan()/gt()

$user->gt('id', 1)->find();

lessthan()/lt()

$user->lt('id', 1)->find();

greaterthanorequal()/ge()/gte()

$user->ge('id', 1)->find();

lessthanorequal()/le()/lte()

$user->le('id', 1)->find();

like()

$user->like('name', 'de')->find();

in()

$user->in('id', [1, 2])->find();

notin()

$user->notin('id', [1,3])->find();

isnull()

$user->isnull('id')->find();

isnotnull()/notnull()

$user->isnotnull('id')->find();

Install

composer require bephp/activerecord

There's one Blog demo, work with Router and MicoTpl.

Demo

Include base class ActiveRecord

include "ActiveRecord.php";

Define Class

class User extends ActiveRecord{
	public $table = 'user';
	public $primaryKey = 'id';
	public $relations = array(
		'contacts' => array(self::HAS_MANY, 'Contact', 'user_id'),
		'contact' => array(self::HAS_ONE, 'Contact', 'user_id'),
	);
}
class Contact extends ActiveRecord{
	public $table = 'contact';
	public $primaryKey = 'id';
	public $relations = array(
		'user' => array(self::BELONGS_TO, 'User', 'user_id'),
		'user_with_backref' => array(self::BELONGS_TO, 'User', 'user_id', array(), 'contact'),
        // using 5th param to define backref
	);
}

Init data

ActiveRecord::setDb(new PDO('sqlite:test.db'));
ActiveRecord::execute("CREATE TABLE IF NOT EXISTS user (
                                id INTEGER PRIMARY KEY, 
                                name TEXT, 
                                password TEXT 
                        );");
ActiveRecord::execute("CREATE TABLE IF NOT EXISTS contact (
                                id INTEGER PRIMARY KEY, 
                                user_id INTEGER, 
                                email TEXT,
                                address TEXT
                        );");

Insert one User into database.

$user = new User();
$user->name = 'demo';
$user->password = md5('demo');
var_dump($user->insert());

Insert one Contact belongs the current user.

$contact = new Contact();
$contact->address = 'test';
$contact->email = 'test1234456@domain.com';
$contact->user_id = $user->id;
var_dump($contact->insert());

Example to using relations

$user = new User();
// find one user
var_dump($user->notnull('id')->orderby('id desc')->find());
echo "\nContact of User # {$user->id}\n";
// get contacts by using relation:
//   'contacts' => array(self::HAS_MANY, 'Contact', 'user_id'),
var_dump($user->contacts);

$contact = new Contact();
// find one contact
var_dump($contact->find());
// get user by using relation:
//    'user' => array(self::BELONGS_TO, 'User', 'user_id'),
var_dump($contact->user);

lloydzhou / activerecord

Maintainers

Details