Message::normalizeHeaders() - Code Metrics - Inspection of "Allow instancing of Headers object in Message from..." - kambo-1st/HttpMessage - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9b1f8e...6c1b14 )

by Bohuslav

created 2016-08-09 15:40 UTC

Message::normalizeHeaders() A

↳ Parent: Message

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	12
ccs	7
cts	7
cp	1
rs	9.4285
cc	3
eloc	7
nc	3
nop	1
crap	3

<?php
namespace Kambo\Http\Message;

// \Spl
use InvalidArgumentException;

// \Http\Message
use Kambo\Http\Message\Stream;
use Kambo\Http\Message\Headers;

// \Psr
use Psr\Http\Message\MessageInterface;
use Psr\Http\Message\StreamInterface;

/**
 * HTTP messages consist of requests from a client to a server and responses
 * from a server to a client. This interface defines the methods common to
 * each.
 *
 * Messages are considered immutable; all methods that change state retain the 
 * internal state of the current message and return an instance that contains 
 * the changed state.
 *
 * @link http://www.ietf.org/rfc/rfc7230.txt
 * @link http://www.ietf.org/rfc/rfc7231.txt
 *
 * @package Kambo\Http\Message
 * @author  Bohuslav Simek <[email protected]>
 * @license MIT
 */
class Message implements MessageInterface
{
    /**
     * Protocol version
     *
     * @var string
     */
    protected $protocolVersion = '1.1';

    /**
     * Headers
     *
     * @var Headers
     */
    protected $headers;

    /**
     * Body data
     *
     * @var StreamInterface
     */
    protected $body;

    /**
     * Create a new message
     *
     * @param Headers|array               $headers  The request headers collection
     * @param StreamInterface|string|null $body     The request body object
     * @param string                      $protocol The request version of the protocol
     *
     * @throws \InvalidArgumentException If an unsupported argument type is provided for the body.
     */
    public function __construct(
        $headers = [],
        $body = null,
        $protocol = '1.1'
    ) {
        $this->headers         = $this->normalizeHeaders($headers);

        $this->body            = $this->normalizeBody($body);
        $this->protocolVersion = $protocol;
    }

    /**
     * Retrieves the HTTP protocol version as a string.
     *
     * The string contain only the HTTP version number (e.g., "1.1", "1.0").
     *
     * @return string HTTP protocol version.
     */
    public function getProtocolVersion()
    {
        return $this->protocolVersion;
    }

    /**
     * Return an instance with the specified HTTP protocol version.
     *
     * The version string MUST contain only the HTTP version number (e.g.,
     * "1.1", "1.0").
     *
     * This method retains the state of the current instance, and return
     * an instance that contains the new protocol version.
     *
     * @param string $version HTTP protocol version
     *
     * @return self
     */
    public function withProtocolVersion($version)
    {
        $this->validateProtocol($version);

        $clone                  = clone $this;
        $clone->protocolVersion = $version;

        return $clone;
    }

    /**
     * Retrieves all message header values.
     *
     * The keys represent the header name as it will be sent over the wire, and
     * each value is an array of strings associated with the header.
     *
     *     // Represent the headers as a string
     *     foreach ($message->getHeaders() as $name => $values) {
     *         echo $name . ": " . implode(", ", $values);
     *     }
     *
     *     // Emit headers iteratively:
     *     foreach ($message->getHeaders() as $name => $values) {
     *         foreach ($values as $value) {
     *             header(sprintf('%s: %s', $name, $value), false);
     *         }
     *     }
     *
     * While header names are not case-sensitive, getHeaders() will preserve the
     * exact case in which headers were originally specified.
     *
     * @return array Returns an associative array of the message's headers. Each
     *               key is a header name, and each value is an array of strings
     *               for that header.
     */
    public function getHeaders()
    {
        return $this->headers->all();
    }

    /**
     * Checks if a header exists by the given case-insensitive name.
     *
     * @param string $name Case-insensitive header field name.
     *
     * @return bool Returns true if any header names match the given header name using
     *              a case-insensitive string comparison. Returns false if no matching
     *              header name is found in the message.
     */
    public function hasHeader($name)
    {
        return $this->headers->exists($name);
    }

    /**
     * Retrieves a message header value by the given case-insensitive name.
     *
     * This method returns an array of all the header values of the given
     * case-insensitive header name.
     *
     * If the header does not appear in the message, this method return an
     * empty array.
     *
     * @param string $name Case-insensitive header field name.
     *
     * @return string[] An array of string values as provided for the given header.
     *                  If the header does not appear in the message, an empty
     *                  array is returned.
     */
    public function getHeader($name)
    {
        return $this->headers->get($name);
    }

