README

LazyRecord is an open-source Object-Relational Mapping (ORM) for PHP5.

LazyRecord uses code generator to generate static code, which reduces runtime costs, therefore it's pretty lightweight and fast.

It allows you to access your database very easily by using ActiveRecord pattern API.

LazyRecord is not like PropelORM, it doesn't use ugly XML as its schema or config file, LazyRecord uses simpler YAML format config file and it compiles YAML to pure PHP code to improve the performance of config loading.

With the simple schema design, you can define your model schema very easily and you can even embed closure in your schema classes.

Automatic Migration Demonstration

Feature

Fast & Simple
Configuration based on YAML format and compiled into PHP
PDO, MySQL, Pgsql, SQLite support.
Multiple data sources.
Mix-in model.
Powerful Migration Generator
- Upgrade & Downgrade of course.
- Automatic Migration: generate migration SQL automatically based on the schema diff.
Schema/Database diff

Design Concept

Function calls in PHP are very slow, so the model schema data will be built statically, LazyRecord converts all definitions (default value, validator, filter, valid value builder) into classes and static PHP array, this keeps these model classes very lightweight and fast.
In the runtime, all the same model objects use the same schema object, and we can reuse the prebuild data from the static schema class.
We keep base model class constructor empty, so when you are querying data from database, these model objects can be created with zero effort.

Installation

Please see the details on Wiki

Getting Started

Configuring Database

Change directory to your project, run init command to initialize your database settings.

composer require corneltek/lazyrecord "^3"

If you prefer something new, you can require "dev-master"

composer require corneltek/lazyrecord "dev-master"

Then create your config file:

$ vim db/config/database.yml

Suppose your application code is located in src/ directory, then you should provide your schema path in following format:

---
bootstrap:
- vendor/autoload.php   # load the classloader from composer.
schema:
  auto_id: 1
  paths:
    - src/    # where you store the schema class files.
data_sources:
  default: master
  nodes:
    master:
      dsn: 'sqlite:test'

In the above config file, the auto_id means an id column with auto-increment integer primary key is automatically inserted into every schema class, so you don't need to declare an primary key id column in your every schema file.

Writing Model Schema

Next, write your model schema file:

$ vim src/YourApp/Model/UserSchema.php

Put the content into your file:

namespace YourApp\Model;
use LazyRecord\Schema;

class UserSchema extends Schema
{
    public function schema()
    {
        $this->column('account')
            ->varchar(16);
        $this->column('password')
            ->varchar(40)
            ->filter('sha1');
    }
}

Building Static Schema Files

Then run build-schema command to build static schema files:

$ vendor/bin/lazy lazy schema build
Finding schemas...
Found schema classes
Initializing schema generator...
    YourApp\Model\UserSchemaProxy    => src/YourApp/Model/UserSchemaProxy.php
    YourApp\Model\UserCollectionBase => src/YourApp/Model/UserCollectionBase.php
    YourApp\Model\UserCollection     => src/YourApp/Model/UserCollection.php
    YourApp\Model\UserBase           => src/YourApp/Model/UserBase.php
    YourApp\Model\User               => src/YourApp/Model/User.php
Done

Creating Database

If you are using postgresql or mysql, you can create your database with create-db command:

$ php vendor/bin/lazy db create

Building SQL From Model Schemas

Now you need to build SQL schema into your database, simply run build-sql, -d is for debug mode, which prints all generated SQL statements:

$ php vendor/bin/lazy sql
Finding schema classes...
Initialize schema builder...
Building SQL for YourApp\Model\UserSchema
DROP TABLE IF EXISTS users;
CREATE TABLE users ( 
  account varchar(16),
  password varchar(40)
);

Setting migration timestamp to 1347439779
Done. 1 schema tables were generated into data source 'default'.

Writing Application Code

Now you can write your application code, But first you need to write your lazyrecord config loader code:

$ vim app.php

require 'vendor/autoload.php';
$config = new LazyRecord\ConfigLoader;
$config->load( __DIR__ . '/db/config/database.yml');
$config->init();

