marshmallow/metadata

一个简单为模型添加元数据的包

v1.2.0 2024-03-12 11:36 UTC

README

Latest Version on Packagist GitHub Code Style Action Status Total Downloads

通过简单的转换向任何模型添加元数据

安装

您可以通过composer安装此包

composer require marshmallow/metadata

您可以使用以下命令发布并运行迁移

php artisan vendor:publish --tag="metadata-migrations"
php artisan migrate

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="metadata-config"

这是已发布配置文件的内容

return [
    /*
     * The fully qualified class name of the metadata model.
     */
    'metadata_model' => Marshmallow\Models\Metadata::class,

    /*
     * The fully qualified class name of the metadata cast.
     */
    'metadata_cast' => Marshmallow\Casts\MetadataCast::class,
];

用法

将以下特性添加到您的模型中

use Marshmallow\Metadata\Traits\HasMetadata;

use HasMetadata;

为您的所需字段添加转换

use Marshmallow\Metadata\Casts\MetadataCast;

protected $casts = [
    'example' => MetadataCast::class,
];

之后,您可以使用常规方法获取和设置字段;

$example_model->example_field = 'This is an example';

$example_field = $example_model->example_field;
// 'This is an example'

字段中的数据将被解码和编码为json格式。

测试

composer test

变更日志

有关最近更改的更多信息,请参阅 变更日志

贡献

有关详细信息,请参阅 贡献指南

安全漏洞

请查看 我们的安全策略 了解如何报告安全漏洞。

鸣谢

许可证

MIT许可证(MIT)。有关更多信息,请参阅 许可证文件