marshmallow / metadata
A package to simply add metadata to models
Installs: 2 718
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 3
Requires
- php: ^8.0
- illuminate/contracts: ^9.0|^10.0|^11.0
- spatie/laravel-package-tools: ^1.13.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^6.0
- orchestra/testbench: ^7.0|^8.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.1
- phpunit/phpunit: ^9.5
- spatie/laravel-ray: ^1.26
This package is auto-updated.
Last update: 2024-11-15 14:31:16 UTC
README
Add metadata to any model with a simple cast
Installation
You can install the package via composer:
composer require marshmallow/metadata
You can publish and run the migrations with:
php artisan vendor:publish --tag="metadata-migrations"
php artisan migrate
You can publish the config file with:
php artisan vendor:publish --tag="metadata-config"
This is the contents of the published config file:
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, ];
Usage
Add the following trait to your model
use Marshmallow\Metadata\Traits\HasMetadata; use HasMetadata;
Add add cast for your required field.
use Marshmallow\Metadata\Casts\MetadataCast; protected $casts = [ 'example' => MetadataCast::class, ];
After which you can get & set your field using normal methods;
$example_model->example_field = 'This is an example'; $example_field = $example_model->example_field; // 'This is an example'
The data from the field will be decoded & encoded to a json format.
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.