The init method initializes data sources to ConnectionManager, but it won't create connection unless you need to operate your models.

Sample Code Of Operating The User Model Object

Now append your application code to the end of app.php file:

$user = new YourApp\Model\User;
$ret = $user->create(array('account' => 'guest', 'password' => '123123' ));
if ($ret->error ) {
    echo $ret->message;  // get the error message
    if ($ret->exception) {
        echo $ret->exception;  // get the exception object
    }
    echo $ret; // __toString() is supported
}

Please check doc/ directory for more details.

Basic Usage

Model Accessor

LazyRecord's BaseModel class provides a simple way to retrieve result data from the __get magic method, by using the magic method, you can retrieve the column value and objects from relationship.

$record = new MyApp\Model\User( 1 );   // select * from users where id = 1;
$record->name;    // get "users.name" and inflate it.

The __get method is dispatching to get method, if you don't want to use the magic method,

$record->get('name');

The magic method calls value inflator, which can help you inflate values like DateTime objects, it might be slower, if you want performance, you can simply do:

$record->getValue('name');

BaseModel also supports iterating, so you can iterate the data values with foreach:

foreach( $record as $column => $rawValue ) {

}

Model Operation

To create a model record:

$author = new Author;
$ret = $author->create(array(
    'name' => 'Foo'
));
if ( $ret->success ) {
    echo 'created';
}

To find record:

$ret = $author->load(123);
$ret = $author->load(array( 'foo' => 'Name' ));
if ( $ret->success ) {

} else {
    // handle $ret->exception or $ret->message
}

To find record with (static):

$record = Author::load(array( 'name' => 'Foo' ));

To find record with primary key:

$record = Author::load( 1 );

To update record:

$author->update(array(  
    'name' => 'Author',
));

To update record (static):

$ret = Author::update( array( 'name' => 'Author' ) )
    ->where()
        ->equal('id',3)
        ->execute();

if( $ret->success ) {
    echo $ret->message;
}
else {
    // pretty print error message, exception and validation errors for console
    echo $ret;

    $e = $ret->exception; // get exception
    $validations = $ret->validations; // get validation results
}

Collection

To create a collection object:

$authors = new AuthorCollection;

To make a query (the Query syntax is powered by SQLBuilder):

$authors->where()
    ->equal( 'id' , 'foo' )
    ->like( 'content' , '%foo%' );

Or you can do:

$authors->where(array( 
    'name' => 'foo'
));

Iterating a Collection

$authors = new AuthorCollection;
foreach( $authors as $author ) {
    echo $author->name;
}

Model Schema

Defining Schema Class

Simply extend class from LazyRecord\Schema, and define your model columns in the schema method, e.g.,

<?php
namespace TestApp;
use LazyRecord\Schema;

class BookSchema extends Schema
{

    public function schema()
    {
        $this->column('title')
            ->unique()
            ->varchar(128);

        $this->column('subtitle')
            ->varchar(256);

        $this->column('isbn')
            ->varchar(128)
            ->immutable();

        $this->column('description')
            ->text();

        $this->column('view')
            ->default(0)
            ->integer();

        $this->column('publisher_id')
            ->isa('int')
            ->integer();

        $this->column('published_at')
            ->isa('DateTime')
            ->timestamp();

        $this->column('created_by')
            ->integer()
            ->refer('TestApp\UserSchema');


        // Defining trait for model class
        $this->addModelTrait('Uploader');
        $this->addModelTrait('Downloader')
            ->useInsteadOf('Downloader::a', 'Uploader');

        $this->belongsTo('created_by', 'TestApp\UserSchema','id', 'created_by');

        /** 
         * column: author => Author class 
         *
         * $book->publisher->name;
         *
         **/
        $this->belongsTo('publisher','\TestApp\PublisherSchema', 'id', 'publisher_id');

        /**
         * accessor , mapping self.id => BookAuthors.book_id
         *
         * link book => author_books
         */
        $this->many('book_authors', '\TestApp\AuthorBookSchema', 'book_id', 'id');


        /**
         * get BookAuthor.author 
         */
        $this->manyToMany( 'authors', 'book_authors', 'author' )
            ->filter(function($collection) { return $collection; });
    }
}

