bulwark/repoman

Repoman

, _(*1)

Introduction

A base repository class for Eloquent with convenience methods that cover most queries. Useful to abstract away your persistence layer from your business code., _(*2)

Installation

For Laravel 5.4 and above, _(*3)

composer require bulwark/repoman ~1.0

Implementation

The examples will use a hypothetical Eloquent model named User., _(*4)

<?php

namespace App\Repositories;

use App\Models\User;
use Bulwark\Repoman\Repository;

class UserRepository extends Repository
{
    protected function getModel()
    {
        return new User;
    }
}

Options

Repoman is already integrated with Bulwark\Dream. See Dream documentation for more information. The $options key given by all get-methods takes the following format:, _(*5)

Note: If you use the controller of Dream it will automatically parse the request's query string into the correct format., _(*6)

API

The examples will use a hypothetical Eloquent model named User., _(*7)

get (array $options = [])

Get all User rows, _(*8)

getById ($id, array $options = [])

Get one User by primary key, _(*9)

getRecent (array $options = [])

Get User rows ordered by created_at descending, _(*10)

getRecentWhere (string $column, mixed $value, array $options = [])

Get User rows where $column=$value, ordered by created_at descending, _(*11)

getWhere (string $column, mixed $value, array $options = [])

Get User rows where $column=$value, _(*12)

getWhereArray (array $clauses, array $options = [])

Get User rows by multiple where clauses ([$column1 => $value1, $column2 => $value2]), _(*13)

getWhereIn (string $column, array $values, array $options = [])

Get User rows where $column can be any of the values given by $values, _(*14)

getLatest (array $options = [])

Get the most recent User, _(*15)

getLatestWhere (string $column, mixed $value, array $options = [])

Get the most recent User where $column=$value, _(*16)

delete ($id)

Delete User rows by primary key, _(*17)

deleteWhere ($column, $value)

Delete User rows where $column=$value, _(*18)

Standards

This package is compliant with PSR-1, PSR-2 and PSR-4. If you notice compliance oversights, please send a patch via pull request., _(*19)

Testing

bash $ phpunit, _(*20)

Contributing

Please see CONTRIBUTING for details., _(*21)

License

The MIT License (MIT). Please see License File for more information., _(*22)