README

Installation

You can install the package via composer:

composer require aecor/statusable

You can publish and run the migrations with:

php artisan vendor:publish --provider="Aecor\Status\StatusServiceProvider" --tag="migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --provider="Aecor\Status\StatusServiceProvider" --tag="config"

This is the contents of the published config file:

return [
    'status-table-name' => 'statuses'
];

Usage and few examples

Prepare your model

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Aecor\Status\Traits\HasStatus;

class YourModel extends Model
{
    use HasStatus;
}

Get instance of your model

$user = \App\Models\User::find(1);

All the common fields are available in database given below, additionally you can store your own details as json in 'custom_attributes' field. All the fields are kept nullable to make it easy implementation.

'name',
'type',
'custom_attributes' // json field to add any additional data
'order_column'

Add a single contact

$user->addStatus([
    [
        'name' => 'Active',
        'type' => 'user',
        'custom_attributes' => [
            'group' => 'some-text'
        ],
    ]
]);

Add multiple status

$user->addManyStatus([
    [
        'name' => 'Active',
    ],
    [
        'name' => 'De-active',
    ],
    [
        'name' => 'On-hold',
    ],
]);

Assign new status

$status = Status::where('name', 'Active')->first();
$status2 = Status::where('name', 'On-hold')->first();

$user->assignStatus($status->id);

$user->assignManyStatus([$status->id, $status2->id]);

Sync status

$status = Status::where('name', 'Active')->first();
$status2 = Status::where('name', 'On-hold')->first();

$user->syncStatus($status->id);

$user->syncManyStatus([$status->id, $status2->id]);

Get all status

$user->statuses;

Get first status

$user->status();

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

aecor / statusable

Maintainers

Details