Add Notes to your models in your Laravel Applications.
You can install the package via composer:
composer require alphaolomi/laravel-notes
You can publish and run the migrations with:
php artisan vendor:publish --tag="notes-migrations"
php artisan migrate
You can publish the config file with:
php artisan vendor:publish --tag="notes-config"
This is the contents of the published config file:
return [
'model' => \AlphaOlomi\Notes\Models\Note::class,
'user' => \App\Models\User::class,
];
Start by using the AlphaOlomi\Notes\Concerns\HasNotes
trait on your model.
use AlphaOlomi\Notes\Concerns\HasNotes;
class Project extends Model
{
use HasNotes;
}
This trait adds a notes(): MorphMany
relationship on your model. It also adds a new Note()
method that can be used to quickly add a Note to your model.
$project = Project::first();
$project->addNote('This is a note.');
By default, the package will use the authenticated user's ID as the "Noter". You can customize this by providing a custom User
to the Note()
method.
$project->addNote('This ia a another note.', user: User::first());
The package also supports parent -> children
relationships for notes. This means that a Note can belongTo
another Note.
$project->addNote('Thanks you!', parent: Note::find(2));
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.