Jet-ORM

A light PHP5.3 ORM

Feel free to contribute!

• Fork
• Report bug
• Help in development

Licence

Released under a BSD license

How To ?

First, you need to pass a config array to the ORMConnector wich represent the db type, db name, adresse, login and password :

<?php
OrmConnector::$config = array(
    'type'  => 'mysql',
    'host'  => 'localhost',
    'base'  => 'jet',
    'log'   => 'root',
    'pass'  => 'root'
);

Or you can use the Socket method :

<?php
OrmConnector::$config = array(
    'socket'  => 'yourSocker',
    'base'  => 'jet'
);

Then, you must create model extending the OrmWrapper named of your table name in camel case and the id column must have the table name inside. For exemple, the table user_project contain a id_user_project column and model is named UserProject.

class UserProject extends OrmWrapper{
    //your methods here
}

Now, in or out of your model, your can do some request to your table !

Doc

Read

###Get a single element

Any method chain can be end by a findOne() and will return a unique current class of the first element of the request or false if nothing is found.

To find a user with the ORM project :

$project = $this->where('name', '=', 'ORM')->findOne();

This equal to the next sql statement :

SELECT * FROM user_project WHERE name = ORM

You can quickly find a element by id when you pass the id directly to findOne

$project = $this->findOne(1);

###Get multiple element

Any method chain can be end by a findMany() and will return an array of current class or false if nothing is found.

To find all element:

$projects = $this->findMany();

Where type is paid:

$projects = $this->where('type', '=', 'paid')->findMany();

###Read result

To get data from result your just need to access to the property directly from the object:

$this->name;

##Filter

Each of the filter can be chained.

###Select

Set the selected row in the query.

<?php

$project->select('name')->findMany();

$project->select(array( 
            'name',
            'desc'))
        ->findMany();

###Join

You can easily join two model with join. join ask the type of join (LEFT, INNER...) then the asked model to be join and an array or string of condition. If the string is empty, the ORM will atemp to find the name of the id column on the first model :

<?php
$user = new User();
$project = new Project();

$userProjects = $user->where("id_user", "=", 1)
                     ->join('LEFT', $project)
                     ->find_many();

<?php

$user = new User();
$project = new Project();

$userProjects = $user->where("id_user", "=", 1)
                     ->join('LEFT', $project, array(
                          'user.id_user = project.user_id',
                          "AND" => 'user.id_project = project.project_id',
                          "OR"  => array(
                            'user.id_parent = project.id_parent',
                            "AND" => 'user.id_project != project.id_project'
                          )
                     ))
                     ->find_many();

###Where

Where take three arguments: the column to be filtered then the statement and the result.

<?php
$projects = $this->where('type', '=', 'paid')->findMany();

$projects = $this->where('name', '!=', 'test')->findMany();

###Group

Set a Group By request. Group take a string or an array of rows to be grouped

<?php
$projects = $this->group('type')->findMany()

$projects = $this->group(array('name', 'type'))->findMany();

###Order by

Order by take two arguments : one or an array of column to order, direction of order

<?php
$projects = $this->order('name')->findMany();

$projects = $this->order(array('id_project', 'name'), 'ASC')->findMany();

###Limit

Set the limit of your request

<?php
$projects = $this->limit(7)->findMany();

<?php
$projects = $this->limit(7, 3)->findMany();

###Offset

Set the offset of your request

<?php
$projects = $this->offset(12)->findMany();

###Distinct

Set the request DISTINCT

<?php
$projects = $this->distinct()->findMany();

##Create/Save/Delete

###Create

To create a new row, your just need to use the create() method:

$project->create()

You can add directly data to the new model by specify an array of data to create:

<?php

$project->create(array(
    'name' => 'test',
    'user_id' => 1,
    'type' => 'unpaid'
));

###Modify

To modify data of a model, your just need to edit the asked property:

$project->name = "Not a test";

###Save

To save the model, just use the save() method:

$project->save();

###Delete

To delete the model, use the delete() method:

$project->delete();

Other

To change the id column name, you can use the $model->setIdName('name') method.

To quickly get the current id, your can use $model->getId().

To an array of all data contain, use $model->getAll().

To the rows name of table, use $model->getRows().

To reset the model to is initial state use $model->reset().

To access to the query log, use OrmWrapper::$log