torann/meta-tags

Extremely simple meta tag generator.

0.0.4 2017-01-24 21:56 UTC

README

Build Status Latest Stable Version Total Downloads Patreon donate button Donate weekly to this project using Gratipay Donate to this project using Flattr Donate to this project using Paypal

Extremely simple meta tag generator.

Installation

From the command line run

$ composer require torann/meta-tags

Methods

This package comes with a dynamic tag creation method that allows for the simple creation of tags without having to have a specific method for that tag. So, what this means is even though the tag you wish to create isn't listed in the methods bellow, you can still create it (see example).

/MetaTags/Manager.php

  • tag($name, $value)
  • type($type)
  • image($path, array $attributes = [])
  • url($url = null)
  • set($name, $value, array $attributes = [])
  • get($key, $type = 'general')
  • validation($type, $attributes = [])
  • config($key, $default = null)

Example

$og = new \MetaTags\Manager();

$og->type('article')
    ->title('All Trains Run on Time')
    ->description('Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.')
    ->url()
    ->profile([
        'username' => 'Torann'
    ])
    ->image('https://upload.wikimedia.org/wikipedia/commons/9/95/Train_Station_Panorama.jpg')
    ->twitterImageAlt('Train Station in Upstate New York')
    ->twitterSite('@lyften', [
        'id' => '4Df665K',
    ])
    ->siteName('My Train Website')
    ->video('http://examples.opengraphprotocol.us/media/video/train.mp4', [
        'secure_url' => 'https://examples.opengraphprotocol.us/media/video/train.mp4'
    ]);

echo $og; // Will output all meta tags

Configuration

The config options are simple and easy to customize. Simply pass an array of new options when initializing a new instance of the Meta Tag manager.

Defaults

[
    'validate' => false,
    'twitter' => true,
    'truncate' => [
        'description' => 160,
        'twitter:title' => 70,
        'og:description' => 200,
        'twitter:description' => 200,
    ],
]

Values

  • validate: When enable the package will validate tag values and attributes, warning you when there is something wrong.
  • truncate: Is a key value pair linking the tag property value with the max number of characters allowed in the content.
  • twitter: When set to true, the package will render the basic Twitter cards from the Open Graph values. Note: this will automatically be set to true when a Twitter specific tag is set.

Configuration Example

$og = new \MetaTags\Manager([
    'validate' => true,
    'twitter' => false,
    'truncate' => [
        'description' => 200,
    ],
]);

Change Log

v0.0.1

  • First release