jakolab/howl-orm

This package is abandoned and no longer maintained. No replacement package was suggested.

Library to mapping your database and manipulate data without SQL, just OOP.

1.0.0 2017-05-30 01:54 UTC

MIT

• jakolab

README

What is?

Howl-ORM (Object Relational Model) was built to make the data layer of your applications easy and fast. Based on the active record pattern Howl-ORM makes easy:

• Connect to database
• List and find records.
• Store new records.
• Update existing records.
• Delete existing records.

Also Howl-ORM allows you to filter records using clauses such as JOINS and GROUPS, the result can be ORDERED, LIMITED and COUNTED.

How to install and initialize

1. Download Howl-ORM as a zip and extract the files into your project libraries folder.
2. Require the HowlAutoload.php file from the Howl-ORM package.
3. Initialize the Howl Autoload.
4. Instance Howl Database manager.
5. Load the Database driver.

<?php 
# This is your proyect root.

# Requiring Howl.
require_once 'Libs/Howl/HowlAutoload.php';

# Initializing the autoload.
\Howl\HowlAutoload::initAutoload();

# Getting the Manager instance.
$db = \Howl\DBManager::getInstance();

$config = [
    'host' => 'localhost',
    'user' => 'root',
    'database' => 'your database',
    'password' => 'your password',
];

# Loading the desired driver.
$db->loadDriver(\Howl\DBManager::MYSQL_DRIVER, $config);

Done, now you are connected to the database! An optional way to do exactly the same as above is:

<?php 
require_once 'Libs/Howl/HowlAutoload.php';
\Howl\HowlAutoload::initAutoload();
$config = [
    'host' => 'localhost',
    'user' => 'root',
    'database' => 'your database',
    'password' => 'your password',
];
\Howl\DBManager::getInstance()->loadDriver(\Howl\DBManager::MYSQL_DRIVER, $config);

Howl use the singleton patter to keep only one instance of the database connection, using the getInstance funciton you can get the unique instance of the Dadatabase manager en execute custom queries if you want.

Mapping your tables (Models)

To map your database tables is very easy.

1. Create a file with name of the table into a directory named model (I recommend you to use PascalCase to name your models).
2. The file must contains a namespace Model.
3. The file must have a class with the same name as the file.
4. The class must extends from Howl\Model.
5. The class must contains a property named table and it's value must be the name of the table that it represents in database.

Model/Items.php

<?php
namespace Model;
use Howl\Model;

class Items extends Model{
  protected $table = "tbl_items";
}

app/index.php

<?php 
# this is how we create a new record using Howl-ORM
$item = new \Model\Items();
$item->name = "This is the name";
$item->description = "Lorem ipsum dolor sit...";
$item->save();

List

$records = \Model\Items::search()->all();

Update

$item = \Model\Items::search()->byPk(1);
$item->name = "Name updated...";
$item->save();

Delete

$item = \Model\Items::search()->byPk(1);
$item->delete();
# or
\Model\Items::search()->byPk(2)->delete();

Compare

$records = \Model\Items::search()
                        ->equals("field1", "item1")
                        ->and()
                        ->equals("field2", 2)
                        ->get();