izumi-kun / yii2-longpoll Goto Github PK

View Code? Open in Web Editor NEW

7.0 3.0 0.0 49 KB

Implements long polling connection

License: BSD 3-Clause "New" or "Revised" License

PHP 100.00%

longpoll yii2-extension ajax comet

yii2-longpoll's Introduction

Yii2 longpoll

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

yii2-longpoll's People

Contributors

Stargazers

Watchers

yii2-longpoll's Issues

Terminate server on connection abort

Possible only with HTTP/1.1 and Transfer-Encoding: chunked.

A trick to detecting if a connection is closed without having to send data that will otherwise corrupt the stream of data (like a binary file) you can use a combination of chunking the data on HTTP/1.1 by sending a "0" ("zero") as a leading chunk size without anything else.

http://php.net/manual/ru/function.connection-aborted.php#111167

Missing client parameters

I'm using longpoll for update news content on page.
In view:

\izumi\longpoll\widgets\LongPoll::widget([
    'url' => ['polling'],
    'events' => ['addTranslationBlock'],
    'requestParams' => [
        'id' => $post->id,
        'block_id' => $lastblock,
    ],
    'callback' => 'addTranslationBlock',
]);

In controller:

  public function actions() {
        return [
            'polling' => [
                'class' => 'izumi\longpoll\LongPollAction',
                'events' => ['addTranslationBlock'],
                'callback' => [$this, 'longPollCallback'],
            ],
        ];
    }

    public function longPollCallback(\izumi\longpoll\Server $server) {
        $id = Yii::$app->request->get('id');
        $block_id = Yii::$app->request->get('block_id');
        if(!$id || !$block_id) throw new \yii\web\NotFoundHttpException();

        $blocks = PostBlock::find()->
            where(['post_id' => $id])->
            andWhere(['>', 'id', $block_id])->
            orderBy(['created' => SORT_ASC, 'order' => SORT_ASC])->
            all();

        foreach($blocks as $block) {
            $server->responseData .= $this->renderPartial('_block.php', [
                'block' => $block,
                'yellow' => true,
            ]);
            $lastBlockId = $block->id;
        }
        
        $server->responseParams = [
            'id' => $id,
            'block_id' => $lastBlockId,
        ];
    }

It's do request to server like polling?id=36&block_id=97&event-addTranslationBlock=17
It's work fine.
BUT!
If longpoll connection closed by timeout, server returns {"data":null,"params":{"event-addTranslationBlock":17}} and the next request is polling?event-addTranslationBlock=17.
Additional parameters like id and block_id are missing.

Fix PHP 7.2 compatibility bugs

minimum Yii version is 2.0.13
use yii\base\BaseObject instead of yii\base\Object
add php 7.2 to .travis.yml

Server::sendContent() echo json with error.

src/Server.php, if replace lines 143, 144

echo dechex(strlen($json)), "\r\n", $json, "\r\n";
echo "0\r\n\r\n";

with

echo $json;

then works well, else Ajax respond is
SyntaxError: JSON.parse: unexpected non-whitespace character after JSON data at line 1 column 2 of the JSON data

Add `Shared Memory` event driver

BC breaks enhancement.