dkhru/yii2-socket-events

Best way to update content on client from server

yii2-socket-event

Best way to send data to client other websocket on yii2 application, _(*1)

Author

Dmitriy Khristianov (dkh), _(*2)

Require

yii2, npm, node, redis, _(*3)

Installation

The preferred way to install this extension is through composer., _(*4)

Either run, _(*5)

php composer.phar require --prefer-dist dkhru/yii2-socket-events "*"

or add, _(*6)

"dkhru/yii2-socket-events": "*"

to the require section of your composer.json file., _(*7)

Configure and run rtserver

Once the extension is installed, cd vendor/dkhru/nodejs and install node modules npm install console-stamp express redis socket.io Generate SSL certificates for rtserver. Copy config.js.example to config.js, _(*8)

For testing simple run in console node rtserver.js On linux server use init script example in rtserver.initd, _(*9)

Usage

In yii2 configure SocketEvent component, _(*10)

...
'components'=>[
...
'se'=>[
            'class'=>\dkhru\socketEvents\SE::className(),
            'socketUrl'=>https://127.0.0.1:8089,
         ],
...
]
...

Now, you can create you server driven widgets from RegisterSEWidget, _(*11)

Simple example:, _(*12)

...
class RestWidget extends RegisterSEWidget
{
      public $rest;
      public function init()
      {
         if( \Yii::$app->user->isGuest )
            throw new ForbiddenHttpException();
         $this->object='user';
         $this->id=\Yii::$app->user->id;
         $restJs=<<<JS
function(data){
    if(data['rest']){
        el = $('div.rest);
        if(el.length)
            el.html(data.rest);
    }
}
JS;
         $this->handlers=[  
            'rest'=>$restJs // добавляем обработчик
         ];
         parent::init();
      }

      public function run()
      {
         parent::run();
         return Html::tag('div',$this->rest.'&#8381;',['class'=>'rest']);
      }

   }   

After add widget to view you can update user rest in client browser from server., _(*13)

SE::emit('user',$user_id,['handler'=>'rest','data'=>['rest'=>200.00]);