https://github.com/labrodev/laravel-uuidable

Uuidable is a Laravel package that provides a reusable trait for automatically assigning a UUID to Eloquent models upon their creation. This package utilizes the Ramsey UUID library to ensure UUIDs are generated in a standard and reliable manner.
https://github.com/labrodev/laravel-uuidable

laravel laravel-eloquent-models laravel-model laravel-packages laravel-trait laravel-uuid

Last synced: 14 days ago
JSON representation

Uuidable is a Laravel package that provides a reusable trait for automatically assigning a UUID to Eloquent models upon their creation. This package utilizes the Ramsey UUID library to ensure UUIDs are generated in a standard and reliable manner.

• Host: GitHub
• URL: https://github.com/labrodev/laravel-uuidable
• Owner: labrodev
• License: mit
• Created: 2024-06-23T15:06:07.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-23T19:00:51.000Z (6 months ago)
• Last Synced: 2024-11-06T20:50:32.266Z (about 2 months ago)
• Topics: laravel, laravel-eloquent-models, laravel-model, laravel-packages, laravel-trait, laravel-uuid
• Language: PHP
• Homepage: https://labrodev.substack.com/p/uuid-generation-in-eloquent-models
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Uuidable for Laravel

Uuidable is a Laravel package that provides a reusable trait for automatically assigning a UUID to Eloquent models upon their creation. This package utilizes the Ramsey UUID library to ensure UUIDs are generated in a standard and reliable manner.

## Installation

To install the package, run the following command in your Laravel project:

```bash

composer require labrodev/uuidable

```

## Requirements

- PHP 8.1 or higher

## Configuration

After installing the package, no additional configuration is needed to start using the UUID trait in your models.

## Usage

To use the `ModelHasUuid` trait, simply include it in your Eloquent model:

```php 

uuid('uuid');

```

## Override uuid column name

If the column in your database table designated for UUID storage has a name different from the default, you can customize the trait to accommodate this. 

Simply override the trait method in your model by adding the following method with your specific column name:

```php 

/**

* @return string

*/

protected function fetchUuidColumn(): string

{

    return 'your-uuid-column-name';

}

```

## Testing

To run the tests included with the package, execute the following command:

```bash

composer test

```

For static analysis to check the package code, execute the followin command: 

```bash

composer analyse

```

## Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

## Credits

Labro Dev

## License

The MIT License (MIT). Please see License File for more information.

## Read more

Read more about this topic on our [Substack page - Labrodev](https://labrodev.substack.com/p/uuid-generation-in-eloquent-models).