Carpenstar\ByBitAPI\WebSockets\Channels\Spot\PublicChannels\OrderBook\Entities\OrderBookAbstract

Complexity

Total Complexity

17

Size/Duplication

Total Lines	196
Duplicated Lines	0 %

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getTopic()	0	3	1
A	getAsk()	0	3	1
A	getType()	0	3	1
A	getSymbol()	0	3	1
A	setResponseTimestamp()	0	4	1
A	setBid()	0	12	2
A	setType()	0	4	1
A	getResponseTimestamp()	0	3	1
A	setRequestTimestamp()	0	4	1
A	setAsk()	0	12	2
A	getBid()	0	3	1
A	setSymbol()	0	4	1
A	__construct()	0	10	1
A	getRequestTimestamp()	0	3	1
A	setTopic()	0	4	1

<?php
namespace Carpenstar\ByBitAPI\WebSockets\Channels\Spot\PublicChannels\OrderBook\Entities;

use Carpenstar\ByBitAPI\Core\Builders\ResponseBuilder;
use Carpenstar\ByBitAPI\Core\Helpers\DateTimeHelper;
use Carpenstar\ByBitAPI\Core\Interfaces\ICollectionInterface;
use Carpenstar\ByBitAPI\Core\Objects\Collection\EntityCollection;
use Carpenstar\ByBitAPI\Core\Objects\AbstractResponse;

class OrderBookAbstract extends AbstractResponse
{
    /**
     * Topic name
     * @var string $topic
     */
    private string $topic;

    /**
     * Data type. snapshot
     * @var string $type
     */
    private string $type;

    /**
     * Trading pair
     * @var string $symbol
     */
    private string $symbol;

    /**
     * The timestamp that message is sent out
     * @var \DateTime $requestTimestamp
     */
    private \DateTime $requestTimestamp;

    /**
     * The timestamp that system generates the data.
     * @var \DateTime $responseTimestamp
     */
    private \DateTime $responseTimestamp;

    /**
     * @var ICollectionInterface $ask
     */
    private ICollectionInterface $ask;

    /**
     * @var ICollectionInterface $bid
     */
    private ICollectionInterface $bid;

    public function __construct(array $data)
    {
        $this
            ->setSymbol($data['data']['s'] ?? null)

It seems like $data['data']['s'] ?? null can also be of type null; however, parameter $symbol of Carpenstar\ByBitAPI\WebSockets\Channels\Spot\PublicChannels\OrderBook\Entities\OrderBookAbstract::setSymbol() does only seem to accept string, maybe add an additional type check?

            ->setTopic($data['topic'] ?? null)

It seems like $data['topic'] ?? null can also be of type null; however, parameter $topic of Carpenstar\ByBitAPI\WebSockets\Channels\Spot\PublicChannels\OrderBook\Entities\OrderBookAbstract::setTopic() does only seem to accept string, maybe add an additional type check?

            ->setType($data['type'] ?? null)

It seems like $data['type'] ?? null can also be of type null; however, parameter $type of Carpenstar\ByBitAPI\WebSockets\Channels\Spot\PublicChannels\OrderBook\Entities\OrderBookAbstract::setType() does only seem to accept string, maybe add an additional type check?

            ->setBid($data['data']['b'] ?? null)

It seems like $data['data']['b'] ?? null can also be of type null; however, parameter $bids of Carpenstar\ByBitAPI\WebSockets\Channels\Spot\PublicChannels\OrderBook\Entities\OrderBookAbstract::setBid() does only seem to accept array, maybe add an additional type check?

            ->setAsk($data['data']['a'] ?? null)
            ->setRequestTimestamp($data['ts'] ?? null)

It seems like $data['ts'] ?? null can also be of type null; however, parameter $timestamp of Carpenstar\ByBitAPI\WebSockets\Channels\Spot\PublicChannels\OrderBook\Entities\OrderBookAbstract::setRequestTimestamp() does only seem to accept string, maybe add an additional type check?

            ->setResponseTimestamp($data['data']['t'] ?? null);

It seems like $data['data']['t'] ?? null can also be of type null; however, parameter $timestamp of Carpenstar\ByBitAPI\WebSockets\Channels\Spot\PublicChannels\OrderBook\Entities\OrderBookAbstract::setResponseTimestamp() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * @param string $topic
     * @return self
     */
    private function setTopic(string $topic): self
    {
        $this->topic = $topic;
        return $this;
    }

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

    /**
     * @param string $type
     * @return self
     */
    private function setType(string $type): self
    {
        $this->type = $type;
        return $this;
    }

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

    /**
     * @param string $symbol
     * @return self
     */
    private function setSymbol(string $symbol): self
    {
        $this->symbol = $symbol;
        return $this;
    }

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

    /**
     * @param string $timestamp
     * @return self
     */
    private function setRequestTimestamp(string $timestamp): self
    {
        $this->requestTimestamp = DateTimeHelper::makeFromTimestamp($timestamp);

$timestamp of type string is incompatible with the type integer expected by parameter $timestamp of Carpenstar\ByBitAPI\Core\Helpers\DateTimeHelper::makeFromTimestamp().

        return $this;
    }

    /**
     * @return \DateTime
     */
    public function getRequestTimestamp(): \DateTime
    {
        return $this->requestTimestamp;
    }

    /**
     * @param string $timestamp
     * @return self
     */
    private function setResponseTimestamp(string $timestamp): self
    {
        $this->responseTimestamp = DateTimeHelper::makeFromTimestamp($timestamp);

$timestamp of type string is incompatible with the type integer expected by parameter $timestamp of Carpenstar\ByBitAPI\Core\Helpers\DateTimeHelper::makeFromTimestamp().

        return $this;
    }

    /**
     * @return \DateTime
     */
    public function getResponseTimestamp(): \DateTime
    {
        return $this->responseTimestamp;
    }

    /**
     * @param $asks
     * @return self
     * @throws \Exception
     */
    private function setAsk($asks): self
    {
        $askCollection = new EntityCollection();

        if (!empty($asks)) {
            array_map(function ($askItem) use ($askCollection) {
                $askCollection->push(ResponseBuilder::make(OrderBookPriceDTO::class, $askItem));

The type Carpenstar\ByBitAPI\WebSockets\Channels\Spot\PublicChannels\OrderBook\Entities\OrderBookPriceDTO was not found. Maybe you did not declare it correctly or list all dependencies?

            }, $asks);
        }

        $this->ask = $askCollection;
        return $this;
    }

    /**
     * @return ICollectionInterface
     */
    public function getAsk(): ICollectionInterface
    {
        return $this->ask;
    }

    /**
     * @param array $bids
     * @return OrderBookAbstract
     * @throws \Exception
     */
    private function setBid(array $bids): self
    {
        $bidCollection = new EntityCollection();

        if (!empty($bids)) {
            array_map(function ($bidItem) use ($bidCollection) {
                $bidCollection->push(ResponseBuilder::make(OrderBookPriceDTO::class, $bidItem));
            }, $bids);
        }

        $this->bid = $bidCollection;
        return $this;
    }

    /**
     * @return ICollectionInterface
     */
    public function getBid(): ICollectionInterface
    {
        return $this->bid;
    }
}