Carpenstar\ByBitAPI\BybitAPI

Complexity

Total Complexity

8

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	publicEndpoint()	0	4	1
A	rest()	0	3	1
A	privateEndpoint()	0	6	1
A	__construct()	0	12	4
A	websocket()	0	3	1

<?php
namespace Carpenstar\ByBitAPI;

use Carpenstar\ByBitAPI\Core\Auth\Credentials;
use Carpenstar\ByBitAPI\Core\Enums\EnumOutputMode;
use Carpenstar\ByBitAPI\Core\Exceptions\ApiException;
use Carpenstar\ByBitAPI\Core\Exceptions\SDKException;
use Carpenstar\ByBitAPI\Core\Builders\RestBuilder;
use Carpenstar\ByBitAPI\Core\Interfaces\IResponseInterface;
use Carpenstar\ByBitAPI\Core\Interfaces\ISuccessCurlResponseDtoInterface;
use Carpenstar\ByBitAPI\Core\Interfaces\IParametersInterface;
use Carpenstar\ByBitAPI\WebSockets\Builders\WebSocketsBuilder;

The type Carpenstar\ByBitAPI\WebSockets\Builders\WebSocketsBuilder was not found. Maybe you did not declare it correctly or list all dependencies?

use Carpenstar\ByBitAPI\WebSockets\Objects\Channels\Interfaces\IChannelHandlerInterface;

The type Carpenstar\ByBitAPI\WebSockets\Objects\Channels\Interfaces\IChannelHandlerInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Carpenstar\ByBitAPI\WebSockets\Objects\WebSockets\Interfaces\IWebSocketArgumentInterface;

The type Carpenstar\ByBitAPI\WebSockets\Objects\WebSockets\Interfaces\IWebSocketArgumentInterface was not found. Maybe you did not declare it correctly or list all dependencies?

class BybitAPI
{
    /**
     * @param string $host
     * @param string $apiKey
     * @param string $secret
     */
    public function __construct(string $host = null, string $apiKey = null, string $secret = null)
    {
        if (!empty($host)) {
            Credentials::setHost($host);
        }

        if (!empty($apiKey)) {
            Credentials::setApiKey($apiKey);
        }

        if (!empty($secret)) {
            Credentials::setSecret($secret);
        }
    }

    /**
     * @param string $endpointClassName
     * @param IParametersInterface|null $parameters
     * @param int|null $resultMode
     * @return ISuccessCurlResponseDtoInterface
     * @throws SDKException
     */
    public function rest(string $endpointClassName, ?IParametersInterface $parameters = null): IResponseInterface
    {
        return RestBuilder::make($endpointClassName, $parameters)->execute();

The expression return Carpenstar\ByBitAPI\Core\Builders\RestBuilder::make($endpointClassName, $parameters)->execute() returns the type Carpenstar\ByBitAPI\Core\Interfaces\IResponseInterface which is incompatible with the documented return type Carpenstar\ByBitAPI\Core\Interfaces\ISuccessCurlResponseDtoInterface.

    }

    /**
     * @param string $host
     * @param string $endpointClassName
     * @param IParametersInterface|null $parameters
     * @return IResponseInterface
     * @throws SDKException
     */
    public function publicEndpoint(string $host, string $endpointClassName, ?IParametersInterface $parameters = null): IResponseInterface
    {
        Credentials::setHost($host);
        return $this->rest($endpointClassName, $parameters);
    }

    /**
     * @param string $host
     * @param string $apiKey
     * @param string $secret
     * @param string $endpointClassName
     * @param IParametersInterface|null $parameters
     * @return IResponseInterface
     * @throws SDKException
     */
    public function privateEndpoint(string $host, string $apiKey, string $secret, string $endpointClassName, ?IParametersInterface $parameters = null): IResponseInterface
    {
        Credentials::setHost($host);
        Credentials::setApiKey($apiKey);
        Credentials::setSecret($secret);
        return $this->rest($endpointClassName, $parameters);
    }

    /**
     * @param string $webSocketChannelClassName
     * @param array $data
     * @return void
     * @throws \Exception
     */
    public function websocket(string $webSocketChannelClassName, IWebSocketArgumentInterface $data, IChannelHandlerInterface $channelHandler, int $mode = EnumOutputMode::MODE_ENTITY, int $wsClientTimeout = IWebSocketArgumentInterface::DEFAULT_SOCKET_CLIENT_TIMEOUT): void
    {
        WebSocketsBuilder::make($webSocketChannelClassName, $data, $channelHandler, $mode, $wsClientTimeout)->execute();
    }
}