garf/laravel-title

Convenient seo-titles assembler for your web application

v2.0.1 2016-09-27 08:53 UTC

README

Software License Laravel Version Packagist Licence

Let your site to have nice SEO-titles on Laravel 5.

Sometimes, creating seo-titles may be tricky. Just try this package and you will be happy!

Install

Add

"garf/laravel-title": "2.*"

to your composer.json file into require section.

Then type in console

$ composer update

When update completed, add to your config/app.conf file to providers section

'providers' => [
    // ...
    Garf\LaravelTitle\LaravelTitleServiceProvider::class,
]

If you want to use Title facade, add to same file at the aliases section

'aliases' => [
    // ...
  'Title' => Garf\LaravelTitle\TitleFacade::class,
]

Publishing configs

Type in your console:

php artisan vendor:publish --provider="Garf\LaravelTitle\LaravelTitleServiceProvider"

Usage

Add segment to the end

Title::append('Title segment');

Add segment to the beginning

Title::prepend('Title segment');

Display title

Title::render([$delimiter = null, $no_additions = false]);

Additionally, you can add parameters to this method:

  • first parameter $delimiter sets the delimiter config manually. If null, will be used default delimiter
  • second parameter $no_additions will cancel suffix and prefix adding to rendered title. Also sets on_empty config parameter to empty string.
Title::renderr([$delimiter = null, $no_additions = false]);

This method is similar to render() method, except it will render title in reversed order.

Check if segments exist

Title::has();

Render custom title

Title::make(Array $segments, [$delimiter = ' - ', $suffix = '', $prefix = '', $on_empty = '']);

Method will return title with your own params

Clear title stack

Title::clear();

Method will empty title segments.

Get raw segments array

Title::get();

Get segments in JSON-object

Title::toJson();

Plans

  • add variables to JS export
  • additional meta-tags

Contributions

Contributions are highly appreciated.

Send your pull requests to master branch.

License

The MIT License (MIT). Please see License File for more information.