alexeevdv/yii2-shortcodes

0.1.1 2018-04-20 14:37 UTC

Requires

• alexeevdv/php-shortcodes: ~0.1.0
• yiisoft/yii2: ~2.0.0

Requires (Dev)

• codeception/codeception: ~2.4.0
• yiisoft/yii2-coding-standards: ~2.0.0

MIT

• Dmitry Alekseev

README

Yii2 behavior for rendering widgets with WordPress style shortcodes.

Installation

The preferred way to install this extension is through composer.

Either run

$ php composer.phar require alexeevdv/yii2-shortcodes "~0.1.0"

or add

"alexeevdv/yii2-shortcodes": "~0.1.0"

to the require section of your composer.json file.

Configuration

use alexeevdv\yii\shortcodes\ShortcodeBehavior;

//...
'components' => [
    //...
    'view' => [
        'as shortcodeBehavior' => ShortcodeBehavior::class,
        'map' => [
            'feedback' => \frontend\widgets\ContactForm::class,
            'gallery' => [ 
                'class' => \frontend\widgets\GalleryWidget::class,
                'theme' => 'dark',
            ],
        ],
    ],
    //...
],
//...

Usage

namespace frontend\widgets;

class GalleryWidget extends \yii\base\Widget
{
    public $id;
    
    public $theme;
    
    public function run()
    {
        // render your gallery here using $id and $theme
    }
}

//Anywhere in your layouts, views or rendered content:

[gallery id=413]