Defining Column Types

$this->column('foo')->integer();
$this->column('foo')->float();
$this->column('foo')->varchar(24);
$this->column('foo')->text();
$this->column('foo')->binary();

Text:

$this->column('name')->text();

Boolean:

$this->column('name') ->boolean();

Integer:

$this->column('name')->integer();

Timestamp:

$this->column('name')->timestamp();

Datetime:

$this->column('name')->datetime();

Defining Mixin Method

namespace LazyRecord\Schema\Mixin;
use LazyRecord\Schema\MixinDeclareSchema;

class MetadataMixinSchema extends MixinDeclareSchema
{
    public function schema()
    {
        // ... define your schema here
    }

    public function fooMethod($record, $arg1, $arg2, $arg3, $arg4)
    {
        // ...
        return ...;
    }
}

Then you can use the fooMethod on your model object:

$record = new FooModal;
$result = $record->fooMethod(1,2,3,4);

Defining Model Relationship

Belongs to

belongsTo(accessor_name, foreign_schema_class_name, foreign_schema_column_name, self_column_name = 'id')

$this->belongsTo( 'author' , '\TestApp\AuthorSchema', 'id' , 'author_id' );
$this->belongsTo( 'address' , '\TestApp\AddressSchema', 'address_id' );

Has One

one(accessor_name, self_column_name, foreign_schema_class_name, foreign_schema_column_name)

$this->one( 'author', 'author_id', '\TestApp\AuthorSchema' , 'id' );

Has Many

many(accessor_name, foreign_schema_class_name, foreign_schema_column_name, self_column_name )

$this->many( 'addresses', '\TestApp\AddressSchema', 'author_id', 'id');
$this->many( 'author_books', '\TestApp\AuthorBookSchema', 'author_id', 'id');

To define many to many relationship:

$this->manyToMany( 'books', 'author_books' , 'book' );

Usage:

// has many
$address = $author->addresses->create(array( 
    'address' => 'farfaraway'
));

$address->delete();

// create related address
$author->addresses[] = array( 'address' => 'Harvard' );

$addresses = $author->addresses->items();
is( 'Harvard' , $addresses[0]->address );

foreach( $author->addresses as $address ) {
    echo $address->address , "\n";
}

Do Some Preparation When Model Is Ready

If you want to do something after the schmea is created into a database, you can define a bootstrap method in your schema class:

namespace User;
class UserSchema extends LazyRecord\Schema { 
    public function schema() {
        // ...
    }
    public function bootstrap($model) {
        // do something you want
    }
}

The bootstrap method is triggerd when you run:

lazy sql

Using Multiple Data Source

You can define specific data source for different model in the model schema:

use LazyRecord\Schema;
class UserSchema extends Schema {
    public function schema() {
        $this->writeTo('master');
        $this->readFrom('slave');
    }
}

Or you can specify for both (read and write):

use LazyRecord\Schema;
class UserSchema extends Schema {
    public function schema() {
        $this->using('master');
    }
}

Defining BaseData Seed

The basedata seed script is executed after you run build-sql, which means all of your tables are ready in the database.

To define a basedata seed script:

namespace User;
class Seed { 
    public static function seed() {

    }
}

Then update your config file by adding the class name of the data seed class:

seeds:
  - User\Seed
  - System\Seed
  - System\TestingSeed

Migration

If you need to modify schema code, like adding new columns to a table, you can use the amazing migration feature to migrate your database to the latest change without pain.

Once you modified the schema code, you can execute lazy diff command to compare current exisiting database table:

$ lazy diff
+ table 'authors'            tests/tests/Author.php
+ table 'addresses'          tests/tests/Address.php
+ table 'author_books'       tests/tests/AuthorBook.php
+ table 'books'              tests/tests/Book.php
+ table 'users'              tests/tests/User.php
+ table 'publishers'         tests/tests/Publisher.php
+ table 'names'              tests/tests/Name.php
+ table 'wines'              tests/tests/Wine.php

