jsdecena / baserepo
Base repository
Installs: 53 535
Dependents: 1
Suggesters: 0
Security: 0
Stars: 76
Watchers: 6
Forks: 42
Open Issues: 0
Requires
- php: ^8.0
- ext-json: *
- league/fractal: ^0.20.1
Requires (Dev)
- laravel/legacy-factories: ^1.3
- orchestra/testbench: ^7.4
- phpunit/phpunit: ^9.5
README
Sign-up with Digital Ocean and get $20 discount!
Buy me a coffeee so I can continue development of this package
How to install
-
Run in your terminal
composer require jsdecena/baserepo
-
In your repository class, extend it so you can use the methods readily available.
namespace App\Repositories; use App\User; use Illuminate\Http\Request; use Illuminate\Database\QueryException; use Jsdecena\Baserepo\BaseRepository; class UserRepository extends BaseRepository { public function __construct(User $user) { parent::__construct($user); } public function createUser(array $data) : User { try { return $this->create($data); } catch (QueryException $e) { throw new \Exception($e); } } }
- Then, use it in your controller.
use App\Http\Controllers\Controller; use App\Repositories\UserRepository; use App\User; class MyController extends Controller { private $userRepository; /** * * Inject your repository or the interface here */ public function __construct(UserRepository $userRepository) { $this->userRepository = $userRepository; } public function index() { $user = $this->userRepository->all(); return response()->json($user); } public function store(Request $request) { // do data validation try { $user = $this->userRepository->createUser($request->all()); return response()->json($user, 201); } catch (Illuminate\Database\QueryException $e) { return response()->json([ 'error' => 'user_cannot_create', 'message' => $e->getMessage() ]); } } public function show($id) { // do data validation try { $user = $this->userRepository->findOneOrFail($id); return response()->json($user); } catch (Illuminate\Database\Eloquent\ModelNotFoundException $e) { return response()->json([ 'error' => 'user_no_found', 'message' => $e->getMessage() ]); } } public function update(Request $request, $id) { // do data validation try { $user = $this->userRepository->findOneOrFail($id); // You can also do this now, so you would not have to instantiate again the repository $this->userRepository->update($request->all(), $user); return response()->json($user); } catch (Illuminate\Database\Eloquent\ModelNotFoundException $e) { return response()->json([ 'error' => 'user_no_found', 'message' => $e->getMessage() ]); } catch (Illuminate\Database\QueryException $e) { return response()->json([ 'error' => 'user_cannot_update', 'message' => $e->getMessage() ]); } } public function destroy($id) { // do data validation try { $user = $this->userRepository->findOneOrFail($id); // Create an instance of the repository again // but now pass the user object. // You can DI the repo to the controller if you do not want this. $userRepo = new UserRepository($user); $userRepo->delete() return response()->json(['data' => 'User deleted.']); } catch (Illuminate\Database\Eloquent\ModelNotFoundException $e) { return response()->json([ 'error' => 'user_no_found', 'message' => $e->getMessage() ]); } catch (Illuminate\Database\QueryException $e) { return response()->json([ 'error' => 'user_cannot_delete', 'message' => $e->getMessage() ]); } } }
Testing
- Run
make test