Yii2 longpoll ¶

1. Installation
2. Basic Usage
3. Example
4. License

Implements long polling AJAX mechanism.

Installation ¶

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist izumi-kun/yii2-longpoll

or add

"izumi-kun/yii2-longpoll": "~1.0.0"

to the require section of your composer.json.

Basic Usage ¶

Controller ¶

class SiteController extends Controller
{
    public function actions()
    {
        return [
            'polling' => [
                'class' => LongPollAction::class,
                'events' => ['eventId'],
                'callback' => [$this, 'longPollCallback'],
            ],
        ];
    }
    public function longPollCallback(Server $server)
    {
        $server->responseData = 'any data';
    }
}

View ¶

LongPoll::widget([
    'url' => ['site/polling'],
    'events' => ['eventId'],
    'callback' => 'console.log',
]);

Model ¶

\izumi\longpoll\Event::triggerByKey('eventId');

Example ¶

https://github.com/Izumi-kun/yii2-longpoll-example

License ¶

BSD-3-Clause