um-flint/laravel-repository

A repository pattern for Laravel.

Table of Contents

• Methods
  • RepositoryInterface
  • Traits
    • SoftDeletes
• Hooks
• Validation

Methods

UMFlint\Repository\Contracts\RepositoryInterface

• lists($column, $key = null)
• pluck($column, $key = null)
• sync($id, $relation, $attributes, $detaching = true)
• syncWithoutDetaching($id, $relation, $attributes)
• all($columns = ['*'])
• paginate($limit = null, $columns = ['*'])
• simplePaginate($limit = null, $columns = ['*'])
• find($id, $columns = ['*'])
• findByField($field, $value, $columns = ['*'])
• findWhere(array $where, $columns = ['*'])
• findWhereIn($field, array $values, $columns = ['*'])
• findWhereNotIn($field, array $values, $columns = ['*'])
• create(array $attributes)
• update(array $attributes, $id)
• delete($id)
• orderBy($column, $direction = 'asc')
• has($relation)
• with($relations)
• whereHas($relation, $closure)
• withCount($relations)
• hidden(array $fields)
• visible(array $fields)
• scopeQuery(\Closure $scope)
• resetScope()

Traits

UMFlint\Traits\SoftDeletes

This trait allows for soft deletes: - delete($id, $force = false), _(*1)

In order to query for deleted entities: - withTrashed(), _(*2)

To restore a soft deleted entity: - restore($id), _(*3)

Hooks

Boot

Anything that needs to happen when the repository class is created. Uses Laravels container for automatic injection. - boot(), _(*4)

Create

• beforeCreate(&$attributes)
• afterCreate($model, &$attributes)

Update

• beforeUpdate($model, &$attributes)
• afterUpdate($model, &$attributes)

Delete

• beforeDelete($model)
• afterDelete($model, $deleted)

Restore

• beforeRestore($model)
• afterRestore($model)

Validation

Example rules:, _(*5)

<?php

namespace App\Rules;

use App\Models\Announcement;
use Illuminate\Validation\Rule;
use UMFlint\Repository\Rules\BaseRules;

class AnnouncementRules extends BaseRules
{
    protected function rules(): array
    {
        return [
            'type'     => ['required', Rule::in(array_keys(Announcement::$types))],
            'title'    => 'required',
            'message'  => 'required',
            'start_at' => ['required', 'date'],
            'end_at'   => ['required', 'date'],
        ];
    }
}

To use it in a repository:, _(*6)

<?php

namespace App\Repositories;

use App\Models\Announcement;
use App\Rules\AnnouncementRules;
use UMFlint\Repository\BaseRepository;

class AnnouncementRepository extends BaseRepository
{
    public function model(): string
    {
        return Announcement::class;
    }

    public function rules(): array
    {
        return AnnouncementRules::getRules();
    }
}