3.6 KiB

Raw Blame History

Laravel Meta-Articles

The Framework for Meta enabled Laravel models.

Install

Via Composer

$ composer require glmdev/meta

Update the Laravel Framework

Add the following provider to config/app.php

'providers' => [
    Glmdev\Meta\MetaServiceProvider::class
]

Usage

When declaring a new model, extend the Meta model:

<?php

namespace App;

use Glmdev\Meta\Meta;

class Post extends Meta 
{
    // fillable, hidden, etc. arrays
}

Important: do not extend the Model class, Meta does this for you

Then, include the 'meta' and 'uuid' columns in your database table:

In your migration,

<?php

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

use Glmdev\Meta\Meta;

class CreatePostsTable extends Migration
{
    public function up()
    {
        Schema::create('posts', function (Blueprint $table) {
            // all your table values
            Meta::formTable($table);
        });
    }
}

Then, when you create a new model, a Post in this case, your function would look something like this:

public function createPost () {
    $post = Post::create([
        // post data
    ]);
    
    $post->setUuid();
}

You now have access to a universal identifier for every model in the entire project.

You can check if a model has a UUID, and get it if it does:

$post->hasUuid(); // returns true or false
$post->getUuid(); // returns the UUID if it exists, else null

The other big feature of the Meta model is saving meta information. This information is stored in the database in one column: 'meta'

To save meta information, use the 'write' method.

$post->write('author', 'Bob Saget');

And to retrieve meta information, use the 'read' method.

$post->read('author'); //returns 'Bob Saget'

Credits

License and Copyright

Copyright (C) 2016 Garrett Mills

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Please see License File for more details.

3.6 KiB Raw Blame History