erwang/korm

ORM for PHP

KORM

ORM in PHP ⛔️ DEPRECATED, _(*1)

Setup

The Connection class setup must be call first., _(*2)

``` php $connection = \KORM\Connection::setup('name','pdo_dsn', 'username', 'password');, <sub>(*3)</sub>

A connection to a mysql database :

``` php
$connection = \KORM\Connection::setup('connectionName','mysql:host=localhost;dbname=database', 'username', 'password');

with options :, <sub>(*4)</sub>

``` php $connection = \KORM\Connection::setup('connectionName','mysql:host=localhost;dbname=database', 'username', 'password', array(\PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES \'UTF8\''));, <sub>(*5)</sub>

## Create a class

Each table in database requires a class with the same name :

``` php
class Table extends \KORM\Object{
}

name class is converted to lower case For example, to store books :, <sub>(*6)</sub>

``` php class Book extends \KORM\Object{ }, <sub>(*7)</sub>

The `Book` objects will be store in `book` table

## Define connection
``` php
Book::setConnection($connection);

Get a row from id

``` php $book = new Book($id);, <sub>(*8)</sub>

will load in `$book` all the data in table `book` with id=1

## Create a row

``` php
$book = new Book();

Store an object

``` php $book = new Book($id); $book->title='Les Misérables'; $book->store();, <sub>(*9)</sub>

## Delete an object

``` php
$book = new Book($id);
$book->delete();

Find objects

Find one Object

``` php $book = Book::findOne(['title'=>'Les Misérables']);, <sub>(*10)</sub>

This return one Book (the first found)

### Find multiple Objects

``` php
$authors = Author::find(['nationality'=>'French']);

This will return an array with all french authors, <sub>(*11)</sub>

If you need complex where clause, you can use where, <sub>(*12)</sub>

``` php $books = Book::where('pages>:nbpages',['nbpages'=>100]);, <sub>(*13)</sub>

This will return an array with books with more than 100 pages

If you want more complex queries :

``` php
$books = Book::query('select book.* from book,author where author.id=:author_id and pages>:nbpages and author.id=book.author_id',['nbpages'=>100,'author_id'=>1]);

This will return an array with books with more than 100 pages from author with id 1, <sub>(*14)</sub>

``` php $books = Book::getAll();, <sub>(*15)</sub>

This will return all books in table


## Relations

### One to many

``` php
//create a book
$lesMiserables = new Book();
$lesMiserables->title='Les Misérables';
$lesMiserables->store();

//create an author
$hugo=new Author();
$hugo->name='Victor Hugo';
$hugo->store();

//create a relation
$lesMiserables->author=$hugo;
$lesMiserables->store();

//get the book
$book = new Book($lesMiserables->id);
$author = $book->author; //return the object Author from table author

many to many

``` php //create tags $tag1=new Tag(); $tag1->text='french'; $tag1->store();, <sub>(*16)</sub>

$tag2=new Tag(); $tag2->text='Roman'; $tag2->store(); $lesMiserables->tag=[$tag1,$tag2]; $lesMiserables->store();, <sub>(*17)</sub>

//find book from many $booksWithFrenchTag = $tag1->book;, <sub>(*18)</sub>

## Count

``` php
//get the number of books
Book::count();

//get the number of books from an author
Book::count(['author_id'=>$author->id]);

Populate an object

``` php //get data from an array $post=['firstname'=>'Marcel','lastname'=>'Proust']; //create a new author $author=new Author(); $author->populate($post); $author->store();, <sub>(*19)</sub>

## Truncate table

``` php
//with foreign key check
Author::truncate();
//without foreign key check
Author::truncate(false);

Drop table

php //with foreign key check Author::drop(); //without foreign key check Author::drop(false);, <sub>(*20)</sub>