README

A set of useful Laravel builder macros.

Installation

You can install the package via composer:

composer require datalogix/laravel-builder-macros

The package will automatically register itself.

Macros

addSubSelect
defaultSelectAll
filter
joinRelation
leftJoinRelation
map
whereLike

`addSubSelect`

Add a select sub query.

// Params: $column, $query
$query->addSubSelect('primary_address_id', 
    Address::select('id')
        ->where('user_id', $user->id)
        ->primary()
);

// It adds primary_address_id to the result set

`defaultSelectAll`

It selects all columns from the query. Useful for queries with joins and additional selects.

$query->defaultSelectAll()
    ->join('contacts', 'users.id', '=', 'contacts.user_id')
    ->addSelect('contacts.name as contact_name');

`filter`

Filter in your models.

$query->filter(['name' => 'john'])->get();

// Returns all results where name includes `john`

You can also supply an array of columns to filter in:

$query->filter(['name' => 'john', 'contact.email' => '@'])->get();

// Returns all results where name includes `john` or contact.email includes `@`

You can use $request->all():

$query->filter($request->all())->get();

`joinRelation`

A query way to join relations.

// Params: $relationName, $operator
$query->joinRelation('contact');

`leftJoinRelation`

A query to left join relations.

// Params: $relationName, $operator
$query->leftJoinRelation('contact');

`map`

A direct method to retrieve the results and map it.

$userIds = $query->where('user_id', 10)->map(function ($user) {
    return $user->id;
});

// Returns a collection

`whereLike`

Search in your models with the LIKE operator.

$query->whereLike('title', 'john')->get();

// Returns all results where title includes `john`

$query->whereLike('title', 'john', false)->get();

// Returns all results where title ends with `john`

$query->whereLike('title', 'john', true, false)->get();

// Returns all results where title starts with `john`

You can also supply an array of columns to search in:

$query->whereLike(['title', 'contact.name'], 'john')->get();

// Returns all results where title or contact.name includes `john`

datalogix / laravel-builder-macros

Maintainers

Details