README

为您的Laravel应用提供的内部笔记服务。这并非“博客评论服务”。

安装和用法

此包需要PHP 7和Laravel 5.6或更高版本。

php composer require binary-cats\laranote

发布迁移

php artisan vendor:publish --provider=BinaryCats\\Laranote\\LaranoteServiceProvider --tag=migrations

可选，发布配置

php artisan vendor:publish --provider=BinaryCats\\Laranote\\LaranoteServiceProvider --tag=config

对于您想要添加笔记的任何模型，将BinaryCats\Laranote\HasManyNotes导入为

use BinaryCats\Laranote\HasManyNotes;

class User extends Model

    use HasManyNotes;

要获取所有笔记，使用notes()方法。

添加新笔记

$user->note('This is a note content');

将自动使用当前登录用户添加笔记。您可以将true作为第二个参数传递，以使笔记为私密。

使用其他用户添加新笔记

$user = User::find(2);

$user->addNoteAsUser($user, 'This is a note content');

您可以将true作为第三个参数传递，以使此笔记为私密。

附加功能

ContextKey

除了notes()关系外，HasManyNotes还添加了makeContextKey()，该功能对模型形态类和主键进行加密。此值可用作所有者键，如果想要一个统一的笔记API服务。

Request类中的上下文宏

为了在应用传入端利用上下文键，Illuminate\Http\Request类扩展了三个宏

decryptContextKey() - 解密字符串为数组
makeContext() - 从解密键创建模型实例
resolveContext() -> 从数据库中解析模型实例。

开发路线图

resolveContext()应包括已删除的模型，如果模型支持软删除
删除上下文应导致软删除笔记，可配置
一个引导式插入组件
一个vuejs插入组件
全局私密笔记作用域

composer test

测试

使用以下命令运行测试

composer test

变更日志

请参阅CHANGELOG了解最近更改的详细信息。

贡献

请参阅CONTRIBUTING以获取详细信息。

安全

如果您发现任何安全相关的问题，请通过info@binarycats.io发送电子邮件，而不是使用问题跟踪器。

鸣谢

支持我们

Binary Cats是一家位于伊利诺伊州罗塞尔的网站服务公司。

您的业务是否依赖于我们的贡献？请与我们联系！所有承诺都将用于分配人力资源以维护和新奇事物。

许可

MIT许可（MIT）。请参阅许可文件以获取更多信息。

binary-cats / laranote

维护者

详细信息