artisansdk/model

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

dev-main 2023-11-08 16:16 UTC

This package is auto-updated.

Last update: 2024-02-08 16:55:51 UTC


README

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

Table of Contents

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.