README

A model wrapper around the DB class to keep your code clean.

Installation

You can install the package via composer:

composer require gertjanroke/laravel-db-model

Usage

<?php

namespace App\Models;

use GertjanRoke\LaravelDbModel\DBModel;

class Post extends DBModel
{
    // public $table = 'posts';
    
    // public $connection = 'mysql';
}

If no table name was given it will guess it based on the class name just like the Eloquent model those.
Same for the connection, if none is set it will use the default connection.

How to extend custom scopes

It's basically the same as for Eloquent models, you would need to prefix the methods with scope

...

class Post extends DBModel
{
    public function scopeActive()
    {
        $this->db->where('active', true);

        return $this;
    }
}

Some examples

You can easly create short functions for basic where's or even more complex queries so you have it always in one location instead of everywhere in your code base.

<?php

namespace App\Models;

use App\Models\Comment;
use GertjanRoke\LaravelDbModel\DBModel;

class Post extends DBModel
{
    public function scopeActive(): self
    {
        $this->db->where('active', true);

        return $this;
    }
    
    public function scopeWithLatestComment(): self
    {
        $postTable = $this->getTable();
        $commentTable = (new Comment())->getTable();
        
        $this->db->join($commentTable, "{$commentTable}.post_id", '=', "{$postTable}.id")
            ->addSelect("{$commentTable}.body");

        return $this;
    }
}

// Inside your controller
$post = Post::active()->withLatestComment()->latest()->first();

// Keep in mind the order of calling methods doesn't matter as long as the method before returned the builder instance.
// Like this example will return the same result as the query above.
$post = Post::active()->latest()->withLatestComment()->first();

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

gertjanroke / laravel-db-model

Maintainers

Details