    /**
     * Retrieves a comma-separated string of the values for a single header.
     *
     * This method returns all of the header values of the given
     * case-insensitive header name as a string concatenated together using
     * a comma.
     *
     * NOTE: Not all header values are appropriately represented using comma concatenation.
     *       If you want values without concatenation, use getHeader() instead and supply
     *       your own delimiter when concatenating.
     *
     * If the header does not appear in the message, an empty string is returned.
     *
     * @param string $name Case-insensitive header field name.
     *
     * @return string A string of values as provided for the given header concatenated
     *                together using a comma. If the header does not appear in the message,
     *                this method return an empty string.
     */
    public function getHeaderLine($name)
    {
        return $this->headers->getLine($name);
    }

    /**
     * Return an instance with the provided value replacing the specified header.
     *
     * While header names are case-insensitive, the casing of the header will
     * be preserved by this function, and returned from getHeaders().
     *
     * This method retains the state of the current instance, and return
     * an instance with new and/or updated header and value.
     *     
     * @param string          $name  Case-insensitive header field name.
     * @param string|string[] $value Header value(s).
     *
     * @return self
     *
     * @throws \InvalidArgumentException for invalid header names or values.
     */
    public function withHeader($name, $value)
    {
        $this->validateHeaderName($name);

        $clone          = clone $this;
        $clone->headers = clone $this->headers;
        $clone->headers->set($name, $value);

        return $clone;
    }

    /**
     * Return an instance with the specified header appended with the given value.
     *
     * Existing values for the specified header will be maintained. The new
     * value(s) will be appended to the existing list. If the header did not
     * exist previously, it will be added.
     *
     * This method retains the state of the current instance, and return
     * an instance with new and/or updated header and value.
     *
     * @param string          $name  Case-insensitive header field name to add.
     * @param string|string[] $value Header value(s).
     *
     * @return self
     *
     * @throws \InvalidArgumentException for invalid header names or values.
     */
    public function withAddedHeader($name, $value)
    {
        $this->validateHeaderName($name);

        $clone          = clone $this;
        $clone->headers = clone $this->headers;
        $clone->headers->add($name, $value);

        return $clone;
    }

    /**
     * Return an instance without the specified header.
     *
     * Header resolution is done without case-sensitivity.
     *
     * This method retains the state of the current instance, and return
     * an instance that removes the named header.
     *
     * @param string $name Case-insensitive header field name to remove.
     *
     * @return self
     */
    public function withoutHeader($name)
    {
        $clone          = clone $this;
        $clone->headers = clone $this->headers;
        $clone->headers->remove($name);

        return $clone;
    }

    /**
     * Gets the body of the message.
     *
     * @return StreamInterface Returns the body as a stream.
     */
    public function getBody()
    {
        return $this->body;
    }

    /**
     * Return an instance with the specified message body.
     *
     * This method retains the state of the current instance, and return
     * an instance that has the new body stream.
     *     
     * @param StreamInterface $body Body.
     *
     * @return self
     *
     * @throws \InvalidArgumentException When the body is not valid.
     */
    public function withBody(StreamInterface $body)
    {
        $clone       = clone $this;
        $clone->body = $body;

        return $clone;
    }

    // ------------ PROTECTED METHODS

    /**
     * Provide message headers
     *
     * @return Headers Message headers
     */
    protected function provideHeaders()
    {
        return $this->headers;
    }

    // ------------ PRIVATE METHODS

    /**
     * Normalize provided body and ensure that the result object is Stream.
     *
     * @param StreamInterface|string|null $body The request body object
     *
     * @return Stream Normalized body
     *
     * @throws \InvalidArgumentException If an unsupported argument type is provided.
     */
    private function normalizeBody($body = null)
    {
        $body = $body ? $body : new Stream(fopen('php://temp', 'r+'));
        if (is_string($body)) {
            $memoryStream = fopen('php://temp', 'r+');
            fwrite($memoryStream, $body);
            rewind($memoryStream);
            $body = new Stream($memoryStream);
        } elseif (!($body instanceof StreamInterface)) {
            throw new InvalidArgumentException(
                'Body must be a string, null or implement Psr\Http\Message\StreamInterface'
            );
        }

        return $body;
    }