As you can see, we added a lot of new tables (schemas), and LazyRecord parses the database tables to show you the difference to let you know current status.

Currently LazyRecord supports SQLite, PostgreSQL, MySQL table parsing.

now you can generate the migration script or upgrade database schema directly.

to upgrade database schema directly, you can simply run:

$ lazy migrate auto

to upgrade database schema through a customizable migration script, you can generate a new migration script like:

$ lazy migrate diff AddUserRoleColumn
Loading schema objects...
Creating migration script from diff
Found 10 schemas to compare.
    Found schema 'TestApp\AuthorSchema' to be imported to 'authors'
    Found schema 'TestApp\AddressSchema' to be imported to 'addresses'
    Found schema 'TestApp\AuthorBookSchema' to be imported to 'author_books'
    Found schema 'TestApp\BookSchema' to be imported to 'books'
    Found schema 'TestApp\UserSchema' to be imported to 'users'
    Found schema 'TestApp\PublisherSchema' to be imported to 'publishers'
    Found schema 'TestApp\NameSchema' to be imported to 'names'
    Found schema 'TestApp\Wine' to be imported to 'wines'
Migration script is generated: db/migrations/20120912_AddUserRoleColumn.php

now you can edit your migration script, which is auto-generated:

vim db/migrations/20120912_AddUserRoleColumn.php

the migration script looks like:

class AddUserColumn_1347451491  extends \LazyRecord\Migration\Migration {

    public function upgrade() { 
        $this->importSchema(new TestApp\AuthorSchema);
        $this->importSchema(new TestApp\AddressSchema);

        // To upgrade with new schema:
        $this->importSchema(new TestApp\AuthorBookSchema);
        
        // To create index:
        $this->createIndex($table,$indexName,$columnNames);
        
        // To drop index:
        $this->dropIndex($table,$indexName);
        
        // To add a foreign key:
        $this->addForeignKey($table,$columnName,$referenceTable,$referenceColumn = null) 
        
        // To drop table:
        $this->dropTable('authors');
    }

    public function downgrade() { 

        $this->dropTable('authors');
        $this->dropTable('addresses');
        
    }
}

The built-in migration generator not only generates the upgrade script, but also generates the downgrade script, you can modify it to anything as you want.

After the migration script is generated, you can check the status of current database and waiting migration scripts:

$ lazy migrate status
Found 1 migration script to be executed.
- AddUserColumn_1347451491

now you can run upgrade command to upgrade database schema through the migration script:

$ lazy migrate up

If you regret, you can run downgrade migrations through the command:

$ lazy migrate down

But please note that SQLite doesn't support column renaming and column dropping.

To see what migration script could do, please check the documentation of SQLBuilder package.

Mix-In Schema

...

Collection Filter

The Built-in Collection Filter provide a powerful feature that helps you connect the backend collection filtering with your front-end UI by defining filter types, valid values from backend:

use LazyRecord\CollectionFilter\CollectionFilter;
$posts = new PostCollection;
$filter = new CollectionFilter($posts);

$filter->defineEqual('status', [ 'published', 'draft' ]); // valid values are 'published', 'draft'
$filter->defineContains('content');
$filter->defineRange('created_on', CollectionFilter::String );
$filter->defineInSet('created_by', CollectionFilter::Integer );

$collection = $filter->apply([ 
    'status'     => 'published',   // get published posts
    'content'    => ['foo', 'bar'],  // posts contains 'foo' and 'bar'
    'created_on' => [ '2011-01-01', '2011-12-30' ], // posts between '2011-01-01' and '2011-12-30'
    'created_by' => [1,2,3,4],  // created by member 1, 2, 3, 4
]);

$collection = $filter->applyFromRequest('_filter_prefix_');

// use '_filter_' as the parameter prefix by default.
$collection = $filter->applyFromRequest();

The generated SQL statement is like below:

SELECT m.title, m.content, m.status, m.created_on, m.created_by, m.id FROM posts m  WHERE  (status = published OR status = draft) AND (content like %foo% OR content like %bar%) AND (created_on BETWEEN '2011-01-01' AND '2011-12-30') AND created_by IN (1, 2, 3, 4)

