PHPDaemon\Traits\EventHandlers

Complexity

Total Complexity

29

Size/Duplication

Total Lines	168
Duplicated Lines	19.05 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
B	event()	16	16	5
B	trigger()	16	16	5
B	triggerAndCount()	0	17	5
A	getLastEventName()	0	3	1
A	bind()	0	10	4
A	on()	0	3	1
B	unbind()	0	19	6
A	off()	0	3	1
A	cleanupEventHandlers()	0	4	1

<?php
namespace PHPDaemon\Traits;

use PHPDaemon\Core\CallbackWrapper;
use PHPDaemon\Core\Daemon;

/**
 * Event handlers trait
 * @package PHPDaemon\Traits
 * @author  Zorin Vasily <maintainer@daemon.io>
 */
trait EventHandlers {
	/**
	 * @var array Event handlers
	 */
	protected $eventHandlers = [];

	/**
	 * @var boolean Unshift $this to arguments of callback?
	 */
	protected $addThisToEvents = true;

	/**
	 * @var string Last called event name
	 */
	protected $lastEventName;

	/**
	 * Propagate event
	 * @param  string $name    Event name

There is no parameter named $name. Was it maybe removed?

	 * @param  mixed  ...$args Arguments
	 * @return this

Should the return type not be EventHandlers?

	 */
	public function event() {

This method seems to be duplicated in your project.

		$args = func_get_args();
		$name = array_shift($args);
		if ($this->addThisToEvents) {
			array_unshift($args, $this);
		}
		if (isset($this->eventHandlers[$name])) {
			$this->lastEventName = $name;
			foreach ($this->eventHandlers[$name] as $cb) {
				if (call_user_func_array($cb, $args) === true) {
					return $this;
				}
			}
		}
		return $this;
	}

	/**
	 * Propagate event
	 * @param  string $name    Event name

There is no parameter named $name. Was it maybe removed?

	 * @param  mixed  ...$args Arguments
	 * @return this

Should the return type not be EventHandlers?

	 */
	public function trigger() {

This method seems to be duplicated in your project.

		$args = func_get_args();
		$name = array_shift($args);
		if ($this->addThisToEvents) {
			array_unshift($args, $this);
		}
		if (isset($this->eventHandlers[$name])) {
			$this->lastEventName = $name;
			foreach ($this->eventHandlers[$name] as $cb) {
				if (call_user_func_array($cb, $args) === true) {
					return $this;
				}
			}
		}
		return $this;
	}

	/**
	 * Propagate event
	 * @param  string $name    Event name

There is no parameter named $name. Was it maybe removed?

	 * @param  mixed  ...$args Arguments
	 * @return integer
	 */
	public function triggerAndCount() {
		$args = func_get_args();
		$name = array_shift($args);
		if ($this->addThisToEvents) {
			array_unshift($args, $this);
		}
		$cnt = 0;
		if (isset($this->eventHandlers[$name])) {
			$this->lastEventName = $name;
			foreach ($this->eventHandlers[$name] as $cb) {
				if (call_user_func_array($cb, $args) !== 0) {
					++$cnt;
				}
			}
		}
		return $cnt;
	}

	/**
	 * Use it to define event name, when one callback was bind to more than one events
	 * @return string
	 */
	public function getLastEventName() {
		return $this->lastEventName;
	}

	/**
	 * Bind event or events
	 * @param string|array $event Event name
	 * @param callable     $cb    Callback
	 * @return this

Should the return type not be EventHandlers?

	 */
	public function bind($event, $cb) {
		if ($cb !== null) {
			$cb = CallbackWrapper::wrap($cb);
		}
		is_array($event) or $event = [$event];

Using logical operators such as or instead of || is generally not recommended.

		foreach ($event as $e) {

The expression $event of type string|array is not guaranteed to be traversable. How about adding an additional type check?

			CallbackWrapper::addToArray($this->eventHandlers[$e], $cb);
		}
		return $this;
	}

	/**
	 * Bind event or events
	 * @alias EventHandlers::bind
	 * @param string|array $event Event name
	 * @param callable     $cb    Callback
	 * @return this

Should the return type not be EventHandlers?

	 */
	public function on($event, $cb) {
		return $this->bind($event, $cb);
	}

	/**
	 * Unbind event(s) or callback from event(s)
	 * @param string|array $event Event name
	 * @param callable     $cb    Callback, optional

Should the type for parameter $cb not be callable|null?

	 * @return this

Should the return type not be EventHandlers?

	 */
	public function unbind($event, $cb = null) {
		if ($cb !== null) {
			$cb = CallbackWrapper::wrap($cb);
		}
		is_array($event) or $event = [$event];

Using logical operators such as or instead of || is generally not recommended.

		$success = true;

$success is not used, you could remove the assignment.

		foreach ($event as $e) {

The expression $event of type string|array is not guaranteed to be traversable. How about adding an additional type check?

			if (!isset($this->eventHandlers[$e])) {
				$success = false;

$success is not used, you could remove the assignment.

				continue;
			}
			if ($cb === null) {
				unset($this->eventHandlers[$e]);
				continue;
			}
			CallbackWrapper::removeFromArray($this->eventHandlers[$e], $cb);
		}
		return $this;
	}

	/**
	 * Unbind event(s) or callback from event(s)
	 * @alias EventHandlers::unbind
	 * @param string|array $event Event name
	 * @param callable     $cb    Callback, optional
	 * @return this

Should the return type not be EventHandlers?

	 */
	public function off($event, $cb) {
		return $this->unbind($event, $cb);
	}

	/**
	 * Clean up all events
	 * @return void
	 */
	protected function cleanupEventHandlers() {
		$this->eventHandlers = [];
		//Daemon::log('clean up event handlers '.get_class($this). ' -- '.$this->attrs->server['REQUEST_URI']. PHP_EOL .Debug::backtrace());

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

This line exceeds maximum limit of 120 characters; contains 134 characters

	}
}