inline-widget-behavior Allows to render widgets in page content of Yii2 Framework based projects

  1. Requirements
  2. Install
  3. Usage
  4. Resources

Allows to render widgets in page content of Yii2 Framework based projects

Requirements

Yii2

Install

Either run ~~~ $ php composer.phar require --prefer-dist howardEagle/yii2-inline-widgets-behavior "" ~~~ or add ~~~ "howardEagle/yii2-inline-widgets-behavior": "" ~~~ to the require section of your composer.json file.

Usage

Add a allowed widgets list into config/main.php:

return array(
    // ...
    'params'=>array(
         // ...
        'runtimeWidgets'=>array(
            'ContactsForm',
            'Comments',
            'common\widgets\LastPosts',
        }
    }
}

Create widgets:

class LastPostsWidget extends Widget
{
    public $tpl = 'default';

    public function run()
    {
        $posts = Post::find()->published()->all();
        echo $this->render('LastPosts/' . $this->tpl, array(
            'posts'=>$posts,
        ));
    }
}

Attach the behavior to a main controller:

use howard\behaviors\iwb\InlineWidgetBehavior;

class DefaultController extends Controller
{
    public function behaviors()
    {
        return array(
            'InlineWidgetsBehavior'=>array(
                'class'=> InlineWidgetBehavior::className(),
                'namespace'=> 'common\components\widgets', // default namespace (optional)               
                'widgets'=>Yii::app()->params['runtimeWidgets'],
                'startBlock'=> '[*',
                'endBlock'=> '*]',
             ),
        );
    }
}

You can define a global classname suffix like 'Widget':

class DefaultController extends Controller
{
    public function behaviors()
    {
        return array(
            'InlineWidgetsBehavior'=>array(
                'class'=> InlineWidgetBehavior::className(),
                'widgets'=>Yii::app()->params['runtimeWidgets'],
                'classSuffix'=> 'Widget',
             ),
        );
    }
}

for using short names 'LastPosts' instead of 'LastPostsWidget' :

return array(
    // ...
    'params'=>array(
         // ...
        'runtimeWidgets'=>array(
            'ContactsForm',
            'Comments',
            'common\widgets\LastPosts',
        }
    }
}

For insert widgets in content you can use string of this format in your text: ~~~ [|=[;=]] ~~~

For rendering widgets in any View you must call Controller::decodeWidgets() method for model HTML content.

For example:

<?php $model->text = '
    <h2>Lorem ipsum</h2>
 
    <h2>Latest posts</h2>
    <p>[*LastPosts*]</p>
 
    <h2>Latest posts (with parameters)</h2>
    <p>[*LastPosts|tpl=small*]</p>
 
    <h2>Latest posts (with inner caching)</h2>
    <p>[*LastPosts|tpl=small;cache=300*]</p>
 
    <p>Dolor...</p>
'; ?>
 
<h1><?php echo CHtml::encode($model->title); ?></h1>
<?php echo $this->context->decodeWidgets($model->text); ?>

Resources

0 0
2 followers
0 downloads
Yii Version: 2.0
License: BSD-2-Clause
Category: Others
Developed by: howardEagle
Created on: Nov 20, 2014
Last updated: 4 years ago

Related Extensions