Jalle19\StatusManager\Message\AbstractMessage

Complexity

Total Complexity

4

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

54.55%

Importance

Changes	5
Bugs	0	Features	4

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getPayload()	0	4	1
A	getType()	0	4	1
A	jsonSerialize()	0	7	1

<?php

namespace Jalle19\StatusManager\Message;

/**
 * Base class for messages that can be sent between the server and the clients
 *
 * @package   Jalle19\StatusManager
 * @copyright Copyright &copy; Sam Stenvall 2016-
 * @license   https://www.gnu.org/licenses/gpl.html The GNU General Public License v2.0
 */
abstract class AbstractMessage implements \JsonSerializable
{

	const TYPE_AUTHENTICATION_REQUEST        = 'authenticationRequest';
	const TYPE_AUTHENTICATION_RESPONSE       = 'authenticationResponse';
	const TYPE_STATUS_UPDATES                = 'statusUpdates';
	const TYPE_POPULAR_CHANNELS_REQUEST      = 'popularChannelsRequest';
	const TYPE_POPULAR_CHANNELS_RESPONSE     = 'popularChannelsResponse';
	const TYPE_MOST_ACTIVE_WATCHERS_REQUEST  = 'mostActiveWatchersRequest';
	const TYPE_MOST_ACTIVE_WATCHERS_RESPONSE = 'mostActiveWatchersResponse';
	const TYPE_INSTANCES_REQUEST             = 'instancesRequest';
	const TYPE_INSTANCES_RESPONSE            = 'instancesResponse';
	const TYPE_USERS_REQUEST                 = 'usersRequest';
	const TYPE_USERS_RESPONSE                = 'usersResponse';

	/**
	 * @var string
	 */
	private $_type;

	/**
	 * @var mixed
	 */
	private $_payload;


	/**
	 * @param string $type
	 * @param mixed  $payload
	 */
	public function __construct($type, $payload)
	{
		$this->_type    = $type;
		$this->_payload = $payload;
	}


	/**
	 * @return string
	 */
	public function getType()
	{
		return $this->_type;
	}


	/**
	 * @return mixed
	 */
	public function getPayload()
	{
		return $this->_payload;
	}


	/**
	 * @inheritdoc
	 */
	public function jsonSerialize()
	{
		return [
			'type'    => $this->_type,
			'payload' => $this->_payload,
		];
	}

}