    /**
     * Normalize provided headers and ensure that the result object is Headers.
     *
     * @param StreamInterface|string|null $body The request body object
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return Headers Normalized headers
     *
     * @throws \InvalidArgumentException If an unsupported argument type is provided.
     */
    private function normalizeHeaders($headers = [])
    {
        if (is_array($headers)) {
            $headers = new Headers($headers);
        } elseif (!($headers instanceof Headers)) {
            throw new InvalidArgumentException(
                'Headers must be an array or instance of Headers'
            );
        }

        return $headers;
    }

    /**
     * Validate name of the header - it must not be array.
     *
     * @param string $headerName Name of the header.
     *
     * @throws \InvalidArgumentException When the header name is not valid.
     */
    private function validateHeaderName($headerName)
    {
        if (is_array($headerName)) {
            throw new InvalidArgumentException('Invalid HTTP header name');
        }
    }

    /**
     * Validate version of the HTTP protocol.
     *
     * @param string $version Version of the HTTP protocol.
     *
     * @throws \InvalidArgumentException When the protocol version is not valid.
     */
    private function validateProtocol($version)
    {
        $valid = [
            '1.0' => true,
            '1.1' => true,
            '2.0' => true,
        ];

        if (!isset($valid[$version])) {
            throw new InvalidArgumentException('Invalid HTTP version. Must be one of: 1.0, 1.1, 2.0');
        }
    }
}


