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

Complexity

Total Complexity

17

Size/Duplication

Total Lines	202
Duplicated Lines	0 %

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getSymbol()	0	3	1
A	setBid()	0	12	2
A	getType()	0	3	1
A	setSymbol()	0	4	1
A	getCrossSequence()	0	3	1
A	setTopic()	0	4	1
A	__construct()	0	10	1
A	setAsk()	0	12	2
A	getUpdateId()	0	3	1
A	setType()	0	4	1
A	getAsk()	0	3	1
A	setCrossSequence()	0	4	1
A	getTopic()	0	3	1
A	setUpdateId()	0	4	1
A	getBid()	0	3	1

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

use Carpenstar\ByBitAPI\Core\Builders\ResponseBuilder;
use Carpenstar\ByBitAPI\Core\Interfaces\ICollectionInterface;
use Carpenstar\ByBitAPI\Core\Objects\Collection\EntityCollection;
use Carpenstar\ByBitAPI\Core\Objects\AbstractResponse;
use Carpenstar\ByBitAPI\WebSockets\Channels\Spot\PublicChannels\OrderBook\Entities\OrderBookPriceAbstract;

This use statement conflicts with another class in this namespace, Carpenstar\ByBitAPI\WebSockets\Channels\Derivatives\PublicChannels\OrderBook\Entities\OrderBookPriceAbstract. Consider defining an alias.

class OrderBookAbstract extends AbstractResponse
{

    /**
     * Topic name
     * @var string $topic
     */
    private string $topic;

    /**
     * Message type. snapshot,delta
     * @var string $type
     */
    private string $type;

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

    /**
     * @var \DateTime $timestamp
     */
    private \DateTime $timestamp;

The private property $timestamp is not used, and could be removed.

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

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

    /**
     * Update id, is always in sequence. Occasionally, you'll receive "u"=1,
     * which is a snapshot data due to the restart of the service.
     * So please overwrite the locally saved orderbook
     * @var null|int $updateId
     */
    private ?int $updateId;

    /**
     * @var null|int $crossSequence
     */
    private ?int $crossSequence;

    public function __construct(array $data)
    {
        $this
            ->setTopic($data['topic'])
            ->setType($data['type'])
            ->setSymbol($data['data']['s'])
            ->setBid($data['data']['b'])
            ->setAsk($data['data']['a'])
            ->setUpdateId($data['data']['u'])
            ->setCrossSequence($data['data']['seq']);
    }

    /**
     * @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;
    }

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

    /**
     * @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 array $asks
     * @return OrderBookAbstract
     * @throws \Exception
     */
    private function setAsk(array $asks): self
    {
        $askCollection = new EntityCollection();

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

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

    /**
     * @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(OrderBookPriceAbstract::class, $bidItem));
            }, $bids);
        }

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

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

    /**
     * @param int|null $updateId
     * @return self
     */
    private function setUpdateId(?int $updateId): self
    {
        $this->updateId = $updateId;
        return $this;
    }

    /**
     * @return int
     */
    public function getUpdateId(): int
    {
        return $this->updateId;

The expression return $this->updateId could return the type null which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }

    /**
     * @param int|null $crossSequence
     * @return self
     */
    private function setCrossSequence(?int $crossSequence): self
    {
        $this->crossSequence = $crossSequence;
        return $this;
    }

    /**
     * @return int
     */
    public function getCrossSequence(): int
    {
        return $this->crossSequence;

The expression return $this->crossSequence could return the type null which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }
}