plank/laravel-metable

A package for attaching arbitrary data to Eloquent models

6.1.0 2024-12-05 02:34 UTC

Requires

• php: >=8.1
• ext-json: *
• illuminate/database: ^10.48.25|^11.34.0
• illuminate/support: ^10.48.25|^11.34.0
• phpoption/phpoption: ^1.9.3

Requires (Dev)

• guzzlehttp/guzzle: ^7.9
• guzzlehttp/promises: ^1.5
• laravel/legacy-factories: ^1.4.0
• mockery/mockery: ^1.6.0
• nesbot/carbon: ^2.72.0
• orchestra/testbench: ^9.0
• php-coveralls/php-coveralls: ^2.7.0
• phpunit/phpunit: ^10.5

MIT

• Sean Fraser

README

Laravel-Metable is a package for easily attaching arbitrary data to Eloquent models.

Features

• One-to-many polymorphic relationship allows attaching data to Eloquent models without needing to adjust the database schema.
• Type conversion system allows data of numerous different scalar and object types to be stored and retrieved. See the documentation for the list of supported types.

Example Usage

Attach some metadata to an eloquent model

$post = Post::create($this->request->input());
$post->setMeta('color', 'blue');

Query the model by its metadata

$post = Post::whereMeta('color', 'blue');

Retrieve the metadata from a model

$value = $post->getMeta('color');

Installation

1. Add the package to your Laravel app using composer

composer require plank/laravel-metable

1. Register the package's service provider in config/app.php. In Laravel versions 5.5 and beyond, this step can be skipped if package auto-discovery is enabled.

'providers' => [
    ...
    Plank\Metable\MetableServiceProvider::class,
    ...
];

1. Publish the config file (config/metable.php) of the package using artisan.

php artisan vendor:publish --provider="Plank\Metable\MetableServiceProvider"

1. Run the migrations to add the required table to your database.

php artisan migrate

1. Add the Plank\Metable\Metable trait to any eloquent model class that you want to be able to attach metadata to.

Note: If need a more generic way to reference different Metable Model classes, you can optionally apply the Plank\Metable\MetableInterface to your models.

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Plank\Metable\Metable;

class Post extends Model
{
    use Metable;

    //...
}

Documentation

The full documentation is available on ReadTheDocs.

License

This package is released under the MIT license (MIT).

About Plank

Plank is a web development agency based in Montreal, Canada.