PHPDaemon\Core\Timer

Complexity

Total Complexity

22

Size/Duplication

Total Lines	200
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	5

Importance

Changes	5
Bugs	1	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	21	5
A	setPriority()	0	5	1
A	timeout()	0	7	2
A	add()	0	5	1
A	setTimeout()	0	8	2
A	remove()	0	6	2
A	free()	0	8	2
A	cancelTimeout()	0	6	2
A	cancel()	0	4	1
A	eventCall()	0	10	2
A	finish()	0	4	1
A	__destruct()	0	4	1

<?php
namespace PHPDaemon\Core;

use PHPDaemon\Traits\EventLoopContainer;

/**
 * Timed event
 * @package PHPDaemon\Core
 * @author  Vasily Zorin <maintainer@daemon.io>
 */
class Timer
{
    use \PHPDaemon\Traits\ClassWatchdog;
    use \PHPDaemon\Traits\StaticObjectWatchdog;
    use EventLoopContainer;

    /**
     * @var Timer[] List of timers
     */
    protected static $list = [];
    /**
     * @var integer Counter
     */
    protected static $counter = 1;
    /**
     * @var integer|null Timer id
     */
    public $id;
    /**
     * @var integer Current timeout holder
     */
    public $lastTimeout;
    /**
     * @var boolean Is the timer finished?
     */
    public $finished = false;
    /**
     * @var callable Callback
     */
    public $cb;
    /**
     * @var integer Priority
     */
    public $priority;
    /**
     * @var \EventBufferEvent Event resource
     */
    protected $ev;

    /**
     * Constructor
     * @param  callable $cb Callback
     * @param  integer $timeout Timeout

Should the type for parameter $timeout not be integer|null?

     * @param  integer|string $id Timer ID

Should the type for parameter $id not be integer|string|null?

     * @param  integer $priority Priority

Should the type for parameter $priority not be integer|null?

     */
    public function __construct($cb, $timeout = null, $id = null, $priority = null)
    {
        if ($id === null) {
            $id = ++self::$counter;
        } else {
            $id = (string)$id;
        }
        $this->id = $id;

It seems like $id can also be of type string. However, the property $id is declared as type integer|null. Maybe add an additional type check?

        $this->cb = $cb;
        if ($this->eventLoop === null) {
            $this->eventLoop = EventLoop::$instance;
        }
        $this->ev = $this->eventLoop->timer([$this, 'eventCall']);
        if ($priority !== null) {
            $this->setPriority($priority);
        }
        if ($timeout !== null) {
            $this->timeout($timeout);
        }
        self::$list[$id] = $this;
    }

    /**
     * Set prioriry
     * @param  integer $priority Priority
     * @return void
     */
    public function setPriority($priority)
    {
        $this->priority = $priority;
        $this->ev->priority = $priority;
    }

    /**
     * Sets timeout
     * @param  integer $timeout Timeout

Should the type for parameter $timeout not be integer|null?

     * @return void
     */
    public function timeout($timeout = null)
    {
        if ($timeout !== null) {
            $this->lastTimeout = $timeout;
        }
        $this->ev->add($this->lastTimeout / 1e6);
    }

    /**
     * Adds timer
     * @param  callable $cb Callback
     * @param  integer $timeout Timeout

Should the type for parameter $timeout not be integer|null?

     * @param  integer|string $id Timer ID

Should the type for parameter $id not be integer|string|null?

     * @param  integer $priority Priority

Should the type for parameter $priority not be integer|null?

     * @return integer|string           Timer ID

Should the return type not be integer|null?

     */
    public static function add($cb, $timeout = null, $id = null, $priority = null)
    {
        $obj = new self($cb, $timeout, $id, $priority);
        return $obj->id;
    }

    /**
     * Sets timeout
     * @param  integer|string $id Timer ID
     * @param  integer $timeout Timeout

Should the type for parameter $timeout not be integer|null?

     * @return boolean
     */
    public static function setTimeout($id, $timeout = null)
    {
        if (isset(self::$list[$id])) {
            self::$list[$id]->timeout($timeout);
            return true;
        }
        return false;
    }

    /**
     * Removes timer by ID
     * @param  integer|string $id Timer ID
     * @return void
     */
    public static function remove($id)
    {
        if (isset(self::$list[$id])) {
            self::$list[$id]->free();
        }
    }

    /**
     * Frees the timer
     * @return void
     */
    public function free()
    {
        unset(self::$list[$this->id]);
        if ($this->ev !== null) {
            $this->ev->free();
            $this->ev = null;
        }
    }

    /**
     * Cancels timer by ID
     * @param  integer|string $id Timer ID
     * @return void
     */
    public static function cancelTimeout($id)
    {
        if (isset(self::$list[$id])) {
            self::$list[$id]->cancel();
        }
    }

    /**
     * Cancels timer
     * @return void
     */
    public function cancel()
    {
        $this->ev->del();
    }

    /**
     * Called when timer is triggered
     * @return void
     */
    public function eventCall()
    {
        try {
            //Daemon::log('cb - '.Debug::zdump($this->cb));

63% of this comment could be valid code. Did you maybe forget this after debugging?

            $func = $this->cb;
            $func($this);
        } catch (\Exception $e) {
            Daemon::uncaughtExceptionHandler($e);
        }
    }

    /**
     * Finishes timer
     * @return void
     */
    public function finish()
    {
        $this->free();
    }

    /**
     * Destructor
     * @return void
     */
    public function __destruct()
    {
        $this->free();
    }
}