webwizo/laravel-shortcodes

Wordpress like shortcodes for Laravel 5.x

Laravel-Shortcodes

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads] , _(*1)

WordPress like shortcodes for Laravel 5.x, _(*2)

[b class="bold"]Bold text[/b]

[tabs]
  [tab]Tab 1[/tab]
  [tab]Tab 2[/tab]
[/tabs]

[user id="1" display="name"]

If you are looking for Laravel 4.2, see: https://github.com/patrickbrouwers/Laravel-Shortcodes, _(*3)

Install

Via Composer, _(*4)

``` bash $ composer require "webwizo/laravel-shortcodes:1.0.*", <sub>(*5)</sub>

After updating composer, add the ServiceProvider to the providers array in `config/app.php`

## Usage

```php
Webwizo\Shortcodes\ShortcodesServiceProvider::class,

You can use the facade for shorter code. Add this to your aliases:, <sub>(*6)</sub>

'Shortcode' => Webwizo\Shortcodes\Facades\Shortcode::class,

The class is bound to the ioC as shortcode, <sub>(*7)</sub>

$shortcode = app('shortcode');

Usage

withShortcodes()

To enable the view compiling features:, <sub>(*8)</sub>

return view('view')->withShortcodes();

This will enable shortcode rendering for that view only., <sub>(*9)</sub>

Enable through class

Shortcode::enable();

Disable through class

Shortcode::disable();

Disabling some views from shortcode compiling

With the config set to true, you can disable the compiling per view., <sub>(*10)</sub>

return view('view')->withoutShortcodes();

Default compiling

To use default compiling:, <sub>(*11)</sub>

Shortcode::compile($contents);

Strip shortcodes from rendered view.

return view('view')->withStripShortcodes();

Strip shortcode through class

Shortcode::strip($contents);

Registering new shortcodes

Create a new ServiceProvider where you can register all the shortcodes., <sub>(*12)</sub>

``` bash php artisan make:provider ShortcodesServiceProvider, <sub>(*13)</sub>

After defining shortcodes, add the ServiceProvider to the providers array in `config/app.php`

## Usage

```php
App\Providers\ShortcodesServiceProvider::class,

Callback

Shortcodes can be registered within ShortcodesServiceProvider with a callback:, <sub>(*14)</sub>

php artisan make:provider ShortcodesServiceProvider

ShortcodesServiceProvider.php Class File, <sub>(*15)</sub>

<?php namespace App\Providers;

use App\Shortcodes\BoldShortcode;
use Illuminate\Support\ServiceProvider;
use Shortcode;

class ShortcodesServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap the application services.
     *
     * @return void
     */
    public function boot()
    {
        //
    }

    /**
     * Register the application services.
     *
     * @return void
     */
    public function register()
    {
        Shortcode::register('b', BoldShortcode::class);
        Shortcode::register('i', 'App\Shortcodes\ItalicShortcode@custom');
    }
}

Default class for BoldShortcode

You can store each shortcode within their class app/Shortcodes/BoldShortcode.php, <sub>(*16)</sub>

namespace App\Shortcodes;

class BoldShortcode {

  public function register($shortcode, $content, $compiler, $name, $viewData)
  {
    return sprintf('<strong class="%s">%s</strong>', $shortcode->class, $content);
  }

}

Class with custom method

You can store each shortcode within their class app/Shortcodes/ItalicShortcode.php, <sub>(*17)</sub>

namespace App\Shortcodes;

class ItalicShortcode {

  public function custom($shortcode, $content, $compiler, $name, $viewData)
  {
    return sprintf('<i class="%s">%s</i>', $shortcode->class, $content);
  }

}

Register helpers

If you only want to show the html attribute when the attribute is provided in the shortcode, you can use $shortcode->get($attributeKey, $fallbackValue = null), <sub>(*18)</sub>

class BoldShortcode {

  public function register($shortcode, $content, $compiler, $name, $viewData)
  {
    return '<strong '. $shortcode->get('class', 'default') .'>' . $content . '</strong>';
  }

}

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*19)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*20)</sub>

Security

If you discover any security related issues, please email webwizo@gmail.com instead of using the issue tracker., <sub>(*21)</sub>

Credits

• Asif Iqbal
• All Contributors

Support me

, <sub>(*22)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*23)</sub>