northern-lights/eloquent-bootstrap

Bootstrap for standalone Eloquent ORM

Eloquent ORM standalone Bootstrap

, _(*1)

The Eloquent ORM that comes with Laravel makes it incredibly easy to interact with a database., _(*2)

Unfortunately, if you want to use it standalone, without rest of framework, things are not so easy., _(*3)

This library solves that headache for you, and brings Eloquent ORM to your project with single command., _(*4)

Install

Via Composer, _(*5)

``` bash $ composer require northern-lights/eloquent-bootstrap, <sub>(*6)</sub>

It really is that easy!

## Usage - Single connection
``` php
<?php

declare(strict_types=1);

namespace NorthernLights\EloquentBootstrap\Example;

use NorthernLights\EloquentBootstrap\Database;
use NorthernLights\EloquentBootstrap\Provider\ConfigOptions;
use NorthernLights\EloquentBootstrap\Provider\ConfigProvider;

require __DIR__ . '/vendor/autoload.php';

$database = new Database(new ConfigProvider([
        ConfigOptions::HOST     => 'localhost',
        ConfigOptions::DATABASE => 'database_name',
        ConfigOptions::USERNAME => 'user',
        ConfigOptions::PASSWORD => 'pass'
]));

// At this point, eloquent will boot
$database->init();

Usage - Multiple connections

``` php <?php, <sub>(*7)</sub>

declare(strict_types=1);, <sub>(*8)</sub>

namespace NorthernLights\EloquentBootstrap\Example;, <sub>(*9)</sub>

use NorthernLights\EloquentBootstrap\Connection; use NorthernLights\EloquentBootstrap\Database; use NorthernLights\EloquentBootstrap\Provider\ConfigOptions; use NorthernLights\EloquentBootstrap\Provider\ConfigProvider;, <sub>(*10)</sub>

require DIR . '/vendor/autoload.php';, <sub>(*11)</sub>

$database = new Database(); $database->addConnection( new Connection('first-database', new ConfigProvider([ ConfigOptions::HOST => 'localhost', ConfigOptions::DATABASE => 'first_database', ConfigOptions::USERNAME => 'user', ConfigOptions::PASSWORD => 'pass' ])) );, <sub>(*12)</sub>

$database->addConnection( new Connection('second-database', new ConfigProvider([ ConfigOptions::HOST => 'localhost', ConfigOptions::DATABASE => 'second_database', ConfigOptions::USERNAME => 'second_user', ConfigOptions::PASSWORD => 'pass' ])) );, <sub>(*13)</sub>

// At this point, eloquent will boot $database->init();, <sub>(*14)</sub>

And that's all you need to include in your bootstrap file.
For everything else, consult with [Eloquent documentation](https://laravel.com/docs/5.6/eloquent).

Note: Even in this example, you can setup default connection via Database constructor.

Note: NorthernLights\EloquentBootstrap\Database::getCapsule() will return Capsule instance, which can be used to add connections directly

## RAW Query usage

``` php
<?php

(...)
// Notice that you need this line too
$database->getCapsule()->setAsGlobal();

$user = DB::table('users')->where('userid', '=', '123');

dump($user);

Creating a simple model

``` php <?php, <sub>(*15)</sub>

declare(strict_types=1);, <sub>(*16)</sub>

namespace NorthernLights\EloquentBootstrap\Example;, <sub>(*17)</sub>

use NorthernLights\EloquentBootstrap\Model as EloquentModel;, <sub>(*18)</sub>

/** * Class Users * @package NorthernLights\EloquentBootstrap\Example */ class Users extends EloquentModel { /** @var string */ protected $table = 'users'; }, <sub>(*19)</sub>

Note the usage of NorthernLights\EloquentBootstrap\Model, since it will only fix IDE annotations (Confirmed: PhpStorm). It doesn't include any logic.

## PSR-12 Standard
Library strives to comply with PSR-12 coding standards, therefore we included following commands:
``` bash
$ composer check-style
$ composer fix-style

Note: Second command will actually modify files, <sub>(*20)</sub>

PSR-4 Standard

Library complies with PSR-4 autoloading standard, <sub>(*21)</sub>

Testing

bash $ composer php-lint $ composer test, <sub>(*22)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*23)</sub>

, <sub>(*24)</sub>