neuecommerce/visible-records

Handle visibility state on your Laravel Eloquent model records.

dev-main / 1.0.x-dev 2024-03-22 20:40 UTC

Requires

• php: ^8.3
• illuminate/database: ^11.0
• nesbot/carbon: ^3.0

Requires (Dev)

• neuecommerce/coding-standards: dev-main
• orchestra/testbench: ^9.0
• pestphp/pest: ^2.13
• phpunit/phpunit: ^11.0

MIT

• Neue Commerce Team

• php
• model
• visibility
• visible
• laravel
• eloquent
• neuecommerce

README

An Activity Logger for Laravel Eloquent models.

Installation

1. Install the package via Composer:

composer require neuecommerce/visible-records

Implementation

Automatic

Implementing the Visible Records package on your Eloquent models, is quite simple and can be done in 3 just simple steps:

1. Implement the NeueCommerce\VisibleRecords\HasVisibilityInterface interface on your model(s).

2. Implement the NeueCommerce\VisibleRecords\HasVisibility trait on your model(s).

3. Create a database migration that adds the visibile_at nullable timestamp column to your model(s) table.

Here's an example of a model with the proper implementation:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use NeueCommerce\VisibleRecords\HasVisibilityInterface;
use NeueCommerce\VisibleRecords\HasVisibility;

class Product extends Model implements HasVisibilityInterface
{
    use HasVisibility;

    public $table = 'products';
}

Here's an example of a database migration:

<?php

...

Usage

...

Testing

composer test

Contributing

Thank you for your interest. Here are some of the many ways to contribute.

• Check out our contributing guide
• Look at our code of conduct

License

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