Carpenstar\ByBitAPI\WebSockets\Derivatives\PublicChannels\OrderBook\Entities\OrderBookResponse

Complexity

Total Complexity

11

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getCrossSequence()	0	3	1
A	getSymbol()	0	3	1
A	getType()	0	3	1
A	getTopic()	0	3	1
A	getBid()	0	3	1
A	getUpdateId()	0	3	1
A	getAsk()	0	3	1
A	__construct()	0	28	4

<?php

namespace Carpenstar\ByBitAPI\WebSockets\Derivatives\PublicChannels\OrderBook\Entities;

use Carpenstar\ByBitAPI\Core\Builders\ResponseDtoBuilder;
use Carpenstar\ByBitAPI\Core\Interfaces\ICollectionInterface;
use Carpenstar\ByBitAPI\Core\Objects\Collection\EntityCollection;
use Carpenstar\ByBitAPI\Core\Objects\AbstractResponse;

class OrderBookResponse 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)
    {
        $askCollection = new EntityCollection();
        $bidCollection = new EntityCollection();

        $this->topic = $data['topic'] ?? null;
        $this->type = $data['type'] ?? null;

        if (!empty($data['data'])) {
            if (!empty($data['data']['a'])) {
                array_map(function ($askItem) use ($askCollection) {
                    $askCollection->push(ResponseDtoBuilder::make(OrderBookResponseItem::class, $askItem));
                }, $data['data']['a']);
            }
    
            if (!empty($data['data']['b'])) {
                array_map(function ($bidItem) use ($bidCollection) {
                    $bidCollection->push(ResponseDtoBuilder::make(OrderBookResponseItem::class, $bidItem));
                }, $data['data']['b']);
            }

            $this->symbol = $data['data']['s'];
            $this->updateId = $data['data']['u'];
            $this->crossSequence = $data['data']['seq'];
        }

        $this->bid = $bidCollection;
        $this->ask = $askCollection;
    }

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

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

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

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

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

    /**
     * @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.

    }

    /**
     * @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.

    }
}