Request::prepareContextOptions() - Code Metrics - Inspection of "added use of tests config" - hiqdev/yii2-hiart - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f81184...3aae6e )

by Andrii

created 2017-01-25 17:35 UTC

Request::prepareContextOptions() A

↳ Parent: Request

Complexity

Conditions	2
Paths	2

Size

Total Lines	19
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	2.0185

Importance

Changes

Metric	Value
dl	0
loc	19
ccs	10
cts	12
cp	0.8333
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	11
nc	2
nop	1
crap	2.0185

<?php
/**
 * Tools to use API as ActiveRecord for Yii2
 *
 * @link      https://github.com/hiqdev/yii2-hiart
 * @package   yii2-hiart
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\hiart\stream;

use hiqdev\hiart\AbstractRequest;
use hiqdev\hiart\RequestErrorException;
use yii\helpers\ArrayHelper;
use yii\helpers\Inflector;

/**
 * PHP stream request implementation.
 *
 * @author Andrii Vasyliev <[email protected]>
 */
class Request extends AbstractRequest
{
    protected $responseClass = Response::class;

    public $defaultOptions = [
        'http' => [
            'ignore_errors' => true,
        ],
        'ssl' => [
            'verify_peer' => false,
        ],
    ];

    public function send($options = [])
    {
        try {
            $this->build();
            $context = stream_context_create($this->prepareContextOptions($options));
            $stream = fopen($this->getFullUri(), 'rb', false, $context);
            $responseContent = stream_get_contents($stream);
            // see http://php.net/manual/en/reserved.variables.httpresponseheader.php
            $responseHeaders = $http_response_header;
            fclose($stream);
        } catch (\Exception $e) {
            $errorInfo = ['request' => $this];
            throw new RequestErrorException($e->getMessage(), $errorInfo, $e->getCode(), $e);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        return new $this->responseClass($this, $responseContent, $responseHeaders);
    }

    protected function prepareContextOptions($options)
    {
        $requestOptions = [
            'http' => [
                'protocol_version' => $this->version,
                'method' => $this->method,
                'header' => static::composeHeaderLines($this->headers),
            ],
        ];

        if (isset($this->body)) {
            $requestOptions['http']['content'] = $this->body;
        }

        $dbOptions = $this->convertContextOptions($this->getDb()->config);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $sendOptions = $this->convertContextOptions($options);

        return ArrayHelper::merge($this->defaultOptions, $dbOptions, $requestOptions, $sendOptions);
    }

    /**
     * Composes stream context options from raw options.
     * @param array $options raw options
     * @return array stream context options
     */
    protected function convertContextOptions(array $options)
    {
        $contextOptions = [];
        foreach ($options as $key => $value) {
            $section = 'http';
            if (strpos($key, 'ssl') === 0) {
                $section = 'ssl';
                $key = substr($key, 3);
            }
            $key = Inflector::underscore($key);
            $contextOptions[$section][$key] = $value;
        }

        return $contextOptions;
    }

    public static function composeHeaderLines($headers)
    {
        $result = [];
        foreach ($headers as $name => $values) {
            $name = str_replace(' ', '-', ucwords(str_replace('-', ' ', $name)));
            if (is_string($values)) {
                $values = [$values];
            }
            foreach ($values as $value) {
                $result[] = "$name: $value";
            }
        }

        return $result;
    }
}


1		<?php
2		/**
3		* Tools to use API as ActiveRecord for Yii2
4		*
5		* @link https://github.com/hiqdev/yii2-hiart
6		* @package yii2-hiart
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hiqdev\hiart\stream;
12
13		use hiqdev\hiart\AbstractRequest;
14		use hiqdev\hiart\RequestErrorException;
15		use yii\helpers\ArrayHelper;
16		use yii\helpers\Inflector;
17
18		/**
19		* PHP stream request implementation.
20		*
21		* @author Andrii Vasyliev <[email protected]>
22		*/
23		class Request extends AbstractRequest
24		{
25		protected $responseClass = Response::class;
26
27		public $defaultOptions = [
28		'http' => [
29		'ignore_errors' => true,
30		],
31		'ssl' => [
32		'verify_peer' => false,
33		],
34		];
35
36	2	public function send($options = [])
37		{
38		try {
39	2	$this->build();
40	2	$context = stream_context_create($this->prepareContextOptions($options));
41	2	$stream = fopen($this->getFullUri(), 'rb', false, $context);
42	2	$responseContent = stream_get_contents($stream);
43		// see http://php.net/manual/en/reserved.variables.httpresponseheader.php
44	2	$responseHeaders = $http_response_header;
45	2	fclose($stream);
46	2	} catch (\Exception $e) {
47		$errorInfo = ['request' => $this];
48		throw new RequestErrorException($e->getMessage(), $errorInfo, $e->getCode(), $e);
		0 ignored issues – show Documentation introduced 2017-01-25 17:14 UTC by Report Bug Copy Issue Report `$errorInfo` is of type `array<string,this<hiqdev...rt\\stream\\Request>"}>`, but the function expects a `object<hiqdev\hiart\RequestInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2017-01-25 17:14 UTC by Report Bug Copy Issue Report `$e` is of type `object<Exception>`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
49		}
50
51	2	return new $this->responseClass($this, $responseContent, $responseHeaders);
52		}
53
54	2	protected function prepareContextOptions($options)
55		{
56		$requestOptions = [
57		'http' => [
58	2	'protocol_version' => $this->version,
59	2	'method' => $this->method,
60	2	'header' => static::composeHeaderLines($this->headers),
61	2	],
62	2	];
63
64	2	if (isset($this->body)) {
65		$requestOptions['http']['content'] = $this->body;
66		}
67
68	2	$dbOptions = $this->convertContextOptions($this->getDb()->config);
		0 ignored issues – show Bug introduced 2017-01-25 17:14 UTC by Report Bug Copy Issue Report Accessing `config` on the interface `hiqdev\hiart\ConnectionInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
69	2	$sendOptions = $this->convertContextOptions($options);
70
71	2	return ArrayHelper::merge($this->defaultOptions, $dbOptions, $requestOptions, $sendOptions);
72		}
73
74		/**
75		* Composes stream context options from raw options.
76		* @param array $options raw options
77		* @return array stream context options
78		*/
79	2	protected function convertContextOptions(array $options)
80		{
81	2	$contextOptions = [];
82	2	foreach ($options as $key => $value) {
83		$section = 'http';
84		if (strpos($key, 'ssl') === 0) {
85		$section = 'ssl';
86		$key = substr($key, 3);
87		}
88		$key = Inflector::underscore($key);
89		$contextOptions[$section][$key] = $value;
90	2	}
91
92	2	return $contextOptions;
93		}
94
95	2	public static function composeHeaderLines($headers)
96		{
97	2	$result = [];
98	2	foreach ($headers as $name => $values) {
99	2	$name = str_replace(' ', '-', ucwords(str_replace('-', ' ', $name)));
100	2	if (is_string($values)) {
101	2	$values = [$values];
102	2	}
103	2	foreach ($values as $value) {
104	2	$result[] = "$name: $value";
105	2	}
106	2	}
107
108	2	return $result;
109		}
110		}
111

hiqdev / yii2-hiart

Push — master ( f81184...3aae6e )

Request::prepareContextOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like