Tidal\WampWatch\MonitorTrait

Complexity

Total Complexity

17

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	9
Bugs	3	Features	3

10 Methods

Rating	Name	Duplication	Size	Complexity
A	setClientSession()	0	4	1
A	start()	0	7	1
A	stop()	0	13	2
A	getList()	0	4	1
A	getServerSession()	0	4	1
A	isRunning()	0	4	1
A	getSubscriptionCollection()	0	6	2
A	setInitialCall()	0	5	1
A	callInitialProcedure()	0	16	3
A	checkStarted()	0	9	4

<?php

/*
 * This file is part of the Tidal/WampWatch package.
 *   (c) 2016 Timo Michna <timomichna/yahoo.de>
 *
 *  For the full copyright and license information, please view the LICENSE
 *  file that was distributed with this source code.
 *
 */

namespace Tidal\WampWatch;

use Evenement\EventEmitterTrait;
use React\Promise\Promise;
use Tidal\WampWatch\ClientSessionInterface as ClientSession;
use Tidal\WampWatch\Subscription\Collection as SubscriptionCollection;

/**
 * Description of MonitorTrait.
 *
 * @author Timo
 */
trait MonitorTrait
{
    use EventEmitterTrait;

    /**
     * The monitor's WAMP client session.
     *
     * @var ClientSession
     */
    protected $session;

    /**
     * if the monitor is running.
     *
     * @var bool
     */
    protected $isRunning = false;

    /**
     * @var SubscriptionCollection
     */
    protected $subscriptionCollection;

    /**
     * @var string
     */
    protected $initialCallProcedure;

    /**
     * @var callable
     */
    protected $initialCallCallback;

    /**
     * @var bool
     */
    protected $initialCallDone = false;

    /**
     * @param ClientSession $session
     */
    protected function setClientSession(ClientSession $session)
    {
        $this->session = $session;
    }

    /**
     * Start the monitor.
     *
     * @return bool
     */
    public function start()
    {
        $this->isRunning = true;
        $this->emit('start', [$this->getList()]);

        return true;
    }

    /**
     * Stop the monitor.
     * Returns boolean if the monitor could be started.
     *
     * @return bool
     */
    public function stop()
    {
        if (!$this->isRunning()) {
            return false;
        }

        $this->getSubscriptionCollection()->unsubscribe();

        $this->isRunning = false;
        $this->emit('stop', [$this]);

        return true;
    }

    protected function getList()
    {
        return [];
    }

    /**
     * Get the monitor's WAMP client session.
     *
     * @return ClientSession
     */
    public function getServerSession()
    {
        return $this->session;
    }

    /**
     * Get the monitor's running state.
     *
     * @return bool
     */
    public function isRunning()
    {
        return $this->isRunning;
    }

    /**
     * @return \Tidal\WampWatch\Subscription\Collection
     */
    protected function getSubscriptionCollection()
    {
        return isset($this->subscriptionCollection)
            ? $this->subscriptionCollection
            : $this->subscriptionCollection = new SubscriptionCollection($this->session);
    }

    protected function setInitialCall($pocedure, callable $callback)
    {
        $this->initialCallProcedure = (string) $pocedure;
        $this->initialCallCallback = $callback;
    }

    /**
     * @return \React\Promise\PromiseInterface
     */
    protected function callInitialProcedure()
    {
        if (!isset($this->initialCallProcedure) || !isset($this->initialCallCallback)) {
            $resolver = function (callable $resolve) {
                $resolve();
            };

            return new  Promise($resolver);
        }

        return $this->session->call($this->initialCallProcedure)->then(function ($res) {
            $this->initialCallDone = true;

            return $res;
        });
    }

    /**
     * Checks if all necessary subscriptions and calls have been responded to.
     */
    protected function checkStarted()
    {
        if ($this->getSubscriptionCollection()->isSubscribed() &&
            $this->initialCallDone &&
            !$this->isRunning()
        ) {
            $this->doStart();

It seems like doStart() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }
    }
}