1			<?php
2			namespace Kambo\Http\Message;
3
4			// \Spl
5			use InvalidArgumentException;
6
7			// \Http\Message
8			use Kambo\Http\Message\Stream;
9			use Kambo\Http\Message\Headers;
10
11			// \Psr
12			use Psr\Http\Message\MessageInterface;
13			use Psr\Http\Message\StreamInterface;
14
15			/**
16			* HTTP messages consist of requests from a client to a server and responses
17			* from a server to a client. This interface defines the methods common to
18			* each.
19			*
20			* Messages are considered immutable; all methods that change state retain the
21			* internal state of the current message and return an instance that contains
22			* the changed state.
23			*
24			* @link http://www.ietf.org/rfc/rfc7230.txt
25			* @link http://www.ietf.org/rfc/rfc7231.txt
26			*
27			* @package Kambo\Http\Message
28			* @author Bohuslav Simek <[email protected]>
29			* @license MIT
30			*/
31			class Message implements MessageInterface
32			{
33			/**
34			* Protocol version
35			*
36			* @var string
37			*/
38			protected $protocolVersion = '1.1';
39
40			/**
41			* Headers
42			*
43			* @var Headers
44			*/
45			protected $headers;
46
47			/**
48			* Body data
49			*
50			* @var StreamInterface
51			*/
52			protected $body;
53
54			/**
55			* Create a new message
56			*
57			* @param Headers\|array $headers The request headers collection
58			* @param StreamInterface\|string\|null $body The request body object
59			* @param string $protocol The request version of the protocol
60			*
61			* @throws \InvalidArgumentException If an unsupported argument type is provided for the body.
62			*/
63	62		public function __construct(
64			$headers = [],
65			$body = null,
66			$protocol = '1.1'
67			) {
68	62		$this->headers = $this->normalizeHeaders($headers);
			0 ignored issues – show Bug introduced 2016-08-09 15:44 UTC by Report Bug Copy Issue Report It seems like `$headers` defined by parameter `$headers` on line 64 can also be of type `object<Kambo\Http\Message\Headers>`; however, `Kambo\Http\Message\Message::normalizeHeaders()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
69	61		$this->body = $this->normalizeBody($body);
70	60		$this->protocolVersion = $protocol;
71	60		}
72
73			/**
74			* Retrieves the HTTP protocol version as a string.
75			*
76			* The string contain only the HTTP version number (e.g., "1.1", "1.0").
77			*
78			* @return string HTTP protocol version.
79			*/
80	3		public function getProtocolVersion()
81			{
82	3		return $this->protocolVersion;
83			}
84
85			/**
86			* Return an instance with the specified HTTP protocol version.
87			*
88			* The version string MUST contain only the HTTP version number (e.g.,
89			* "1.1", "1.0").
90			*
91			* This method retains the state of the current instance, and return
92			* an instance that contains the new protocol version.
93			*
94			* @param string $version HTTP protocol version
95			*
96			* @return self
97			*/
98	2		public function withProtocolVersion($version)
99			{
100	2		$this->validateProtocol($version);
101
102	1		$clone = clone $this;
103	1		$clone->protocolVersion = $version;
104
105	1		return $clone;
106			}
107
108			/**
109			* Retrieves all message header values.
110			*
111			* The keys represent the header name as it will be sent over the wire, and
112			* each value is an array of strings associated with the header.
113			*
114			* // Represent the headers as a string
115			* foreach ($message->getHeaders() as $name => $values) {
116			* echo $name . ": " . implode(", ", $values);
117			* }
118			*
119			* // Emit headers iteratively:
120			* foreach ($message->getHeaders() as $name => $values) {
121			* foreach ($values as $value) {
122			* header(sprintf('%s: %s', $name, $value), false);
123			* }
124			* }
125			*
126			* While header names are not case-sensitive, getHeaders() will preserve the
127			* exact case in which headers were originally specified.
128			*
129			* @return array Returns an associative array of the message's headers. Each
130			* key is a header name, and each value is an array of strings
131			* for that header.
132			*/
133	4		public function getHeaders()
134			{
135	4		return $this->headers->all();
136			}
137
138			/**
139			* Checks if a header exists by the given case-insensitive name.
140			*
141			* @param string $name Case-insensitive header field name.
142			*
143			* @return bool Returns true if any header names match the given header name using
144			* a case-insensitive string comparison. Returns false if no matching
145			* header name is found in the message.
146			*/
147	16		public function hasHeader($name)
148			{
149	16		return $this->headers->exists($name);
150			}
151
152			/**
153			* Retrieves a message header value by the given case-insensitive name.
154			*
155			* This method returns an array of all the header values of the given
156			* case-insensitive header name.
157			*
158			* If the header does not appear in the message, this method return an
159			* empty array.
160			*
161			* @param string $name Case-insensitive header field name.
162			*
163			* @return string[] An array of string values as provided for the given header.
164			* If the header does not appear in the message, an empty
165			* array is returned.
166			*/
167	6		public function getHeader($name)
168			{
169	6		return $this->headers->get($name);
170			}
171
172			/**
173			* Retrieves a comma-separated string of the values for a single header.
174			*
175			* This method returns all of the header values of the given
176			* case-insensitive header name as a string concatenated together using
177			* a comma.
178			*
179			* NOTE: Not all header values are appropriately represented using comma concatenation.
180			* If you want values without concatenation, use getHeader() instead and supply
181			* your own delimiter when concatenating.
182			*
183			* If the header does not appear in the message, an empty string is returned.
184			*
185			* @param string $name Case-insensitive header field name.
186			*
187			* @return string A string of values as provided for the given header concatenated
188			* together using a comma. If the header does not appear in the message,
189			* this method return an empty string.
190			*/
191	1		public function getHeaderLine($name)
192			{
193	1		return $this->headers->getLine($name);
194			}
195
196			/**
197			* Return an instance with the provided value replacing the specified header.
198			*
199			* While header names are case-insensitive, the casing of the header will
200			* be preserved by this function, and returned from getHeaders().
201			*
202			* This method retains the state of the current instance, and return
203			* an instance with new and/or updated header and value.
204			*
205			* @param string $name Case-insensitive header field name.
206			* @param string\|string[] $value Header value(s).
207			*
208			* @return self
209			*
210			* @throws \InvalidArgumentException for invalid header names or values.
211			*/
212	2	View Code Duplication	public function withHeader($name, $value)
213			{
214	2		$this->validateHeaderName($name);
215
216	1		$clone = clone $this;
217	1		$clone->headers = clone $this->headers;
218	1		$clone->headers->set($name, $value);
219
220	1		return $clone;
221			}
222
223			/**
224			* Return an instance with the specified header appended with the given value.
225			*
226			* Existing values for the specified header will be maintained. The new
227			* value(s) will be appended to the existing list. If the header did not
228			* exist previously, it will be added.
229			*
230			* This method retains the state of the current instance, and return
231			* an instance with new and/or updated header and value.
232			*
233			* @param string $name Case-insensitive header field name to add.
234			* @param string\|string[] $value Header value(s).
235			*
236			* @return self
237			*
238			* @throws \InvalidArgumentException for invalid header names or values.
239			*/
240	2	View Code Duplication	public function withAddedHeader($name, $value)
241			{
242	2		$this->validateHeaderName($name);
243
244	1		$clone = clone $this;
245	1		$clone->headers = clone $this->headers;
246	1		$clone->headers->add($name, $value);
247
248	1		return $clone;
249			}
250
251			/**
252			* Return an instance without the specified header.
253			*
254			* Header resolution is done without case-sensitivity.
255			*
256			* This method retains the state of the current instance, and return
257			* an instance that removes the named header.
258			*
259			* @param string $name Case-insensitive header field name to remove.
260			*
261			* @return self
262			*/
263	2		public function withoutHeader($name)
264			{
265	2		$clone = clone $this;
266	2		$clone->headers = clone $this->headers;
267	2		$clone->headers->remove($name);
268
269	2		return $clone;
270			}
271
272			/**
273			* Gets the body of the message.
274			*
275			* @return StreamInterface Returns the body as a stream.
276			*/
277	3		public function getBody()
278			{
279	3		return $this->body;
280			}
281
282			/**
283			* Return an instance with the specified message body.
284			*
285			* This method retains the state of the current instance, and return
286			* an instance that has the new body stream.
287			*
288			* @param StreamInterface $body Body.
289			*
290			* @return self
291			*
292			* @throws \InvalidArgumentException When the body is not valid.
293			*/
294	1		public function withBody(StreamInterface $body)
295			{
296	1		$clone = clone $this;
297	1		$clone->body = $body;
298
299	1		return $clone;
300			}
301
302			// ------------ PROTECTED METHODS
303
304			/**
305			* Provide message headers
306			*
307			* @return Headers Message headers
308			*/
309	3		protected function provideHeaders()
310			{
311	3		return $this->headers;
312			}
313
314			// ------------ PRIVATE METHODS
315
316			/**
317			* Normalize provided body and ensure that the result object is Stream.
318			*
319			* @param StreamInterface\|string\|null $body The request body object
320			*
321			* @return Stream Normalized body
322			*
323			* @throws \InvalidArgumentException If an unsupported argument type is provided.
324			*/
325	61		private function normalizeBody($body = null)
326			{
327	61		$body = $body ? $body : new Stream(fopen('php://temp', 'r+'));
328	61		if (is_string($body)) {
329	1		$memoryStream = fopen('php://temp', 'r+');
330	1		fwrite($memoryStream, $body);
331	1		rewind($memoryStream);
332	1		$body = new Stream($memoryStream);
333	61		} elseif (!($body instanceof StreamInterface)) {
334	1		throw new InvalidArgumentException(
335			'Body must be a string, null or implement Psr\Http\Message\StreamInterface'
336	1		);
337			}
338
339	60		return $body;
340			}
341
342			/**
343			* Normalize provided headers and ensure that the result object is Headers.
344			*
345			* @param StreamInterface\|string\|null $body The request body object
			0 ignored issues – show Bug introduced 2016-08-09 15:44 UTC by Report Bug Copy Issue Report There is no parameter named `$body`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
346			*
347			* @return Headers Normalized headers
348			*
349			* @throws \InvalidArgumentException If an unsupported argument type is provided.
350			*/
351	62		private function normalizeHeaders($headers = [])
352			{
353	62		if (is_array($headers)) {
354	56		$headers = new Headers($headers);
355	62		} elseif (!($headers instanceof Headers)) {
356	1		throw new InvalidArgumentException(
357			'Headers must be an array or instance of Headers'
358	1		);
359			}
360
361	61		return $headers;
362			}
363
364			/**
365			* Validate name of the header - it must not be array.
366			*
367			* @param string $headerName Name of the header.
368			*
369			* @throws \InvalidArgumentException When the header name is not valid.
370			*/
371	4		private function validateHeaderName($headerName)
372			{
373	4		if (is_array($headerName)) {
374	2		throw new InvalidArgumentException('Invalid HTTP header name');
375			}
376	2		}
377
378			/**
379			* Validate version of the HTTP protocol.
380			*
381			* @param string $version Version of the HTTP protocol.
382			*
383			* @throws \InvalidArgumentException When the protocol version is not valid.
384			*/
385	2		private function validateProtocol($version)
386			{
387			$valid = [
388	2		'1.0' => true,
389	2		'1.1' => true,
390	2		'2.0' => true,
391	2		];
392
393	2		if (!isset($valid[$version])) {
394	1		throw new InvalidArgumentException('Invalid HTTP version. Must be one of: 1.0, 1.1, 2.0');
395			}
396	1		}
397			}
398

kambo-1st / HttpMessage

Push — master ( 9b1f8e...6c1b14 )

Message::normalizeHeaders() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like