jamesmills / eloquent-uuid
A Laravel Eloquent Model trait for adding and using a uuid with models
Installs: 43 243
Dependents: 0
Suggesters: 0
Security: 0
Stars: 139
Watchers: 7
Forks: 15
Open Issues: 6
Type:package
Requires
- php: >=7.2.0
- illuminate/support: 5.4.* || 5.5.* || 5.6.*|| 5.7.*|| 5.8.*|| ^6 || ^7 || ^8
- ramsey/uuid: ^4.1
README
A Laravel Eloquent Model trait for adding and using a uuid with models.
The trait listens to the creating
event. It generates a new UUID and saves it in the uuid column on the model.
Featured in Laravel News
Installation
composer require jamesmills/eloquent-uuid
Use
In order to use this in your models, just put use HasUuidTrait;
<?php namespace App; use JamesMills\Uuid\HasUuidTrait; class User extends Eloquent { use HasUuidTrait; }
Schema requirements
In order to use this trait, your schema must be something like:
<?php // ... Schema::create('users', function (Blueprint $table) { $table->primary('id'); $table->uuid('uuid')->unique(); // this will create a CHAR(36) field $table->string('username', 32); $table->string('password', 50); // ... });
Querying your models
You may use the findByUuidOrFail
method to try and fetch a model directly:
<?php Route::get('/user/{uuid}', function($uuid) { try { return App\User::findByUuidOrFail($uuid); } catch (Illuminate\Database\Eloquent\ModelNotFoundException $e) { abort(404); } });
Since uuid
gets registered as Route Key
using implicit binding[https://laravel.com/docs/5.8/routing#implicit-binding], your resource controllers will use uuid
instead of default id
column.
<?php php artisan make:controller UserController --resource
/users/{user} route uses uuid
i.e. /users/bff37872-1450-47c7-b9f7-9a6d917796cf
You may also use the withUuid
and withUuids
local query scopes with the query builder.
<?php Route::get('/user/{uuid}', function($uuid) { $user = App\User::withUuid($uuid)->first(); if (! $user) { // Do something else... } });
<?php Route::delete('/users', function(Request $request) { // Receive an array of UUIDs $uuids = $request->input('uuids'); // Try to get the Users $users = App\User::withUuids($uuids)->all(); // Handle the delete and return $users->delete(); });
Licence
This package is 100% free and open-source, under the MIT license. Use it however you want.
This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.