alphaolomi / laravel-notes
为 Laravel 模型添加备注。
v0.2.0
2023-09-11 09:37 UTC
Requires
- php: ^8.1
- illuminate/contracts: ^9.0
- illuminate/database: ^9.0
- spatie/laravel-package-tools: ^1.9.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.8
- nunomaduro/collision: ^6.0
- nunomaduro/larastan: ^2.0.1
- orchestra/testbench: ^7.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.1
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: ^9.5
- spatie/laravel-ray: ^1.26
This package is auto-updated.
Last update: 2024-09-21 03:55:45 UTC
README
安装
您可以通过 composer 安装此包。
composer require alphaolomi/laravel-notes
您可以使用以下命令发布和运行迁移:
php artisan vendor:publish --tag="notes-migrations"
php artisan migrate
您可以使用以下命令发布配置文件:
php artisan vendor:publish --tag="notes-config"
这是已发布配置文件的内容
return [ 'model' => \AlphaOlomi\Notes\Models\Note::class, 'user' => \App\Models\User::class, ];
用法
首先,在您的模型上使用 AlphaOlomi\Notes\Concerns\HasNotes
trait。
use AlphaOlomi\Notes\Concerns\HasNotes; class Project extends Model { use HasNotes; }
此 trait 在您的模型上添加了一个 notes(): MorphMany
关联。它还添加了一个新的 Note()
方法,可以用来快速向模型添加备注。
$project = Project::first(); $project->addNote('This is a note.');
默认情况下,此包将使用认证用户的 ID 作为 "Noter"。您可以通过向 Note()
方法提供一个自定义的 User
来自定义此设置。
$project->addNote('This ia a another note.', user: User::first());
此包还支持备注的 parent -> children
关系。这意味着一个备注可以 belongTo
另一个备注。
$project->addNote('Thanks you!', parent: Note::find(2));
测试
composer test
更新日志
有关最近更改的更多信息,请参阅 更新日志。
贡献
有关详细信息,请参阅 贡献指南。
安全漏洞
请参阅 我们的安全策略 了解如何报告安全漏洞。
鸣谢
许可
MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件。