Bpack247::getUserAgent() - Code Metrics - Inspection of "62528d1dddcb215496c54111843faaca8e7bd609" - zangra-dev/bpost-api-library - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Branch — master (62528d)

by Zangra

created 2025-09-12 10:40 UTC

Bpack247::getUserAgent() A

↳ Parent: Bpack247

Complexity

Conditions	2
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
declare(strict_types=1);

namespace Bpost\BpostApiClient;

use Bpost\BpostApiClient\Bpack247\Customer;
use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostApiBusinessException;
use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostApiSystemException;
use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostCurlException;
use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostInvalidResponseException;
use DOMDocument;
use SimpleXMLElement;
use CurlHandle;

/**
 * bPost Bpack24/7 class
 *
 * @author    Tijs Verkoyen <[email protected]>
 *
 * @version   3.0.0
 *
 * @copyright Copyright (c), Tijs Verkoyen. All rights reserved.
 * @license   BSD License
 */
class Bpack247
{
    /** URL for the API */
    public const API_URL = 'http://www.bpack247.be/BpostRegistrationWebserviceREST/servicecontroller.svc';

    /** current version */
    public const VERSION = '3.0.0';

    private string $accountId;
    private string $passPhrase;

    /** @var CurlHandle|null */
    private ?CurlHandle $curl = null;

    /** * The port to use. */
    private ?int $port = null;

    /** Timeout in seconds */
    private int $timeOut = 30;

    private string $userAgent = '';

    public function __construct(string $accountId, string $passPhrase)
    {
        $this->accountId  = $accountId;
        $this->passPhrase = $passPhrase;
    }

    /**
     * Make the call
     *
     * @throws BpostApiBusinessException
     * @throws BpostApiSystemException
     * @throws BpostCurlException
     * @throws BpostInvalidResponseException
     */
    private function doCall(string $url, ?string $body = null, string $method = 'GET'): SimpleXMLElement
    {
        $headers = [
            'Authorization: Basic ' . $this->getAuthorizationHeader(),
        ];

        $options = [
            CURLOPT_URL            => self::API_URL . $url,
            CURLOPT_USERAGENT      => $this->getUserAgent(),
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_TIMEOUT        => $this->getTimeOut(),
            CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_1_1,
            CURLOPT_HTTPHEADER     => $headers,
        ];

        if ($this->port !== null) {
            $options[CURLOPT_PORT] = $this->port;
        }

        if ($method === 'POST') {
            $options[CURLOPT_POST]       = true;
            $options[CURLOPT_POSTFIELDS] = $body ?? '';
        }

        $this->curl = curl_init();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        curl_setopt_array($this->curl, $options);

        try {
            $response = curl_exec($this->curl);
            $info     = curl_getinfo($this->curl);

            $errorNumber  = curl_errno($this->curl);
            $errorMessage = curl_error($this->curl);

            if ($errorNumber !== 0) {
                throw new BpostCurlException($errorMessage, $errorNumber);
            }

            $httpCode = (int)($info['http_code'] ?? 0);

            // Non 200 => tenter de parser l'erreur métier pour renvoyer l’exception dédiée
            if (!in_array($httpCode, [0, 200], true)) {
                $xml = @simplexml_load_string((string)$response);

                if (
                    $xml !== false
                    && ($xml->getName() === 'businessException' || $xml->getName() === 'systemException')
                ) {
                    $message = (string) ($xml->message ?? '');
                    $code    = isset($xml->code) ? (int) $xml->code : 0;

                    if ($xml->getName() === 'businessException') {
                        throw new BpostApiBusinessException($message, $code);
                    }
                    throw new BpostApiSystemException($message, $code);
                }

                throw new BpostInvalidResponseException('', $httpCode);
            }

            // 200: parser XML
            $xml = simplexml_load_string((string)$response);
            if ($xml === false) {
                // pas de XML valide alors que 200 => considérer comme réponse invalide
                throw new BpostInvalidResponseException('Empty or invalid XML body', 200);
            }

            if ($xml->getName() === 'businessException') {
                $message = (string) ($xml->message ?? '');
                $code    = (int) ($xml->code ?? 0);
                throw new BpostApiBusinessException($message, $code);
            }

            return $xml;
        } finally {
            if (is_resource($this->curl) || $this->curl instanceof CurlHandle) {
                curl_close($this->curl);
            }
            $this->curl = null;
        }
    }

    /**
     * Generate the secret string for the Authorization header
     */
    private function getAuthorizationHeader(): string
    {
        return base64_encode($this->accountId . ':' . $this->passPhrase);
    }

