ritalin/omelet

SQL base object mapper for php

Omelet - SQL base object mapper for php.

This Library is inspired by Doma(https://github.com/domaframework/doma)., _(*1)

Requirements

php >= 5.5.x, _(*2)

Installation

Omelet can be installed with Composer., _(*3)

Define the following requirement in your composer.json file:, _(*4)

{
    "require": {
        "ritalin/omelet": "*"
    }
}

Quick Start

1. Define Dao (Data Access Object) interface., _(*5)

   • DAO method is need to describe an annotation comment to distingish database command/query.

   use \Omelet\Annotation\Select;
   
   interface TodoDao {
       /**
        * @Select
        */
       function listAll();
   }
   

2. Prepare sql file of same name as method. sql file path depends on namespace for dao interface., _(*6)

   -- listAll.sql
   select * from todo order by id
   

3. Instanciate \Omelet\Builder\DaoBuilderContext ., _(*7)

   • At least, need to a connection string to database as configuration.

   $config = \Omelet\Builder\Configuration;
   $config->connectionString = "driver=pdo_sqlite&path=/path/to/todo.sqlite3";
   
   $context = new \Omelet\Builder\DaoBuilderContext($config);
   

4. Generate Dao concrete class., _(*8)

   $context->build(Todo::class);
   

5. Use Dao., _(*9)

   • A Dao concrete class name note that 'Impl' is suffixed to interface name by default.

   $conn = \Doctrine\DBAL\DriverManager->getConnection($context->connectionString());
   $dao = new TodoImpl($conn, $context);
   $rows = $dao->listAll();
   

Sample Application

Please see ritalin/omelet-bear-example implemented with BEAR.Sunday (https://github.com/bearsunday/BEAR.Sunday) framework., _(*10)

now work in progress ..., _(*11)