PHPackages                             ewereka/laravel-metable - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database &amp; ORM](/categories/database)
4. /
5. ewereka/laravel-metable

ActiveLibrary[Database &amp; ORM](/categories/database)

ewereka/laravel-metable
=======================

Fluent metadata for Eloquent Models, as if it is a property on your model.

v1.0.0(6y ago)014MITPHPPHP &gt;=7.2.0

Since Sep 3Pushed 6y ago1 watchersCompare

[ Source](https://github.com/ewereka/laravel-metable)[ Packagist](https://packagist.org/packages/ewereka/laravel-metable)[ RSS](/packages/ewereka-laravel-metable/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (1)Versions (5)Used By (0)

Fluent Meta Data for Eloquent Models
====================================

[](#fluent-meta-data-for-eloquent-models)

[![Laravel](https://camo.githubusercontent.com/15a49f312486dc0856b59eabb22bb9f69c1ac9ff7ef930d5bcd24009b7a0968b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d2533453d352e302d6f72616e67652e7376673f7374796c653d666c61742d737175617265)](http://laravel.com)[![Source](https://camo.githubusercontent.com/8b153b9f64c318dc248a6f03af8cd1a14620f640a44107fe3c11e781aef5bf97/687474703a2f2f696d672e736869656c64732e696f2f62616467652f736f757263652d65776572656b612f6c61726176656c2d2d6d657461626c652d626c75652e7376673f7374796c653d666c61742d737175617265)](https://github.com/ewereka/laravel-metable/)[![License](https://camo.githubusercontent.com/30597ff9a350144f03bffdd9183e16468e0b3ca1193e1d08591d992622738d55/687474703a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](https://tldrlegal.com/license/mit-license)

Metable Trait adds the ability to access meta data as if it is a property on your model. Metable is Fluent, just like using an eloquent model attribute you can set or unset metas. Follow along the documentation to find out more.

Installation
------------

[](#installation)

#### Composer

[](#composer)

Add this to your composer.json file, in the require object:

```
"ewereka/laravel-metable": "dev-master"
```

After that, run composer install to install the package.

#### Migration Table Schema

[](#migration-table-schema)

```
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
    Schema::create('posts_meta', function (Blueprint $table) {
        $table->increments('id');

        $table->integer('post_id')->unsigned()->index();
        $table->foreign('post_id')->references('id')->on('posts')->onDelete('cascade');

        $table->string('type')->default('null');

        $table->string('key')->index();
        $table->text('value')->nullable();

        $table->timestamps();
    });
}

/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
    Schema::drop('posts_meta');
}
```

Configuration
-------------

[](#configuration)

#### Model Setup

[](#model-setup)

Next, add the `Metable` trait to each of your metable model definition:

```
use Ewereka\Metable\Metable;

class Post extends Eloquent
{
    use Metable;
}
```

Metable Trait will automatically set the meta table based on your model name. Default meta table name would be, `model_meta`. In case you need to define your own meta table name, you can specify in model:

```
class Post extends Eloquent
{
    protected $metaTable = 'posts_meta'; //optional.
}
```

#### Gotcha

[](#gotcha)

When you extend a model and still want to use the same meta table you must override `getMetaKeyName` function.

```
class Post extends Eloquent
{

}

class Slideshow extends Post
{
    protected function getMetaKeyName()
    {
        return 'post_id' // The parent foreign key
    }
}

```

Working With Meta
-----------------

[](#working-with-meta)

#### Setting Content Meta

[](#setting-content-meta)

To set a meta value on an existing piece of content or create a new data:

> **Fluent way**, You can **set meta flawlessly** as you do on your regular eloquent models. Metable checks if attribute belongs to model, if not it will access meta model to append or set a new meta.

```
$post = Post::find(1);
$post->name = 'hello world'; // model attribute
$post->content = 'some content goes here'; // meta data attribute
$post->save(); // save attributes to respective tables
```

Or

```
$post = Post::find(1);
$post->name = 'hello world'; // model attribute
$post->setMeta('content', 'Some content here');
$post->save();
```

Or `set multiple metas` at once:

```
...
$post->setMeta([
    'content' => 'Some content here',
    'views' => 1,
]);
$post->save();
```

> **Note:** If a piece of content already has a meta the existing value will be updated.

#### Unsetting Content Meta

[](#unsetting-content-meta)

Similarly, you may unset meta from an existing piece of content:

> **Fluent way** to unset.

```
$post = Post::find(1);
$post->name // model attribute
unset($post->content) // delete meta on save
$post->save();
```

Or

```
$post->unsetMeta('content');
$post->save();
```

Or `unset multiple metas` at once:

```
$post->unsetMeta('content,views');
// or
$post->unsetMeta('content|views');
// or
$post->unsetMeta('content', 'views');
// or array
$post->unsetMeta(['content', 'views']);

$post->save();
```

> **Note:** The system will not throw an error if the content does not have the requested meta.

#### Checking for Metas

[](#checking-for-metas)

To see if a piece of content has a meta:

> **Fluent way**, Metable is clever enough to understand $post-&gt;content is an attribute of meta.

```
if (isset($post->content)) {

}
```

#### Retrieving Meta

[](#retrieving-meta)

To retrieve a meta value on a piece of content, use the `getMeta` method:

> **Fluent way**, You can access meta data as if it is a property on your model. Just like you do on your regular eloquent models.

```
$post = Post::find(1);
dump($post->name);
dump($post->content); // will access meta.
```

Or

```
$post = $post->getMeta('content');
```

Or specify a default value, if not set:

```
$post = $post->getMeta('content', 'Something');
```

You may also retrieve more than one meta at a time and get an illuminate collection:

```
// using comma or pipe
$post = $post->getMeta('content|views');
// or an array
$post = $post->getMeta(['content', 'views']);
```

#### Retrieving All Metas

[](#retrieving-all-metas)

To fetch all metas associated with a piece of content, use the `getMeta` without any params

```
$metas = $post->getMeta();
```

#### Retrieving an Array of All Metas

[](#retrieving-an-array-of-all-metas)

To fetch all metas associated with a piece of content and return them as an array, use the `toArray` method:

```
$metas = $post->getMeta()->toArray();
```

#### Meta Table Join

[](#meta-table-join)

When you need to filter your model based on the meta data , you can use `meta` scope in Eloquent Query Builder.

```
$post = Post::meta()
    ->where(function($query){
          $query->where('posts_meta.key', '=', 'revision')
                ->where('posts_meta.value', '=', 'draft');
    })
```

#### Eager Loading

[](#eager-loading)

When you need to retrieve multiple results from your model, you can eager load `metas`

```
$post = Post::with(['metas'])->get();

```

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

4

Last Release

2439d ago

Major Versions

v0.0.3 → v1.0.02019-09-07

### Community

Maintainers

![](https://www.gravatar.com/avatar/bc0a44f0cb7e2bcbe8c07f68c38fe2a23b70778201c765960e7e5bcc409776df?d=identicon)[seanmetzgar](/maintainers/seanmetzgar)

---

Top Contributors

[![seanmetzgar](https://avatars.githubusercontent.com/u/182424?v=4)](https://github.com/seanmetzgar "seanmetzgar (4 commits)")

---

Tags

laraveldatamodeleloquentmetadatametameta datametasmetableewereka

### Embed Badge

![Health badge](/badges/ewereka-laravel-metable/health.svg)

```
[![Health](https://phpackages.com/badges/ewereka-laravel-metable/health.svg)](https://phpackages.com/packages/ewereka-laravel-metable)
```

###  Alternatives

[kodeine/laravel-meta

Fluent Meta Data for Eloquent Models, as if it is a property on your model.

426756.0k9](/packages/kodeine-laravel-meta)[mongodb/laravel-mongodb

A MongoDB based Eloquent model and Query builder for Laravel

7.1k7.2M71](/packages/mongodb-laravel-mongodb)[tucker-eric/eloquentfilter

An Eloquent way to filter Eloquent Models

1.8k4.8M26](/packages/tucker-eric-eloquentfilter)[dyrynda/laravel-model-uuid

This package allows you to easily work with UUIDs in your Laravel models.

4802.8M8](/packages/dyrynda-laravel-model-uuid)[spiritix/lada-cache

A Redis based, automated and scalable database caching layer for Laravel

591444.8k2](/packages/spiritix-lada-cache)[mmanos/laravel-metable

A meta package for Laravel 4 models.

142.3k](/packages/mmanos-laravel-metable)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
