aki/yii2-socket

for yii2 web application

dev-master 2021-10-17 15:44 UTC

Requires

• cboden/ratchet: ^0.4
• react/zmq: 0.2.*|0.3.*
• yiisoft/yii2: ~2.0.0

LGPL-3.0+

• akbar joudi

• yii2
• yii2-socket
• web-socket
• yii2-ratchet
• ratchet-socket
• yii2-web-socket

README

for yii2 web application

Dependencies

"react/zmq": "^0.4.0"

The above library needs a (linux zmq.so) library

~$ sudo pecl install zmq-beta

and add extension to php.ini

~$ sudo nano /etc/php/apache2/php.ini

Installation

The preferred way to install this extension is through composer.

Either run

php composer require aki/yii2-socket:dev-master

or add

"aki/yii2-socket": "*"

to the require section of your composer.json file.

Usage

first add to config/console.php

<?php
'socket' => [
    'class' => 'aki\socket\commands\SocketController',
    'port' => '8083',
    'pusher' => [
	'class' => 'common\components\PusherHandler',
	'host' => '127.0.0.1',
	'port' => '8082'
    ]
],
?>

Once the extension is installed, simply use it in your code by :

php yii socket --port=8083

Usage widget

set config global in config.php

'container' => [
    'definitions' => [
        'aki\socket\widgets\SocketListener' => [
            'host' => "localhost",
            'port' => '8083',
	    'authModel' => app\models\User::class,
        ]
    ],
],

 <?= SocketListener::widget([
    'data' => [
        'user' => [
            'token' => Yii::$app->user->identity->auth_key,//for current login
        ]
    ],
    'onMessage' => "function(e) {
        console.log('recived data : ');
        console.log(e.data);
    }",
]);
?>

Usage push data

add component to config.php

'components' => [
    'socketPusher' => [
        'class' => 'aki\socket\SocketPusher',
        'port' => '8082',
        'host' => "localhost"
    ],
]

and use it:

//user_id = 100
Yii::$app->socketPusher->request(100, [
    'message' => 'hello world.',
]);

use custom Pusher class:

Yii::$app->socketPusher->request(100, [
    'message' => 'hello world.',
], 'myPusher');