PostRequest::buildRequestParams() - Code Metrics - Inspection of "Merge pull request #24 from carpenstar/v.5.0.0.2" - carpenstar/bybitapi-sdk-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a67e0e...5a6b87 )

by Vladislav

created 2024-07-27 23:57 UTC

PostRequest::buildRequestParams() A

↳ Parent: PostRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	1

<?php

namespace Carpenstar\ByBitAPI\Core\Request;

use Carpenstar\ByBitAPI\Core\Enums\EnumHttpMethods;
use Carpenstar\ByBitAPI\Core\Interfaces\IResponseHandlerInterface;

class PostRequest extends Curl
{
    /**
     * @param string $endpoint
     * @param array $params
     * @return IResponseHandlerInterface
     */
    public function execute(string $endpoint, array $params): array
    {
        $bodyParams = $this->buildRequestParams($params);

        $this->addCurlOpt(CURLOPT_URL, "{$this->credentials->getHost()}{$endpoint}")
             ->addCurlOpt(CURLOPT_CUSTOMREQUEST, EnumHttpMethods::POST)
             ->addCurlOpt(CURLOPT_ENCODING, '')
             ->addCurlOpt(CURLOPT_MAXREDIRS, 10)
             ->addCurlOpt(CURLOPT_TIMEOUT, 0)
             ->addCurlOpt(CURLOPT_FOLLOWLOCATION, true)
             ->addCurlOpt(CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1)
             ->addCurlOpt(CURLOPT_POSTFIELDS, $bodyParams);

        $this->auth($bodyParams);

        return $this->query();

    }

    /**
     * @param array $queryParams
     * @return string|null
     */
    private function buildRequestParams(array $queryParams): ?string
    {
        return json_encode($queryParams);
    }
}


1			<?php
2
3			namespace Carpenstar\ByBitAPI\Core\Request;
4
5			use Carpenstar\ByBitAPI\Core\Enums\EnumHttpMethods;
6			use Carpenstar\ByBitAPI\Core\Interfaces\IResponseHandlerInterface;
7
8			class PostRequest extends Curl
9			{
10			/**
11			* @param string $endpoint
12			* @param array $params
13			* @return IResponseHandlerInterface
14			*/
15			public function execute(string $endpoint, array $params): array
16			{
17			$bodyParams = $this->buildRequestParams($params);
18
19			$this->addCurlOpt(CURLOPT_URL, "{$this->credentials->getHost()}{$endpoint}")
20			->addCurlOpt(CURLOPT_CUSTOMREQUEST, EnumHttpMethods::POST)
21			->addCurlOpt(CURLOPT_ENCODING, '')
22			->addCurlOpt(CURLOPT_MAXREDIRS, 10)
23			->addCurlOpt(CURLOPT_TIMEOUT, 0)
24			->addCurlOpt(CURLOPT_FOLLOWLOCATION, true)
25			->addCurlOpt(CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1)
26			->addCurlOpt(CURLOPT_POSTFIELDS, $bodyParams);
27
28			$this->auth($bodyParams);
29
30			return $this->query();
			0 ignored issues – show Bug Best Practice introduced 2024-07-28 00:04 UTC by Report Bug Copy Issue Report The expression `return $this->query()` returns the type `array` which is incompatible with the documented return type `Carpenstar\ByBitAPI\Core...esponseHandlerInterface`. Loading history...
31			}
32
33			/**
34			* @param array $queryParams
35			* @return string\|null
36			*/
37			private function buildRequestParams(array $queryParams): ?string
38			{
39			return json_encode($queryParams);
40			}
41			}
42

carpenstar / bybitapi-sdk-core

Push — master ( a67e0e...5a6b87 )

PostRequest::buildRequestParams() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like