Carpenstar\ByBitAPI\WebSockets\Spot\PublicChannels\Tickers\Entities\TickersResponseItem

Complexity

Total Complexity

11

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getClosePrice()	0	3	1
A	getTimestamp()	0	3	1
A	getTradingQuoteVolume()	0	3	1
A	getSymbol()	0	3	1
A	getUsdIndexPrice()	0	3	1
A	getLowPrice()	0	3	1
A	__construct()	0	12	1
A	getHighPrice()	0	3	1
A	getTradingVolume()	0	3	1
A	getOpenPrice()	0	3	1
A	getChange()	0	3	1

<?php

namespace Carpenstar\ByBitAPI\WebSockets\Spot\PublicChannels\Tickers\Entities;

use Carpenstar\ByBitAPI\Core\Helpers\DateTimeHelper;
use Carpenstar\ByBitAPI\Core\Objects\AbstractResponse;

/**
 * https://bybit-exchange.github.io/docs/derivatives/ws-public/ticker
 */
class TickersResponseItem extends AbstractResponse
{
    /**
     * Trading pair
     * @var string $symbol
     */
    private string $symbol;

    /**
     * Timestamp (trading time in the match box)
     * @var null|\DateTime $timestamp
     */
    private ?\DateTime $timestamp;

    /**
     * Open price
     * @var float $openPrice
     */
    private float $openPrice;

    /**
     * High price
     * @var float $highPrice
     */
    private float $highPrice;

    /**
     * Low price
     * @var float $lowPrice
     */
    private float $lowPrice;

    /**
     * Close price
     * @var float $closePrice
     */
    private float $closePrice;

    /**
     * Trading volume
     * @var float $tradingVolume
     */
    private float $tradingVolume;

    /**
     * Trading quote volume
     * @var float $tradinguoteVolume
     */
    private float $tradinqQuoteVolume;

    /**
     * Change
     * @var float $change
     */
    private float $change;

    /**
     * USD index price. It can be empty
     * @var null|string $usdIndexPrice
     */
    private ?string $usdIndexPrice;

    public function __construct(array $data)
    {
        $this->timestamp =  DateTimeHelper::makeFromTimestamp($data['t']);
        $this->symbol = $data['s'];
        $this->openPrice = $data['o'];
        $this->highPrice = $data['h'];
        $this->lowPrice = $data['l'];
        $this->closePrice = $data['c'];
        $this->tradingVolume = $data['v'];
        $this->tradinqQuoteVolume = $data['qv'];
        $this->change = $data['m'];
        $this->usdIndexPrice = $data['xp'];
    }

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

    /**
     * @return string|null
     */
    public function getOpenPrice(): ?float
    {
        return $this->openPrice;
    }

    /**
     * @return float|null
     */
    public function getHighPrice(): ?float
    {
        return $this->highPrice;
    }

    /**
     * @return float|null
     */
    public function getLowPrice(): ?float
    {
        return $this->lowPrice;
    }

    /**
     * @return float|null
     */
    public function getClosePrice(): ?float
    {
        return $this->closePrice;
    }

    /**
     * @return float|null
     */
    public function getTradingVolume(): ?float
    {
        return $this->tradingVolume;
    }

    /**
     * @return float|null
     */
    public function getTradingQuoteVolume(): ?float
    {
        return $this->tradinqQuoteVolume;
    }

    /**
     * @return float|null
     */
    public function getChange(): ?float
    {
        return $this->change;
    }

    /**
     * @return float|null
     */
    public function getUsdIndexPrice(): ?string
    {
        return $this->usdIndexPrice;

The expression return $this->usdIndexPrice also could return the type string which is incompatible with the documented return type double|null.

    }

    /**
     * @return \DateTime|null
     */
    public function getTimestamp(): ?\DateTime
    {
        return $this->timestamp;
    }
}