InternetDocument::getDocumentPrice() - Code Metrics - Inspection of "Internet document model" - sergeynezbritskiy/nova-poshta-api - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#13)

by Sergey

created 2023-07-18 23:27 UTC

InternetDocument::getDocumentPrice() A

↳ Parent: InternetDocument

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

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

<?php

/**
 * @noinspection PhpUnused
 */

declare(strict_types=1);

namespace SergeyNezbritskiy\NovaPoshta\Models;

use SergeyNezbritskiy\NovaPoshta\Connection;
use SergeyNezbritskiy\NovaPoshta\ModelInterface;
use SergeyNezbritskiy\NovaPoshta\NovaPoshtaApiException;

class InternetDocument implements ModelInterface
{
    public const CARGO_TYPE_CARGO = 'Cargo';
    public const CARGO_TYPE_DOCUMENTS = 'Documents';
    public const CARGO_TYPE_TIRES_WHEELS = 'TiresWheels';
    public const CARGO_TYPE_PALLET = 'Pallet';

    private const MODEL_NAME = 'InternetDocument';
    private Connection $connection;

    /**
     * @param Connection $connection
     */
    public function __construct(Connection $connection)
    {
        $this->connection = $connection;
    }

    /**
     * @see https://developers.novaposhta.ua/view/model/a90d323c-8512-11ec-8ced-005056b2dbe1/method/a91f115b-8512-11ec-8ced-005056b2dbe1
     * @see \SergeyNezbritskiy\NovaPoshta\Tests\Integration\Models\InternetDocument\GetDocumentPriceTest for more cases
     * @param array $params
     *    $params = [
     *        'CitySender'          => (string) City ref. Required
     *        'CityRecipient'       => (string) City ref. Required
     *        'Weight'              => (string) Minimal value - 0.1. Required
     *        'ServiceTYpe'         => (string) Optional
     *        'Cost'                => (float)  Optional, default - 300.00
     *        'CargoType'           => (string) Cargo type. see self::CARGO_TYPE_* constants, Optional
     *        'CargoDetails'        => [
     *            [
     *                'CargoDescription' => (string),
     *                'Amount' => (float)
     *            ],
     *            ...
     *        ]
     *        'RedeliveryCalculate' => [ Back delivery. Optional
     *            [
     *                'CargoType' => (string), e.g. Money
     *                'Amount' => (float)
     *            ],
     *            ...
     *        ],
     *        'OptionsSeat' => [
     *            'weight' => (float), Required.
     *            'volumetricWidth' => (float), Required.
     *            'volumetricLength' => (float), Required.
     *            'volumetricHeight' => (float), Required.
     *            'packRef' => (string), Optional.
     *        ],
     *        'SeatsAmount'         => (int) Optional
     *        'PackCount'           => (int) Optional
     *        'CargoDescription'    => (string) Cargo type. see self::CARGO_TYPE_* constants, Optional
     *        'PackCount'           => (string) The amount of packing, Optional
     *        'PackRef'             => (string) Packing identifier (REF). Optional
     *        'Amount'              => (int) Amount of back delivery. Optional
     *    ]
     * @return array
     * @throws NovaPoshtaApiException
     */
    public function getDocumentPrice(array $params): array
    {
        $result = $this->connection->post(self::MODEL_NAME, 'getDocumentPrice', $params);
        return array_shift($result);
    }

    /**
     * @see https://developers.novaposhta.ua/view/model/a90d323c-8512-11ec-8ced-005056b2dbe1/method/a941c714-8512-11ec-8ced-005056b2dbe1
     * @see \SergeyNezbritskiy\NovaPoshta\Tests\Integration\Models\InternetDocument\GetDocumentDeliveryDateTest
     * @param array $params
     *         $params = [
     *              'DateTime'      => (string), Document creation date, format `d.m.Y`. Optional.
     *              'ServiceType'   => (string), Required.
     *              'CitySender'    => (string), city ref. Required.
     *              'CityRecipient' => (string), city ref. Required.
     *          ];
     * @return array
     * @throws NovaPoshtaApiException
     */
    public function getDocumentDeliveryDate(array $params): array
    {
        $result = $this->connection->post(self::MODEL_NAME, 'getDocumentDeliveryDate', $params);
        return array_shift($result)['DeliveryDate'];
    }