    /**
     * After this time the request will stop.
     */
    public function setTimeOut(int $seconds): void
    {
        $this->timeOut = $seconds;
    }

    public function getTimeOut(): int
    {
        return $this->timeOut;
    }

    /**
     * Get the useragent that will be used.
     * Our version will be prepended to yours.
     * It will look like: "PHP Bpost/<version> <your-user-agent>"
     *
     * @return string
     */
    public function getUserAgent(): string
    {
        $extra = trim($this->userAgent);
        return sprintf('PHP Bpost Bpack247/%s%s', self::VERSION, $extra !== '' ? ' ' . $extra : '');
    }

    /**
     * Set your application user-agent, e.g. "MyApp/1.2.3"
     */
    public function setUserAgent(string $userAgent): void
    {
        $this->userAgent = $userAgent;
    }

    // Webservice methods
    /**
     * @throws BpostApiBusinessException
     * @throws BpostApiSystemException
     * @throws BpostCurlException
     * @throws BpostInvalidResponseException
     */
    public function createMember(Customer $customer): SimpleXMLElement
    {
        $url = '/customer';

        $document = new DOMDocument('1.0', 'utf-8');
        $document->preserveWhiteSpace = false;
        $document->formatOutput = true;

        $document->appendChild($customer->toXML($document));

        return $this->doCall($url, $document->saveXML(), 'POST');
    }

    /**
     * Retrieve member information
     *
     * @throws BpostApiBusinessException
     * @throws BpostApiSystemException
     * @throws BpostCurlException
     * @throws BpostInvalidResponseException
     * @throws Exception\XmlException\BpostXmlNoUserIdFoundException
     */
    public function getMember(string $id): Customer
    {
        $xml = $this->doCall('/customer/' . $id);
        return Customer::createFromXML($xml);
    }
}

