artisansdk/model

A self-validating model compatible with Laravel Eloquent that validates when it's saved.

dev-main 2024-04-23 02:40 UTC

Requires

• php: >=8.2
• illuminate/contracts: ~10.0 || ~11.0
• illuminate/database: ~10.0 || ~11.0
• illuminate/filesystem: ~10.0 || ~11.0
• illuminate/http: ~10.0 || ~11.0
• illuminate/support: ~10.0 || ~11.0
• illuminate/translation: ~10.0 || ~11.0
• illuminate/validation: ~10.0 || ~11.0
• watson/validating: ~8.1

Requires (Dev)

• laravel/pint: ~1.13
• nunomaduro/larastan: ~2.6
• orchestra/testbench: ^8.14
• pestphp/pest: ~2.24

MIT

• Daniel LaBarge

README

A self-validating model compatible with Laravel Eloquent that validates when it's saved.

Table of Contents

• Self-Validating Model
  • Table of Contents
  • Installation
  • Usage Guide
  • Running the Tests
  • Licensing

Installation

The package installs into a PHP application like any other PHP package:

composer require artisansdk/model

Now all you need to do is swap from the base Illuminate\Database\Eloquent\Model model to the ArtisanSdk\Model\Eloquent:

namespace App\Models;

use ArtisanSdk\Model\Eloquent as Model;

class User extends Model
{
    /**
     * Get the validation rules.
     */
    public function rules() : array
    {
        return [
            'name' => ['required', 'string', 'max:64'],
            'password' => ['required'],
        ];
    }
}

Usage Guide

<needs description>

Running the Tests

The package is unit tested with 100% line coverage and path coverage. You can run the tests by simply cloning the source, installing the dependencies, and then running ./vendor/bin/phpunit. Additionally included in the developer dependencies are some Composer scripts which can assist with Code Styling and coverage reporting:

composer check
composer coverage
composer fix
composer test
composer retry

See the composer.json for more details on their execution and reporting output.

Licensing

Copyright (c) 2018-2023 Artisan Made, Co.

This package is released under the MIT license. Please see the LICENSE file distributed with every copy of the code for commercial licensing terms.