SubmitShippingResponse::saveLabels() - Code Metrics - Inspection of "added get products request and refactored the hand..." - loevgaard/consignor-shipment-server-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 40c607...1c8f88 )

by Joachim

created 2018-02-27 07:24 UTC

SubmitShippingResponse::saveLabels() C

↳ Parent: SubmitShippingResponse

Complexity

Conditions	7
Paths	9

Size

Total Lines	48
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes

Metric	Value
cc	7
eloc	28
nc	9
nop	2
dl	0
loc	48
ccs	0
cts	37
cp	0
crap	56
rs	6.7272
c	0
b	0
f	0

<?php
namespace Loevgaard\Consignor\ShipmentServer\Response;

use Loevgaard\Consignor\ShipmentServer\Exception\InvalidBase64Exception;
use Loevgaard\Consignor\ShipmentServer\Exception\InvalidLabelsOptionException;
use Loevgaard\Consignor\ShipmentServer\Request\SubmitShipmentRequest;

class SubmitShippingResponse extends Response
{
    /**
     * @var SubmitShipmentRequest
     */
    protected $request;

    /**
     * @param string $prefix
     * @param string|null $dir
     * @return array|null
     * @throws InvalidBase64Exception
     * @throws InvalidLabelsOptionException
     */
    public function saveLabels(string $prefix = 'label-', string $dir = null) : ?array
    {
        $labelsOption = $this->request->getOption('Labels');
        if (!$labelsOption) {
            throw new InvalidLabelsOptionException('The labels option is not set. This is unexpected.');
        }

        if ($labelsOption === 'none') {
            return null;
        }

        $extensionMapping = [
            'PNG' => 'png',
            'PDF' => 'pdf',
            'EPL' => 'epl',
            'ZPL' => 'zpl',
            'ZPLGK' => 'zplgk',
            'DATAMAXLP2' => 'datamaxlp2'
        ];

        if (!isset($extensionMapping[$labelsOption])) {
            throw new InvalidLabelsOptionException('The labels option `'.$labelsOption.'` was not found in: '.join(', ', array_keys($extensionMapping)));
        }

        $extension = $extensionMapping[$labelsOption];

        if (!$dir) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $dir = sys_get_temp_dir();
        }
        $dir = rtrim($dir, '/');

        $files = [];

        foreach ($this->data['Labels'] as $label) {
            $decoded = base64_decode($label['Content']);

            if ($decoded === false) {
                throw new InvalidBase64Exception('An error occurred during the base64_decode');
            }

            $file = $this->getFile($extension, $prefix, $dir);
            $file->fwrite($decoded);

            $files[] = $file;
        }

        return $files;
    }

    protected function getFile(string $extension, string $prefix, string $dir) : \SplFileObject
    {
        do {
            $filename = $dir.'/'.uniqid($prefix, true).'.'.$extension;
        } while (file_exists($filename));

        return new \SplFileObject($filename, 'w+');
    }
}


1			<?php
2			namespace Loevgaard\Consignor\ShipmentServer\Response;
3
4			use Loevgaard\Consignor\ShipmentServer\Exception\InvalidBase64Exception;
5			use Loevgaard\Consignor\ShipmentServer\Exception\InvalidLabelsOptionException;
6			use Loevgaard\Consignor\ShipmentServer\Request\SubmitShipmentRequest;
7
8			class SubmitShippingResponse extends Response
9			{
10			/**
11			* @var SubmitShipmentRequest
12			*/
13			protected $request;
14
15			/**
16			* @param string $prefix
17			* @param string\|null $dir
18			* @return array\|null
19			* @throws InvalidBase64Exception
20			* @throws InvalidLabelsOptionException
21			*/
22			public function saveLabels(string $prefix = 'label-', string $dir = null) : ?array
23			{
24			$labelsOption = $this->request->getOption('Labels');
25			if (!$labelsOption) {
26			throw new InvalidLabelsOptionException('The labels option is not set. This is unexpected.');
27			}
28
29			if ($labelsOption === 'none') {
30			return null;
31			}
32
33			$extensionMapping = [
34			'PNG' => 'png',
35			'PDF' => 'pdf',
36			'EPL' => 'epl',
37			'ZPL' => 'zpl',
38			'ZPLGK' => 'zplgk',
39			'DATAMAXLP2' => 'datamaxlp2'
40			];
41
42			if (!isset($extensionMapping[$labelsOption])) {
43			throw new InvalidLabelsOptionException('The labels option `'.$labelsOption.'` was not found in: '.join(', ', array_keys($extensionMapping)));
44			}
45
46			$extension = $extensionMapping[$labelsOption];
47
48			if (!$dir) {
			0 ignored issues – show Bug Best Practice introduced 2018-02-27 07:29 UTC by Report Bug Copy Issue Report The expression `$dir` of type `null\|string` is loosely compared to `false`; this is ambiguous if the string can be empty. 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 `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
49			$dir = sys_get_temp_dir();
50			}
51			$dir = rtrim($dir, '/');
52
53			$files = [];
54
55			foreach ($this->data['Labels'] as $label) {
56			$decoded = base64_decode($label['Content']);
57
58			if ($decoded === false) {
59			throw new InvalidBase64Exception('An error occurred during the base64_decode');
60			}
61
62			$file = $this->getFile($extension, $prefix, $dir);
63			$file->fwrite($decoded);
64
65			$files[] = $file;
66			}
67
68			return $files;
69			}
70
71			protected function getFile(string $extension, string $prefix, string $dir) : \SplFileObject
72			{
73			do {
74			$filename = $dir.'/'.uniqid($prefix, true).'.'.$extension;
75			} while (file_exists($filename));
76
77			return new \SplFileObject($filename, 'w+');
78			}
79			}
80

loevgaard / consignor-shipment-server-php-sdk

Push — master ( 40c607...1c8f88 )

SubmitShippingResponse::saveLabels() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like