    /**
     * @see https://developers.novaposhta.ua/view/model/a90d323c-8512-11ec-8ced-005056b2dbe1/method/a9d22b34-8512-11ec-8ced-005056b2dbe1
     * @param string $dateFrom
     * @param string $dateTo
     * @param bool $fullList
     * @param string|null $date
     * @param int|null $page
     * @return array
     * @throws NovaPoshtaApiException
     */
    public function getDocumentList(array $params, int $page = null): array
    {
        if ($page) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $params['Page'] = $page;
        }
        return $this->connection->post(self::MODEL_NAME, 'getDocumentList', $params);
    }

    /**
     * @see https://developers.novaposhta.ua/view/model/a90d323c-8512-11ec-8ced-005056b2dbe1/method/a965630e-8512-11ec-8ced-005056b2dbe1
     * @param array $params
     * @return array
     * @throws NovaPoshtaApiException
     */
    public function save(array $params): array
    {
        $result = $this->connection->post(self::MODEL_NAME, 'save', $params);
        return array_shift($result);
    }

    /**
     * @see https://developers.novaposhta.ua/view/model/a90d323c-8512-11ec-8ced-005056b2dbe1/method/a965630e-8512-11ec-8ced-005056b2dbe1
     * @param string $documentRef
     * @return void
     * @throws NovaPoshtaApiException
     */
    public function delete(string $documentRef): void
    {
        $this->connection->post(self::MODEL_NAME, 'delete', ['DocumentRefs' => $documentRef]);
    }
}


