├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── composer.json
└── src
    └── Traits
        ├── HasUUID.php
        └── UUIDIsPrimaryKey.php


/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 | All notable changes to this project will be documented in this file.
3 | 
4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6 | 
7 | ## [1.0.2] - 2019-05-07
8 | - Added additional testing and doc files
9 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2019 Binary Cabin
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Laravel-UUID
 2 | 
 3 | [![Build Status](https://travis-ci.org/binarycabin/laravel-uuid.svg?branch=master)](https://travis-ci.org/binarycabin/laravel-uuid)
 4 | [![StyleCI](https://github.styleci.io/repos/110678597/shield?branch=master)](https://github.styleci.io/repos/110678597)
 5 | [![Latest Stable Version](http://img.shields.io/packagist/v/binarycabin/laravel-uuid.svg?style=flat)](https://packagist.org/packages/binarycabin/laravel-uuid)
 6 | [![Total Downloads](http://img.shields.io/packagist/dt/binarycabin/laravel-uuid.svg?style=flat)](https://packagist.org/packages/binarycabin/laravel-uuid)
 7 | 
 8 | A wrapper for webpatser/laravel-uuid with additional integration
 9 | 
10 | ```bash
11 | composer require binarycabin/laravel-uuid
12 | ```
13 | 
14 | This package adds a very simple trait to automatically generate a UUID for your Models.
15 | 
16 | Simply add the "\BinaryCabin\LaravelUUID\Traits\HasUUID;" trait to your model:
17 | 
18 | ```php
19 | <?php
20 | 
21 | namespace App;
22 | 
23 | use BinaryCabin\LaravelUUID\Traits\HasUUID;
24 | use Illuminate\Database\Eloquent\Model;
25 | 
26 | class Project extends Model
27 | {
28 | 
29 |     use HasUUID;
30 | 
31 | }
32 | ```
33 | 
34 | If your column name is not "uuid", simply add a new property to your model named "uuidFieldName":
35 | 
36 | ```php
37 | protected $uuidFieldName = 'unique_id';
38 | ```
39 | 
40 | This trait also adds a scope:
41 | 
42 | ```php
43 | \App\Project::byUUID('uuid')->first();
44 | ```
45 | 
46 | And static find method:
47 | 
48 | ```php
49 | \App\Project::findByUUID('uuid')
50 | ```
51 | 
52 | A second trait is available if you use your UUIDs as primary keys:
53 | 
54 | ```php
55 | <?php
56 | 
57 | namespace App;
58 | 
59 | use BinaryCabin\LaravelUUID\Traits\HasUUID;
60 | use BinaryCabin\LaravelUUID\Traits\UUIDIsPrimaryKey;
61 | use Illuminate\Database\Eloquent\Model;
62 | 
63 | class Project extends Model
64 | {
65 | 
66 |     use HasUUID, UUIDIsPrimaryKey;
67 | 
68 | }
69 | ```
70 | 
71 | It simply tells Laravel that your primary key isn't an auto-incrementing integer, so it will treat the value correctly.
72 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "binarycabin/laravel-uuid",
 3 |     "description": "A wrapper for webpatser/laravel-uuid with additional integration",
 4 |     "keywords": ["laravel"],
 5 |     "type": "library",
 6 |     "require": {
 7 |         "webpatser/laravel-uuid": "2.*"
 8 |     },
 9 |     "license": "MIT",
10 |     "authors": [
11 |         {
12 |             "name": "Jeff Kilroy",
13 |             "email": "jeff@binarycabin.com"
14 |         }
15 |     ],
16 |     "autoload": {
17 |         "psr-4": {
18 |             "BinaryCabin\\LaravelUUID\\": "src/"
19 |         }
20 |     },
21 |     "autoload-dev":{
22 |         "psr-4": {
23 |             "BinaryCabin\\LaravelUUID\\Tests\\": "tests"
24 |         }
25 |     },
26 |     "require-dev": {
27 |         "phpunit/phpunit": ">5.0"
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Traits/HasUUID.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BinaryCabin\LaravelUUID\Traits;
 4 | 
 5 | trait HasUUID
 6 | {
 7 |     public static function bootHasUUID()
 8 |     {
 9 |         static::creating(function ($model) {
10 |             $uuidFieldName = $model->getUUIDFieldName();
11 |             if (empty($model->$uuidFieldName)) {
12 |                 $model->$uuidFieldName = static::generateUUID();
13 |             }
14 |         });
15 |     }
16 | 
17 |     public function getUUIDFieldName()
18 |     {
19 |         if (! empty($this->uuidFieldName)) {
20 |             return $this->uuidFieldName;
21 |         }
22 | 
23 |         return 'uuid';
24 |     }
25 | 
26 |     public static function generateUUID()
27 |     {
28 |         return \Uuid::generate()->string;
29 |     }
30 | 
31 |     public function scopeByUUID($query, $uuid)
32 |     {
33 |         return $query->where($this->getUUIDFieldName(), $uuid);
34 |     }
35 | 
36 |     public static function findByUuid($uuid)
37 |     {
38 |         return static::byUUID($uuid)->first();
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Traits/UUIDIsPrimaryKey.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BinaryCabin\LaravelUUID\Traits;
 4 | 
 5 | trait UUIDIsPrimaryKey
 6 | {
 7 |     public function getIncrementing()
 8 |     {
 9 |         return false;
10 |     }
11 | 
12 |     public function getKeyType()
13 |     {
14 |         return 'string';
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------