Router::addEvent() - Code Metrics - Inspection of "add namespace & route group support" - sonrac/laravel-wamp - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 2bc5ee...3171bd )

by Sergii
created 2017-11-06 10:22 UTC
Router::addEvent() A

↳ Parent: Router
Complexity

Conditions	2
Paths	2
Size

Total Lines	11
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	3.1852
Importance

Changes
Metric	Value
cc	2
eloc	5
nc	2
nop	3
dl	0
loc	11
ccs	2
cts	6
cp	0.3333
crap	3.1852
rs	9.4285
c	0
b	0
f	0
<?php
/**
 * Created by PhpStorm.
 *
 * @author Donii Sergii <[email protected]>
 * Date: 10/25/17
 * Time: 11:56 AM
 */

namespace sonrac\WAMP\Routers;

use sonrac\WAMP\Contracts\WAMPRouterInterface;
use Thruway\Event\ConnectionOpenEvent;
use Thruway\Peer\ClientInterface;
use Thruway\Peer\Router as PeerRouter;

/**
 * Class Router
 * Router class.
 *
 * <h2>Events list</h2>
 * <table class="table table-bordered table-stripped table-hover table-responsive">
 * <thead>
 * <tr>
 * <td>Event name</td>
 * <td>Constant name</td>
 * <td>Description</td>
 * <td>Method for subscribe (is static for class <i>sonrac\WAMP\Routers\Router</i>)</td>
 * </tr>
 * </thead>
 * <tbody>
 * <tr>
 * <td>connection_open</td>
 * <td><i>sonrac\WAMP\Routers\Router::EVENT_CONNECTION_OPEN</i></td>
 * <td>Connection opened</td>
 * <td><i>sonrac\WAMP\Routers\Router::onOpen</i></td>
 * </tr>
 * </tbody>
 * </table>
 *
 * <h2>Example events adding</h2>
 *
 * <code>
 * $app->router->onOpen()
 * </code>
 */
class Router extends PeerRouter implements WAMPRouterInterface
{
    use RouterTrait;

    /**
     * Connection open event name.
     *
     * @var string
     * @const
     */
    const EVENT_CONNECTION_OPEN = 'connection_open';

    /**
     * Connection close event name.
     *
     * @var string
     * @const
     */
    const EVENT_CONNECTION_CLOSE = 'connection_close';

    /**
     * Router start event name.
     *
     * @var string
     * @const
     */
    const EVENT_ROUTER_START = 'router.start';

    /**
     * Router stop event name.
     *
     * @var string
     * @const
     */
    const EVENT_ROUTER_STOP = 'router.stop';

    /**
     * RPC router.
     *
     * @var \sonrac\WAMP\Contracts\RPCRouterInterface
     */
    protected $rpcRouter;

    /**
     * Publisher/subscription router.
     *
     * @var \sonrac\WAMP\Contracts\PubSubRouterInterface
     */
    protected $pubSubRouter;

    /**
     * Loop object.
     *
     * @var null|\React\EventLoop\LoopInterface
     *
     * @author Donii Sergii <[email protected]>
     */
    protected $loop;
    /**
     * Routes.
     *
     * @var array
     */
    protected $routes = [];

    /**
     * Peer client.
     *
     * @var \Thruway\Peer\ClientInterface|\sonrac\WAMP\Client
     *
     * @author Donii Sergii <[email protected]>
     */
    protected $client = null;

    /**
     * Default controller namespaces.
     *
     * @var null|string
     *
     * @author Donii Sergii <[email protected]>
     */
    protected $controllerNamespace = null;

    /**
     * Events.
     *
     * @var array
     *
     * @author Donii Sergii <[email protected]>
     */
    protected static $events = [
    ];

    /**
     * Router constructor.
     *
     * @param \sonrac\WAMP\Contracts\RPCRouterInterface|\sonrac\WAMP\Routers\RPCRouter       $RPCRouter    RPC router
     * @param \sonrac\WAMP\Contracts\PubSubRouterInterface|\sonrac\WAMP\Routers\PubSubRouter $pubSubRouter Publisher/subscription
     *                                                                                                     router
     * @param \React\EventLoop\LoopInterface|null                                            $loop         Loop object
     */
    public function __construct(
        \sonrac\WAMP\Contracts\RPCRouterInterface $RPCRouter,
        \sonrac\WAMP\Contracts\PubSubRouterInterface $pubSubRouter,
        \React\EventLoop\LoopInterface $loop = null
    ) {
        $this->rpcRouter = $RPCRouter;
        $this->pubSubRouter = $pubSubRouter;
        $this->loop = $loop;

        parent::__construct($loop);
    }

