A set of advanced Eloquent macros for Laravel
Clone or download
Latest commit 038b76f Nov 23, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Rename "nullDirection" to "nullPosition" Nov 23, 2018
tests Add order by sub tests Nov 23, 2018
.gitignore Setup tests Nov 23, 2018
.php_cs.dist Add PHP CS Fixer config Nov 23, 2018
composer.json Setup tests Nov 23, 2018
phpunit.xml Setup tests Nov 23, 2018
readme.md Rename "nullDirection" to "nullPosition" Nov 23, 2018

readme.md

Advanced Eloquent

A set of advanced Eloquent macros for Laravel.

Installation

You can install this package via Composer:

composer require reinink/advanced-eloquent

This package uses auto-discovery, so there is no further configuration required.

API

addSubSelect($column, $query)

  • $column must be a string.
  • $query must either be an instance of Illuminate\Database\Query\Builder or Illuminate\Database\Eloquent\Builder.

orderBySub($query, $direction = 'asc', $nullPosition = null)

  • $query must either be an instance of Illuminate\Database\Query\Builder or Illuminate\Database\Eloquent\Builder.
  • $direction must either be 'asc' or 'desc'.
  • $nullPosition must either be null, 'first' or 'last'.

orderBySubAsc($query, $nullPosition = null)

  • $query must either be an instance of Illuminate\Database\Query\Builder or Illuminate\Database\Eloquent\Builder.
  • $nullPosition must either be null, 'first' or 'last'.

orderBySubDesc($query, $nullPosition = null)

  • $query must either be an instance of Illuminate\Database\Query\Builder or Illuminate\Database\Eloquent\Builder.
  • $nullPosition must either be null, 'first' or 'last'.

Note: Null positions (NULLS FIRST and NULLS LAST) are not supported by all databases (ie. MySQL and SQLite), but are supported by PostgreSQL and others.

Examples

Get a user's last login date using a subquery:

$users = User::addSubSelect('last_login_at', Login::select('created_at')
    ->whereColumn('user_id', 'users.id')
    ->latest()
)->get();

Same example as above, except using the query builder instead:

$users = DB::table('users')->addSubSelect('last_login_at', DB::table('logins')
    ->select('created_at')
    ->whereColumn('user_id', 'users.id')
    ->latest()
)->get()

Order users by their company name using a subquery:

$users = User::orderBySub(Company::select('name')->whereColumn('company_id', 'companies.id'))->get();

Order users by their last login date, with null values last:

$users = User::addSubSelect('last_login_at', Login::select('created_at')
        ->whereColumn('user_id', 'users.id')
        ->latest()
    )->orderBySubDesc(Login::select('created_at')
        ->whereColumn('user_id', 'users.id')
        ->latest(), 'last'
    )->get();