floor9design/laravel-casts-uuid

A class for casting ramsey/uuid into laravel models

1.1.1 2023-02-16 01:09 UTC

This package is auto-updated.

Last update: 2024-12-16 04:57:04 UTC


README

Latest Version Software License

Build Status Build Status

Github Downloads Packagist Downloads

Introduction

The Laravel Framework supports casting of types within models. This class adds the ramsey/uuid UUID class support for laravel models.

Install

Add the following to the composer.json:

    "require": {
        "floor9design/laravel-casts-uuid": "^1.0",
    }

Setup

There are no specific config setup steps required. The class should autoload in PSR-4 compliant systems. If you are using the class on its own, simply include it when using a model:

use Floor9design\LaravelCasts\Uuid as UuidCasts;

protected $casts = [
    'uuid' => UuidCasts::class
];

Note the alias - often it is useful to alias the casting class as it can clash with other Uuid classes, such as the base Uuid class:

use Ramsey\Uuid\Uuid;

// somewhere in the code:
$uuid = Uuid::uuid4();

Testing

Build Status Build Status

Tests can be run as follows:

  • ./vendor/phpunit/phpunit/phpunit

Static analysis/code review can be performed by using phpstan:

  • ./vendor/bin/phpstan

The following tests and also creates code coverage (usually maintained at 100%)

  • ./vendor/phpunit/phpunit/phpunit --coverage-html docs/tests/

Credits

Changelog

A changelog is generated here:

License

This software is proprietary.