    /**
     * Add subscriber.
     *
     * @param string          $path     Route path
     * @param \Closure|string $callback Handler
     *
     * @return \React\Promise\Promise
     */
    public function addSubscriber($path, $callback)
    {
        return $this->pubSubRouter->addRoute($path, $callback);
        return $this->pubSubRouter->/** @scrutinizer ignore-call */ addRoute($path, $callback);
    }

    /**
     * Add procedure.
     *
     * @param string          $name      Name
     * @param string|\Closure $procedure Procedure
     *
     * @return \React\Promise\Promise
     *
     * @author Donii Sergii <[email protected]>
     */
    public function addRoute($name, $procedure)
    {
        return $this->rpcRouter->addRoute($name, $procedure);
        return $this->rpcRouter->/** @scrutinizer ignore-call */ addRoute($name, $procedure);
    }

    /**
     * Set default controller namespace.
     *
     * @param string $namespace
     *
     * @author Donii Sergii <[email protected]>
     */
    public function setControllerNamespace($namespace) {
        $this->controllerNamespace = $namespace;
    }

    /**
     * Get default controller namespace.
     *
     * @return null|string
     *
     * @author Donii Sergii <[email protected]>
     */
    public function getControllerNamespace() {
        return $this->controllerNamespace;
    }

    /**
     * Add open event listener.
     *
     * @param \Closure|string $callback Callback
     * @param int             $priority Callback priority
     *
     * @author Donii Sergii <[email protected]>
     */
    public function onConnectionOpen($callback, $priority = 0)
    {
        $this->addEvent($callback, static::EVENT_CONNECTION_OPEN, $priority);
    }

    /**
     * Add stop router event listener.
     *
     * @param \Closure|string $callback Callback
     * @param int             $priority Callback priority
     *
     * @throws \Exception
     *
     * @author Donii Sergii <[email protected]>
     */
    public function onRouterStop($callback, $priority = 0)
    {
        $this->addEvent($callback, static::EVENT_ROUTER_STOP, $priority);
    }

    /**
     * Add connection close event listener.
     *
     * @param \Closure|string $callback Callback
     * @param int             $priority Callback priority
     *
     * @throws \Exception
     *
     * @author Donii Sergii <[email protected]>
     */
    public function onConnectionClose($callback, $priority = 0)
    {
        $this->addEvent($callback, static::EVENT_CONNECTION_CLOSE, $priority);
    }

    /**
     * Remove event listener.
     *
     * @param string $eventName Event name
     * @param mixed  $callback  Callback
     *
     * @author Donii Sergii <[email protected]>
     */
    public function removeEvent($eventName, $callback)
    {
        $this->getEventDispatcher()->removeListener($eventName, $callback);

        if (isset(static::$events[$eventName]) && count(static::$events[$eventName]) === 0) {
            unset(static::$events[$eventName]);
        }
    }

    /**
     * Add open event listener.
     *
     * @param \Closure|string $callback Callback
     * @param int             $priority Callback priority
     *
     * @throws \Exception
     *
     * @author Donii Sergii <[email protected]>
     */
    public function onRouterStart($callback, $priority = 0)
    {
        $this->addEvent($callback, static::EVENT_ROUTER_START, $priority);
    }

    /**
     * Get client.
     *
     * @return \Thruway\Peer\ClientInterface|\sonrac\WAMP\Client
     *
     * @author Donii Sergii <[email protected]>
     */
    public function getClient()
    {
        return $this->client;
    }

    /**
     * Set client
     *
     * @param \Thruway\Peer\ClientInterface $client Client
     *
     * @author Donii Sergii <[email protected]>
     */
    public function setClient(ClientInterface $client)
    {
        $this->client = $client;
    }

    /**
     * {@inheritdoc}
     */
    public function parseGroups()
    {
        $this->rpcRouter->parseGroups();
                          parseGroups();
        $this->pubSubRouter->parseGroups();
                             parseGroups();
    }

    /**
     * Add event.
     *
     * @param \Closure|string $callback  Callback
     * @param string          $eventName Event name
     * @param int             $priority  Priority
     *
     * @author Donii Sergii <[email protected]>
     */
    protected function addEvent($callback, $eventName, $priority)
    {
        if (is_string($callback)) {
            list($class, $method) = explode('&', $callback);

            $callback = function (ConnectionOpenEvent $event) use ($class, $method) {
                return $class::{$method}($event);
            };
        }

        $this->getEventDispatcher()->addListener($eventName, $callback, $priority);
    }
}

sonrac / laravel-wamp

Push — master ( 2bc5ee...3171bd )

Router::addEvent() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
