RouterOS\SocketTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

90.91%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	openSocket()	0	35	3
A	closeSocket()	0	4	1
A	setSocket()	0	4	1
A	getSocket()	0	4	1

<?php

namespace RouterOS;

use RouterOS\Exceptions\ClientException;

trait SocketTrait
{
    /**
     * Socket resource
     *
     * @var resource|null
     */
    private $socket;

    /**
     * Code of error
     *
     * @var int
     */
    private $socket_err_num;

    /**
     * Description of socket error
     *
     * @var string
     */
    private $socket_err_str;

    /**
     * Initiate socket session
     *
     * @return void
     * @throws \RouterOS\Exceptions\ClientException
     * @throws \RouterOS\Exceptions\ConfigException
     */
    private function openSocket(): void
    {
        // Default: Context for ssl
        $context = stream_context_create([
            'ssl' => [
                'ciphers'          => 'ADH:ALL',
                'verify_peer'      => false,
                'verify_peer_name' => false
            ]
        ]);

        // Default: Proto tcp:// but for ssl we need ssl://
        $proto = $this->config('ssl') ? 'ssl://' : '';

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

        // Initiate socket client
        $socket = @stream_socket_client(
            $proto . $this->config('host') . ':' . $this->config('port'),

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

            $this->socket_err_num,
            $this->socket_err_str,
            $this->config('timeout'),

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

            STREAM_CLIENT_CONNECT,
            $context
        );

        // Throw error is socket is not initiated
        if (false === $socket) {
            throw new ClientException('Unable to establish socket session, ' . $this->socket_err_str);
        }

        //Timeout read
        stream_set_timeout($socket, $this->config('timeout'));

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

        // Save socket to static variable
        $this->setSocket($socket);
    }

    /**
     * Close socket session
     *
     * @return bool
     */
    private function closeSocket(): bool
    {
        return fclose($this->socket);
    }

    /**
     * Save socket resource to static variable
     *
     * @param resource $socket
     *
     * @return  void
     */
    private function setSocket($socket): void
    {
        $this->socket = $socket;
    }

    /**
     * Return socket resource if is exist
     *
     * @return resource
     */
    public function getSocket()
    {
        return $this->socket;
    }
}