Basedata Seed

Setting up QueryDriver for SQL syntax

$driver = LazyRecord\QueryDriver::getInstance('data_source_id');
$driver->configure('driver','pgsql');
$driver->configure('quote_column',true);
$driver->configure('quote_table',true);

A More Advanced Model Schema

use LazyRecord\Schema;

class AuthorSchema extends Schema
{
    function schema()
    {
        $this->column('id')
            ->integer()
            ->primary()
            ->autoIncrement();

        $this->column('name')
            ->varchar(128)
            ->validator(function($val) { .... })
            ->filter( function($val) {  
                        return preg_replace('#word#','zz',$val);  
            })
            ->inflator(function($val) {
                return unserialize($val);
            })
            ->deflator(function($val) {
                return serialize($val);
            })
            ->validValues( 1,2,3,4,5 )
            ->default(function() { 
                return date('c');
            })
            ;

        $this->column('email')
            ->required()
            ->varchar(128);

        $this->column('confirmed')
            ->default(false)
            ->boolean();

        $this->seeds('User\\Seed')
    }
}

Documentation

For the detailed content, please take a look at the doc/ directory.

Contribution

Everybody can contribute to LazyRecord. You can just fork it, and send Pull Requests.

You have to follow PSR Coding Standards and provides unit tests as much as possible.

Hacking

Setting Up Environment

Use Composer to install the dependency:

composer install --prefer-source

To deploy a testing environment, you need to install dependent packages.

Run script and make sure everything is fine:

php bin/lazy

Database configuration is written in phpunit.xml file, the following steps are based on the default configuration. you may also take a look at .travis.yml for example.

Unit Testing with MySQL database

To test with mysql database:

mysql -uroot -p

Enter the SQL to initialize a database:

create database testing charset utf8;
create user 'testing'@'localhost';
grant all privileges on testing.* to 'testing'@'localhost';

--- if you want password
grant all privileges on testing.* to 'testing'@'localhost' identified by 'testing';

--- if you want to remove password for root user
SET PASSWORD FOR root@localhost=PASSWORD('');

--- for mysql 5.7, you should run
SET PASSWORD FOR root@localhost='';

Unit Testing with PostgreSQL database

To test with pgsql database, you need to prepare database:

sudo -u postgres createdb -E=utf8 testing

If you want to use a separated user, use the command below to create the pgsql user:

sudo -u postgres createuser --no-createrole --no-superuser --no-password testing
sudo -u postgres createdb -E=utf8 --owner=testing testing

If you've set password accidentally, remove user password by running the command below:

> alter role postgres password null;

To connect pgsql with PDO, you need to configure your DSN for postgresql through socket like this:

pgsql:host=localhost;dbname=testing

Command-line testing

To test sql builder from command-line, please copy the default testing config

$ cp db/config/database.testing.yml db/config/database.yml

Customize your phpunit.xml configuration:

$ cp phpunit.xml.dist phpunit.xml

Build config

$ php bin/lazy build-conf db/config/database.yml

Build Schema files

php bin/lazy schema build

We've already defined 3 data sources, they were named as 'mysql', 'pgsql', 'sqlite' , now you can insert schema sqls into these data sources:

bin/lazy sql --rebuild -D=mysql
bin/lazy sql --rebuild -D=pgsql
bin/lazy sql --rebuild -D=sqlite

Run PHPUnit

$ phpunit

Profiling

$ phpunit --group profile

Manipulating Schema Objects

To get the model class name from a schema:

$class = $schema->getModelClass();

To get the table name of a schema:

$t = $schema->getTable();

To iterate the column objects, you may call getColumns, which returns the column objects in an associative array:

foreach( $schema->getColumns() as $n => $c ) {
    echo $c->name; // column name
}

PROFILING

$ scripts/run-xhprof

$ phpunit -c phpunit-xhprof.xml
$ cd xhprof_html
$ php -S localhost:8888

LICENSE

BSD License

corneltek / lazyrecord

Maintainers

Details