notate/notate

Put your JSON data to work in Eloquent.

v0.0.7 2019-06-27 15:08 UTC

Requires

• php: ^7.1
• ext-json: *
• illuminate/database: ^5.6
• illuminate/support: ^5.6

Requires (Dev)

• symfony/var-dumper: 4.0

MIT

• database
• json
• laravel
• collection
• eloquent
• relationship
• notate

README

Notate is a tool for the Laravel Eloquent ORM that allows you to define HasOne, HasMany and BelongsTo relationships using properties defined in JSON on a foreign key.

Installation

Run the following command in your terminal in the directory of your Laravel project.

composer require notate/notate

Usage

Add the Notate\Notate trait to your Eloquent models, and you will be able to reference JSON columns on both ends when creating relationships.

Relationships

use Illuminate\Database\Eloquent\Model;
use Notate\Notate;
use Notate\Relations\{HasOne, HasMany, BelongsTo};

class User extends Model
{
    use Notate;

    public function guild(): HasOne
    {
        return $this->hasOne(Guild::class, 'id', 'stats->guild_id');
    }
    
    public function items(): HasMany
    {
        return $this->hasMany(Item::class, 'data->id', 'nested->some->property');
    }
    
    public function role(): BelongsTo
    {
        return $this->belongsTo(Role::class, 'name', 'stats->role->name');
    }
}

$user = User::find(1);

// user->nested->some->property == item->data->id
echo $user->items->first()->data->id;

// can use the query builder as usual
$equippedItems = $user->items()->where('equipped',0)->get();

// eager loading support
$users = User::with(['items','guild'])->get();