PHPackages                             vortechron/laravel-meta - 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 & ORM](/categories/database)
4. /
5. vortechron/laravel-meta

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

vortechron/laravel-meta
=======================

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

07PHP

Since Nov 8Pushed 8y agoCompare

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

READMEChangelogDependenciesVersions (2)Used By (0)

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

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

[![Laravel](https://camo.githubusercontent.com/9392e682b195e01d5a658f91f6a63ae5213c64d557887643c897cedbfb52c0a1/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d7e352e312d6f72616e67652e7376673f7374796c653d666c61742d737175617265)](http://laravel.com)[![Source](https://camo.githubusercontent.com/23388f4cddf7a7a045716b5ac4c68dedc7947c2b33102aba548df3cde0ae8e2e/687474703a2f2f696d672e736869656c64732e696f2f62616467652f736f757263652d6b6f6465696e652f6c61726176656c2d2d6d6574612d626c75652e7376673f7374796c653d666c61742d737175617265)](https://github.com/kodeine/laravel-meta/)[![Build Status](https://camo.githubusercontent.com/f68fb93b5f112eb1366b9d78123b99058df3aeb88b36bdf5d4e6684ed982cdc9/687474703a2f2f696d672e736869656c64732e696f2f7472617669732f6b6f6465696e652f6c61726176656c2d2d6d6574612f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/kodeine/laravel-meta)[![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:

```
"kodeine/laravel-meta": "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 Kodeine\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->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 retrive multiple results from your model, you can eager load `metas`

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

```

###  Health Score

21

—

LowBetter than 19% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

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.

### Community

Maintainers

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

---

Top Contributors

[![kodeine](https://avatars.githubusercontent.com/u/8620059?v=4)](https://github.com/kodeine "kodeine (17 commits)")[![todiadiyatmo](https://avatars.githubusercontent.com/u/2767210?v=4)](https://github.com/todiadiyatmo "todiadiyatmo (5 commits)")[![olsgreen](https://avatars.githubusercontent.com/u/1324164?v=4)](https://github.com/olsgreen "olsgreen (4 commits)")[![AoumiS](https://avatars.githubusercontent.com/u/2528896?v=4)](https://github.com/AoumiS "AoumiS (3 commits)")[![sumityadav](https://avatars.githubusercontent.com/u/169143?v=4)](https://github.com/sumityadav "sumityadav (2 commits)")[![ray1618](https://avatars.githubusercontent.com/u/2294555?v=4)](https://github.com/ray1618 "ray1618 (1 commits)")[![rimthong](https://avatars.githubusercontent.com/u/789140?v=4)](https://github.com/rimthong "rimthong (1 commits)")[![shemi](https://avatars.githubusercontent.com/u/10219407?v=4)](https://github.com/shemi "shemi (1 commits)")[![hammat](https://avatars.githubusercontent.com/u/1468343?v=4)](https://github.com/hammat "hammat (1 commits)")

### Embed Badge

![Health badge](/badges/vortechron-laravel-meta/health.svg)

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

###  Alternatives

[doctrine/orm

Object-Relational-Mapper for PHP

10.2k285.3M6.2k](/packages/doctrine-orm)[jdorn/sql-formatter

a PHP SQL highlighting library

3.9k115.1M102](/packages/jdorn-sql-formatter)[illuminate/database

The Illuminate Database package.

2.8k52.4M9.3k](/packages/illuminate-database)[mongodb/mongodb

MongoDB driver library

1.6k64.0M545](/packages/mongodb-mongodb)[ramsey/uuid-doctrine

Use ramsey/uuid as a Doctrine field type.

90340.3M211](/packages/ramsey-uuid-doctrine)[reliese/laravel

Reliese Components for Laravel Framework code generation.

1.7k3.4M16](/packages/reliese-laravel)

PHPackages © 2026

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