EasyHttp\WebSocketConfig

Complexity

Total Complexity

31

Size/Duplication

Total Lines	333
Duplicated Lines	0 %

Importance

Changes

0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	setFragmentSize()	0	4	1
A	getProxyPort()	0	3	1
A	getPort()	0	3	1
A	setPassword()	0	4	1
A	setScheme()	0	4	1
A	setProxy()	0	7	1
A	getHeaders()	0	3	1
A	getProxyIp()	0	3	1
A	hasProxy()	0	3	1
A	setProxyAuth()	0	4	3
A	setHeaders()	0	4	1
A	getContext()	0	3	1
A	getTimeout()	0	3	1
A	setTimeout()	0	4	1
A	getContextOptions()	0	3	1
A	setUser()	0	4	1
A	getUser()	0	3	1
A	getFragmentSize()	0	3	1
A	getScheme()	0	3	1
A	getProxyAuth()	0	3	1
A	getPingInterval()	0	3	1
A	setContext()	0	4	1
A	setHost()	0	4	1
A	getHost()	0	3	1
A	setPort()	0	4	2
A	setContextOptions()	0	4	1
A	getPassword()	0	3	1
A	setPingInterval()	0	4	1

<?php

namespace EasyHttp;

use EasyHttp\Contracts\WscCommonsContract;

/**
 * WebSocketConfig class
 *
 * @link    https://github.com/shahradelahi/easy-http
 * @author  Arthur Kushman (https://github.com/arthurkushman)
 * @license https://github.com/shahradelahi/easy-http/blob/master/LICENSE (MIT License)
 */
class WebSocketConfig
{

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

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

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

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

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

	/**
	 * @var int
	 */
	private int $timeout = WscCommonsContract::DEFAULT_TIMEOUT;

	/**
	 * @var array
	 */
	private array $headers = [];

	/**
	 * @var int
	 */
	private int $fragmentSize = WscCommonsContract::DEFAULT_FRAGMENT_SIZE;

	/**
	 * @var null|resource
	 */
	private $context;

	/**
	 * @var bool
	 */
	private bool $hasProxy = false;

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

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

	/**
	 * @var string|null
	 */
	private ?string $proxyAuth;

	/**
	 * @var array
	 */
	private array $contextOptions = [];

	/**
	 * @var int
	 */
	private int $pingInterval = WscCommonsContract::DEFAULT_PING_INTERVAL;

	/**
	 * @return int
	 */
	public function getTimeout(): int
	{
		return $this->timeout;
	}

	/**
	 * @param int $timeout
	 * @return WebSocketConfig
	 */
	public function setTimeout(int $timeout): WebSocketConfig
	{
		$this->timeout = $timeout;
		return $this;
	}

	/**
	 * @param int $int
	 * @return $this
	 */
	public function setPingInterval(int $int): WebSocketConfig
	{
		$this->pingInterval = $int;
		return $this;
	}

	/**
	 * @return int
	 */
	public function getPingInterval(): int
	{
		return $this->pingInterval;
	}

	/**
	 * @return array
	 */
	public function getHeaders(): array
	{
		return $this->headers;
	}

	/**
	 * @param array $headers
	 * @return WebSocketConfig
	 */
	public function setHeaders(array $headers): WebSocketConfig
	{
		$this->headers = $headers;
		return $this;
	}

	/**
	 * @return int
	 */
	public function getFragmentSize(): int
	{
		return $this->fragmentSize;
	}

	/**
	 * @param int $fragmentSize
	 * @return WebSocketConfig
	 */
	public function setFragmentSize(int $fragmentSize): WebSocketConfig
	{
		$this->fragmentSize = $fragmentSize;
		return $this;
	}

	/**
	 * @return mixed
	 */
	public function getContext(): mixed
	{
		return $this->context;
	}

	/**
	 * @param mixed $context
	 * @return WebSocketConfig
	 */
	public function setContext(mixed $context): WebSocketConfig
	{
		$this->context = $context;
		return $this;
	}

	/**
	 * @return mixed
	 */
	public function getScheme(): string
	{
		return $this->scheme;
	}

	/**
	 * @param string $scheme
	 * @return WebSocketConfig
	 */
	public function setScheme(string $scheme): WebSocketConfig
	{
		$this->scheme = $scheme;
		return $this;
	}

	/**
	 * @return string
	 */
	public function getHost(): string
	{
		return $this->host;
	}

	/**
	 * @param string $host
	 * @return WebSocketConfig
	 */
	public function setHost(string $host): WebSocketConfig
	{
		$this->host = $host;
		return $this;
	}

	/**
	 * @return string
	 */
	public function getUser(): string
	{
		return $this->user;
	}

	/**
	 * @param array $urlParts
	 * @return WebSocketConfig
	 */
	public function setUser(array $urlParts): WebSocketConfig
	{
		$this->user = $urlParts['user'] ?? '';
		return $this;
	}

	/**
	 * @return string
	 */
	public function getPassword(): string
	{
		return $this->password;
	}

	/**
	 * @param array $urlParts
	 * @return WebSocketConfig
	 */
	public function setPassword(array $urlParts): WebSocketConfig
	{
		$this->password = $urlParts['pass'] ?? '';
		return $this;
	}

	/**
	 * @return string
	 */
	public function getPort(): string
	{
		return $this->port;
	}

	/**
	 * @param array $urlParts
	 * @return WebSocketConfig
	 */
	public function setPort(array $urlParts): WebSocketConfig
	{
		$this->port = $urlParts['port'] ?? ($this->scheme === 'wss' ? '443' : '80');
		return $this;
	}

	/**
	 * @return array
	 */
	public function getContextOptions(): array
	{
		return $this->contextOptions;
	}

	/**
	 * @param array $contextOptions
	 * @return WebSocketConfig
	 */
	public function setContextOptions(array $contextOptions): WebSocketConfig
	{
		$this->contextOptions = $contextOptions;
		return $this;
	}

	/**
	 * @param string $ip
	 * @param string $port
	 * @return WebSocketConfig
	 */
	public function setProxy(string $ip, string $port): WebSocketConfig
	{
		$this->hasProxy = true;
		$this->proxyIp = $ip;
		$this->proxyPort = $port;

		return $this;
	}

	/**
	 * Sets auth for proxy
	 *
	 * @param string $userName
	 * @param string $password
	 * @return WebSocketConfig
	 */
	public function setProxyAuth(string $userName, string $password): WebSocketConfig
	{
		$this->proxyAuth = (empty($userName) === false && empty($password) === false) ? base64_encode($userName . ':' . $password) : null;
		return $this;
	}

	/**
	 * @return bool
	 */
	public function hasProxy(): bool
	{
		return $this->hasProxy;
	}

	/**
	 * @return string|null
	 */
	public function getProxyIp(): ?string
	{
		return $this->proxyIp;
	}

	/**
	 * @return string|null
	 */
	public function getProxyPort(): ?string
	{
		return $this->proxyPort;
	}

	/**
	 * @return string|null
	 */
	public function getProxyAuth(): ?string
	{
		return $this->proxyAuth;
	}

}