coreplex / meta by sixteenstudio

A PHP 5.4 Page-Meta Container that is easily extensible

1,007

Package Data
Maintainer Username:	sixteenstudio
Maintainer Contact:	matthew@sixteenstudio.com (Matthew Collison)
Package Create Date:	2015-05-12
Package Last Update:	2021-03-12
Language:	PHP
License:	MIT
Last Refreshed:	2024-11-16 15:03:45

Package Statistics
Total Downloads:	1,007
Monthly Downloads:	1
Daily Downloads:	0
Total Stars:	1
Total Watchers:	4
Total Forks:	4
Total Open Issues:	0

Meta

A PHP 5.4 Page-Meta Container that is easily extensible

Installation & Requirements

This package requires PHP 5.4 or above. To install, simply add this line to your composer.json file under the require key

"require": {
    "coreplex/meta": "0.*"
}

Laravel Integration

To use this package with Laravel, just take the following steps after installation:

Add the service provider to the providers array in your config/app.php file

'Coreplex\Meta\MetaServiceProvider',

You then need to publish the required assets using the command line. Run this command to provision this action

php artisan vendor:publish --provider="Coreplex\Meta\MetaServiceProvider"

You will then want to migrate the database tables which will act as a store for any meta items

php artisan migrate

Once you've done this, you can go ahead and start using the package, and populating the database with some example meta information.

To start, let's add in a default meta group to see it in action. Run this piece of code to create a default piece of meta:

$meta = Coreplex\Meta\Eloquent\Meta::create([
    'identifier' => 'default',
    'default' => true
]);

$meta->items()->insert(['key' => 'title', 'data' => 'Welcome to this website']);
$meta->items()->insert(['key' => 'description', 'data' => 'This is a fantastic website with lots of features and even a walrus gallery']);

This will insert the default meta record into the database, which will be used on every single page, with any addition records merged on top (unless it is overwritten, which is easy to do!). You don't have to do this, but it is a nice way to add a default set of meta data.

To render the meta data in your view, all you have to do is echo out the meta container that is bound to the app, and it will be turned into clean html.

<html>
<head>
<?php
// You will probably want to use a view composer for this line, as it is
// actually bad practice!
$meta = $app['coreplex.meta'];

// Render the meta items from the container
echo $meta;
?>
</head>
<body>
</body>
</html>

Using default configuration, this would output:

<title>Welcome to this website | MyWebsite.com</title>
<meta name="description" content="This is a fantastic website with lots of features and even a walrus gallery">

Don't forget, if you are using laravel blade, you must use the non-escaping blade echo tags ({!! !!}) or the meta will not be output correctly.

If you want to completely overwrite the meta, retrieve the meta container from your application and use the set() method to override it. You can pass in an instance of a Coreplex\Meta\Contracts\Group (The Coreplex\Meta\Eloquent\Meta model implements this), or just a string identifier which will be used to find it from the store.

$meta = Coreplex\Meta\Eloquent\Meta::create([
    'identifier' => 'login_page'
]);

$meta->items()->insert(['key' => 'title', 'data' => 'Please login to your account...']);

use Coreplex\Meta\Contracts\Container as MetaContainer;

class LoginController extends Controller {
    
    public function login(MetaContainer $container)
    {
        $container->set('login_page');
    }

}

Will then output this to the page when the meta is echoed out:

<title>Please login to your account... | MyWebsite.com</title>

If you only wish to merge but not overwrite the default styles, instead use the add() method on the container.

    public function login(MetaContainer $container)
    {
        $container->add('login_page');
    }

Which will then output a merged variant of the two meta groups we inserted

<title>Please login to your account... | MyWebsite.com</title>
<meta name="description" content="This is a fantastic website with lots of features and even a walrus gallery">

You can merge as many meta groups together, keeping in mind that the group which was last merged will overwrite any meta items that precede it which it also has

Configurating Meta Templates

The meta library knows how to render out each type of meta element differently. It does this through the config file.

In your config folder, you will find meta.php and drivers.php. Inside meta.php, you will see something similar to this:

    'elements' => [
        'title' => [
            'element' => 'title',
            'empty' => false,
            'content' => ':content | MyWebsite.com',
        ],
        'charset' => [
            'keyAttribute' => false,
            'valueAttribute' => 'charset'
        ]
    ],

