izumi\longpoll\LongPollAction

Complexity

Total Complexity

1

Size/Duplication

Total Lines	10
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	run()	0	3	1

<?php
/**
 * @link https://github.com/Izumi-kun/yii2-longpoll
 * @copyright Copyright (c) 2017 Viktor Khokhryakov
 * @license http://opensource.org/licenses/BSD-3-Clause
 */

namespace izumi\longpoll;

use yii\web\Response;

/**
 * Usage:
 *
 * ```php
 * 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';
 *     }
 * }
 * ```
 *
 * @author Viktor Khokhryakov <viktor.khokhryakov@gmail.com>
 */
class LongPollAction extends BaseLongPollAction
{

    /**
     * @return Response
     * @throws \yii\base\InvalidConfigException
     */
    public function run()
    {
        return $this->runInternal();
    }
}