enginedigital / model-notes
Create notes on eloquent models. Supports multiple note types as well as multi-tenancy
Fund package maintenance!
EngineDigital
Installs: 1 619
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 4
Forks: 1
Open Issues: 0
Requires
- php: ^8.0
- illuminate/contracts: ^8.37
- spatie/laravel-package-tools: ^1.4.3
Requires (Dev)
- brianium/paratest: ^6.2
- nunomaduro/collision: ^5.3
- orchestra/testbench: ^6.15
- phpunit/phpunit: ^9.3
- spatie/laravel-ray: ^1.23
- vimeo/psalm: ^4.8
This package is auto-updated.
Last update: 2024-11-13 04:35:05 UTC
README
Create notes on eloquent models. Supports multiple note types as well as multi-tenancy.
Installation
You can install the package via composer:
composer require enginedigital/model-notes
You can publish and run the migrations with:
php artisan vendor:publish --provider="EngineDigital\Note\NoteServiceProvider" --tag="model-notes-migrations" php artisan migrate
You can publish the config file with:
php artisan vendor:publish --provider="EngineDigital\Note\NoteServiceProvider" --tag="model-notes-config"
This is the contents of the published config file:
return [ 'note_model' => EngineDigital\Note\Note::class, 'note_default_type' => 'none', 'note_default_group' => 'admin', // key => 'formatter_class_with_invoke', // key => ['formatter', 'method'], 'note_types' => [ 'none' => null, // dont touch formatted output 'plain' => 'e', // escape in formatted output 'html' => null, // dont touch formatted output 'markdown' => [\Illuminate\Support\Str::class, 'markdown'], 'json' => 'json_decode', // treat the note content as JSON ], 'model_primary_key_attribute' => 'model_id', 'encrypt_notes' => false, 'tenant_model' => null, // App\Models\Company::class 'tenant_resolver' => null, // a class that uses `__invoke` or a container function to get the id of the current tenant 'author_model' => null, // App\Models\User::class 'author_resolver' => null, // a class that uses `__invoke` or a container function to get the id of the current user 'cache_time' => null, // cache time in seconds 'load_with' => [], // which note relationships to eager load. Example: ['author', 'author.profile', 'author.roles'] or only specific columns ['author:id,name'] ];
Usage
// User model uses EngineDigital\Note\HasNotes $user->setNote('This is my cute little note!');
Testing
composer run test
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.