tjbp/eloquent-joins

Support for joins at the relationship level in Laravel's Eloquent ORM.

dev-master 2015-12-28 16:47 UTC

Requires

• php: >=5.5.9
• illuminate/database: ^5.0

Requires (Dev)

• mockery/mockery: ~0.9.1
• phpunit/phpunit: ^4.8

GPL-3.0

• Tom Pitcher

• laravel
• join
• eloquent

README

This package allows you to simply call $model->join($relation) to join a Laravel Eloquent relationship's table on the keys declared by your relationship. Columns will be selected automatically, and the joined records hydrated as models in the resulting collection. Laravel's Eloquent does support joins normally, but internally calls the underlying query builder, thereby expecting the name of a table and keys to join it on as arguments.

Installation

Eloquent Joins is installable with Composer via Packagist.

Usage

Use trait

Simply use EloquentJoins\ModelTrait in a model:

namespace App;

use EloquentJoins\ModelTrait as EloquentJoinsModelTrait;

class User
{
    use EloquentJoinsModelTrait;

    protected $table = 'users';

    public function orders()
    {
        return $this->hasMany('\App\Order');
    }
}

$users = User::join('orders')->get();

In the above example, $users will contain a collection of all the User models with a corresponding Order model (since we've performed an inner join). Each corresponding Order model can be found in the $orders property on the User model (normally this would contain a collection of models with a matching foreign key).

You can string multiple join() calls, as well as use the other types of join normally available on the underlying query object (joinWhere(), leftJoin(), etc.).

Licence

Eloquent Joins is free and gratis software licensed under the GPL3 licence. This allows you to use Eloquent Joins for commercial purposes, but any derivative works (adaptations to the code) must also be released under the same licence.