This array defines how every element is display on the page. Here are each of the configuration keys you can use on each element:

element: Specifies which element will be rendered, for example, a value of title would render a <title> element. This is required
empty: Specifies whether or not the element has an opening or closing tag. If set to false, the element will always add an ending tag of the element specified
keyAttribute: Specifies if an attribute is applied to the element which holds the value of the key of the meta. For example, if you have a description element, you would usually set the keyAttribute property to name, as this would output <meta name="description" content="..."></meta> on the page. If set to false, no attribute will be added with the meta key
valueAttribute: Same behaviour as the keyAttribute property, except it places the "data" value of the meta item isntance into this attribute.
content: Allows you to create a template for a meta item. Especially useful when you want to add something like " | MyWebsite.com" after a title. Simply use :content within the string, and this will be replaced with the data value of the meta item when rendered. If your meta item has JSON Encoded data, and empty is set to false, you can use the : identifier followed by any of the keys in the JSON object to replace it with the value.
extends: Works like class extension, where you specify the key of another meta element template, and it will merge it's own properties into the one it is extending. Especially useful so that you don't repeat yourself with elements like 'og:title'. You can see examples of this by looking into the default config provided

If there is no template for the key specified in the meta_items table, it will use the meta.default value as the template, which by default renders a <meta name="{key}" content="{data}"> element, unless you choose to change this behaviour.

More data in a single meta item

If a meta is empty (has no closing tag), and the string in the "data" column of the meta_items record is JSON encoded, it will loop around each key and put it in as an attribute:

$meta = Coreplex\Meta\Eloquent\Meta::create([
    'identifier' => 'new_page'
]);

$meta->items()->insert(['key' => 'keywords', 'data' => '{content: "hello world", rel: "keywords-tag"}']);

Would yield this when rendered

<meta name="keywords" content="hello world" rel="keywords-tag">

You can just pass a standard string to the data column if you don't want multiple attributes.

Using the `HasMetaData` Trait

We've created a handy trait when you can place on your models to immediately allow it to have meta. This is done behind the scenes using a polymorphic relationship. To get this to work, simply add this to the first line of your model class:

use Coreplex\Meta\Eloquent\HasMetaData;

class Page extends Model 
{
    use HasMetaData;
}

This will add two methods to your model; hasMeta and getMeta. Using these methods you can check if the model has meta data and then retrieve it. You can also access the meta by using the meta relationship, you can use this to create and update your meta data.

When you retrieve meta it will return a Coreplex\Meta\Eloquent\Meta instance which has all the items bound to it, as we have seen in the above examples. This can then be set by doing something along the lines of this in our controllers:

public function home(MetaContainer $container)
{
    $page = Page::find(1);

    if ( ! $page) {
        abort(404);
    }

    if ($page->hasMeta()) {
        $container->add($page->getMeta());
    }
}

This works extremely well if you want to bind meta data to any database table in your system. Groups of page-meta can be bound to all sorts of things, from a pages table record in the database to a products table record.

You could quite easily write a fallback for any items which don't have a meta item by doing something like this in your controller

public function home(MetaContainer $container, $productId)
{
    $product = Product::find($productId);

    if ( ! $product) {
        abort(404);
    }

    if ($product->hasMeta()) {
        $container->add($page->getMeta());
    } else {
        // Empties any defaults out of the container
        $container->flush();

        // Add auto-generated meta data
        $container->add('title', $product->title);
        $container->add('description', $product->short_description);
    }
}

Using the `MetaVariant` Trait

We've also added the ability to have meta variants, this is useful if you have multiple countries, websites, etc. and you need to have different meta per variant.

To get started you need to implement the Variant interface, and then if you are using a model use the MetaVariant trait.

use Coreplex\Meta\Contracts\Variant;
use Coreplex\Meta\Eloquent\MetaVariant;

class Country implements Variant
{
     use MetaVariant;
}

Then you can provide the meta variant when setting or adding the meta, and it will load the meta data for the variant.

$variant = Country::find(1);

$container->add($page->getMeta($variant));

If you are using a key rather than a model to set your meta, you can pass the variant as the second parameter.

$variant = Country::find(1);

$container->set('global', $variant);

Non-Laravel Usage

A non-laravel usage guide isn't currently available. If you are however integrating with Laravel 5, follow the above steps