1			<?php
2			declare(strict_types=1);
3
4			namespace Bpost\BpostApiClient;
5
6			use Bpost\BpostApiClient\Bpack247\Customer;
7			use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostApiBusinessException;
8			use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostApiSystemException;
9			use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostCurlException;
10			use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostInvalidResponseException;
11			use DOMDocument;
12			use SimpleXMLElement;
13			use CurlHandle;
14
15			/**
16			* bPost Bpack24/7 class
17			*
18			* @author Tijs Verkoyen <[email protected]>
19			*
20			* @version 3.0.0
21			*
22			* @copyright Copyright (c), Tijs Verkoyen. All rights reserved.
23			* @license BSD License
24			*/
25			class Bpack247
26			{
27			/** URL for the API */
28			public const API_URL = 'http://www.bpack247.be/BpostRegistrationWebserviceREST/servicecontroller.svc';
29
30			/** current version */
31			public const VERSION = '3.0.0';
32
33			private string $accountId;
34			private string $passPhrase;
35
36			/** @var CurlHandle\|null */
37			private ?CurlHandle $curl = null;
38
39			/** * The port to use. */
40			private ?int $port = null;
41
42			/** Timeout in seconds */
43			private int $timeOut = 30;
44
45			private string $userAgent = '';
46
47			public function __construct(string $accountId, string $passPhrase)
48			{
49			$this->accountId = $accountId;
50			$this->passPhrase = $passPhrase;
51			}
52
53			/**
54			* Make the call
55			*
56			* @throws BpostApiBusinessException
57			* @throws BpostApiSystemException
58			* @throws BpostCurlException
59			* @throws BpostInvalidResponseException
60			*/
61			private function doCall(string $url, ?string $body = null, string $method = 'GET'): SimpleXMLElement
62			{
63			$headers = [
64			'Authorization: Basic ' . $this->getAuthorizationHeader(),
65			];
66
67			$options = [
68			CURLOPT_URL => self::API_URL . $url,
69			CURLOPT_USERAGENT => $this->getUserAgent(),
70			CURLOPT_RETURNTRANSFER => true,
71			CURLOPT_TIMEOUT => $this->getTimeOut(),
72			CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
73			CURLOPT_HTTPHEADER => $headers,
74			];
75
76			if ($this->port !== null) {
77			$options[CURLOPT_PORT] = $this->port;
78			}
79
80			if ($method === 'POST') {
81			$options[CURLOPT_POST] = true;
82			$options[CURLOPT_POSTFIELDS] = $body ?? '';
83			}
84
85			$this->curl = curl_init();
			0 ignored issues – show Documentation Bug introduced 2025-09-12 10:13 UTC by Report Bug Copy Issue Report It seems like `curl_init()` can also be of type `resource`. However, the property `$curl` is declared as type `CurlHandle\|null`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
86			curl_setopt_array($this->curl, $options);
87
88			try {
89			$response = curl_exec($this->curl);
90			$info = curl_getinfo($this->curl);
91
92			$errorNumber = curl_errno($this->curl);
93			$errorMessage = curl_error($this->curl);
94
95			if ($errorNumber !== 0) {
96			throw new BpostCurlException($errorMessage, $errorNumber);
97			}
98
99			$httpCode = (int)($info['http_code'] ?? 0);
100
101			// Non 200 => tenter de parser l'erreur métier pour renvoyer l’exception dédiée
102			if (!in_array($httpCode, [0, 200], true)) {
103			$xml = @simplexml_load_string((string)$response);
104
105			if (
106			$xml !== false
107			&& ($xml->getName() === 'businessException' \|\| $xml->getName() === 'systemException')
108			) {
109			$message = (string) ($xml->message ?? '');
110			$code = isset($xml->code) ? (int) $xml->code : 0;
111
112			if ($xml->getName() === 'businessException') {
113			throw new BpostApiBusinessException($message, $code);
114			}
115			throw new BpostApiSystemException($message, $code);
116			}
117
118			throw new BpostInvalidResponseException('', $httpCode);
119			}
120
121			// 200: parser XML
122			$xml = simplexml_load_string((string)$response);
123			if ($xml === false) {
124			// pas de XML valide alors que 200 => considérer comme réponse invalide
125			throw new BpostInvalidResponseException('Empty or invalid XML body', 200);
126			}
127
128			if ($xml->getName() === 'businessException') {
129			$message = (string) ($xml->message ?? '');
130			$code = (int) ($xml->code ?? 0);
131			throw new BpostApiBusinessException($message, $code);
132			}
133
134			return $xml;
135			} finally {
136			if (is_resource($this->curl) \|\| $this->curl instanceof CurlHandle) {
137			curl_close($this->curl);
138			}
139			$this->curl = null;
140			}
141			}
142
143			/**
144			* Generate the secret string for the Authorization header
145			*/
146			private function getAuthorizationHeader(): string
147			{
148			return base64_encode($this->accountId . ':' . $this->passPhrase);
149			}
150
151			/**
152			* After this time the request will stop.
153			*/
154			public function setTimeOut(int $seconds): void
155			{
156			$this->timeOut = $seconds;
157			}
158
159			public function getTimeOut(): int
160			{
161			return $this->timeOut;
162			}
163
164			/**
165			* Get the useragent that will be used.
166			* Our version will be prepended to yours.
167			* It will look like: "PHP Bpost/<version> <your-user-agent>"
168			*
169			* @return string
170			*/
171			public function getUserAgent(): string
172			{
173			$extra = trim($this->userAgent);
174			return sprintf('PHP Bpost Bpack247/%s%s', self::VERSION, $extra !== '' ? ' ' . $extra : '');
175			}
176
177			/**
178			* Set your application user-agent, e.g. "MyApp/1.2.3"
179			*/
180			public function setUserAgent(string $userAgent): void
181			{
182			$this->userAgent = $userAgent;
183			}
184
185			// Webservice methods
186			/**
187			* @throws BpostApiBusinessException
188			* @throws BpostApiSystemException
189			* @throws BpostCurlException
190			* @throws BpostInvalidResponseException
191			*/
192			public function createMember(Customer $customer): SimpleXMLElement
193			{
194			$url = '/customer';
195
196			$document = new DOMDocument('1.0', 'utf-8');
197			$document->preserveWhiteSpace = false;
198			$document->formatOutput = true;
199
200			$document->appendChild($customer->toXML($document));
201
202			return $this->doCall($url, $document->saveXML(), 'POST');
203			}
204
205			/**
206			* Retrieve member information
207			*
208			* @throws BpostApiBusinessException
209			* @throws BpostApiSystemException
210			* @throws BpostCurlException
211			* @throws BpostInvalidResponseException
212			* @throws Exception\XmlException\BpostXmlNoUserIdFoundException
213			*/
214			public function getMember(string $id): Customer
215			{
216			$xml = $this->doCall('/customer/' . $id);
217			return Customer::createFromXML($xml);
218			}
219			}

zangra-dev / bpost-api-library

Branch — master (62528d)

Bpack247::getUserAgent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like