1			<?php
2
3			/**
4			* @noinspection PhpUnused
5			*/
6
7			declare(strict_types=1);
8
9			namespace SergeyNezbritskiy\NovaPoshta\Models;
10
11			use SergeyNezbritskiy\NovaPoshta\Connection;
12			use SergeyNezbritskiy\NovaPoshta\ModelInterface;
13			use SergeyNezbritskiy\NovaPoshta\NovaPoshtaApiException;
14
15			class InternetDocument implements ModelInterface
16			{
17			public const CARGO_TYPE_CARGO = 'Cargo';
18			public const CARGO_TYPE_DOCUMENTS = 'Documents';
19			public const CARGO_TYPE_TIRES_WHEELS = 'TiresWheels';
20			public const CARGO_TYPE_PALLET = 'Pallet';
21
22			private const MODEL_NAME = 'InternetDocument';
23			private Connection $connection;
24
25			/**
26			* @param Connection $connection
27			*/
28			public function __construct(Connection $connection)
29			{
30			$this->connection = $connection;
31			}
32
33			/**
34			* @see https://developers.novaposhta.ua/view/model/a90d323c-8512-11ec-8ced-005056b2dbe1/method/a91f115b-8512-11ec-8ced-005056b2dbe1
35			* @see \SergeyNezbritskiy\NovaPoshta\Tests\Integration\Models\InternetDocument\GetDocumentPriceTest for more cases
36			* @param array $params
37			* $params = [
38			* 'CitySender' => (string) City ref. Required
39			* 'CityRecipient' => (string) City ref. Required
40			* 'Weight' => (string) Minimal value - 0.1. Required
41			* 'ServiceTYpe' => (string) Optional
42			* 'Cost' => (float) Optional, default - 300.00
43			* 'CargoType' => (string) Cargo type. see self::CARGO_TYPE_* constants, Optional
44			* 'CargoDetails' => [
45			* [
46			* 'CargoDescription' => (string),
47			* 'Amount' => (float)
48			* ],
49			* ...
50			* ]
51			* 'RedeliveryCalculate' => [ Back delivery. Optional
52			* [
53			* 'CargoType' => (string), e.g. Money
54			* 'Amount' => (float)
55			* ],
56			* ...
57			* ],
58			* 'OptionsSeat' => [
59			* 'weight' => (float), Required.
60			* 'volumetricWidth' => (float), Required.
61			* 'volumetricLength' => (float), Required.
62			* 'volumetricHeight' => (float), Required.
63			* 'packRef' => (string), Optional.
64			* ],
65			* 'SeatsAmount' => (int) Optional
66			* 'PackCount' => (int) Optional
67			* 'CargoDescription' => (string) Cargo type. see self::CARGO_TYPE_* constants, Optional
68			* 'PackCount' => (string) The amount of packing, Optional
69			* 'PackRef' => (string) Packing identifier (REF). Optional
70			* 'Amount' => (int) Amount of back delivery. Optional
71			* ]
72			* @return array
73			* @throws NovaPoshtaApiException
74			*/
75			public function getDocumentPrice(array $params): array
76			{
77			$result = $this->connection->post(self::MODEL_NAME, 'getDocumentPrice', $params);
78			return array_shift($result);
79			}
80
81			/**
82			* @see https://developers.novaposhta.ua/view/model/a90d323c-8512-11ec-8ced-005056b2dbe1/method/a941c714-8512-11ec-8ced-005056b2dbe1
83			* @see \SergeyNezbritskiy\NovaPoshta\Tests\Integration\Models\InternetDocument\GetDocumentDeliveryDateTest
84			* @param array $params
85			* $params = [
86			* 'DateTime' => (string), Document creation date, format `d.m.Y`. Optional.
87			* 'ServiceType' => (string), Required.
88			* 'CitySender' => (string), city ref. Required.
89			* 'CityRecipient' => (string), city ref. Required.
90			* ];
91			* @return array
92			* @throws NovaPoshtaApiException
93			*/
94			public function getDocumentDeliveryDate(array $params): array
95			{
96			$result = $this->connection->post(self::MODEL_NAME, 'getDocumentDeliveryDate', $params);
97			return array_shift($result)['DeliveryDate'];
98			}
99
100			/**
101			* @see https://developers.novaposhta.ua/view/model/a90d323c-8512-11ec-8ced-005056b2dbe1/method/a9d22b34-8512-11ec-8ced-005056b2dbe1
102			* @param string $dateFrom
103			* @param string $dateTo
104			* @param bool $fullList
105			* @param string\|null $date
106			* @param int\|null $page
107			* @return array
108			* @throws NovaPoshtaApiException
109			*/
110			public function getDocumentList(array $params, int $page = null): array
111			{
112			if ($page) {
			0 ignored issues – show Bug Best Practice introduced 2023-07-18 23:41 UTC by Report Bug Copy Issue Report The expression `$page` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be 0. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
113			$params['Page'] = $page;
114			}
115			return $this->connection->post(self::MODEL_NAME, 'getDocumentList', $params);
116			}
117
118			/**
119			* @see https://developers.novaposhta.ua/view/model/a90d323c-8512-11ec-8ced-005056b2dbe1/method/a965630e-8512-11ec-8ced-005056b2dbe1
120			* @param array $params
121			* @return array
122			* @throws NovaPoshtaApiException
123			*/
124			public function save(array $params): array
125			{
126			$result = $this->connection->post(self::MODEL_NAME, 'save', $params);
127			return array_shift($result);
128			}
129
130			/**
131			* @see https://developers.novaposhta.ua/view/model/a90d323c-8512-11ec-8ced-005056b2dbe1/method/a965630e-8512-11ec-8ced-005056b2dbe1
132			* @param string $documentRef
133			* @return void
134			* @throws NovaPoshtaApiException
135			*/
136			public function delete(string $documentRef): void
137			{
138			$this->connection->post(self::MODEL_NAME, 'delete', ['DocumentRefs' => $documentRef]);
139			}
140			}
141

sergeynezbritskiy / nova-poshta-api

Pull Request — master (#13)

InternetDocument::getDocumentPrice() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like