AbstractRequest::getHeaders() - Code Metrics - Inspection of "Margin for PDF output can now be defined as an obj..." - jonnnnyw/php-phantomjs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c11e1b...0baec8 )

by Jonny

created 2016-11-15 15:13 UTC

AbstractRequest::getHeaders() A

↳ Parent: AbstractRequest

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	0
cts	4
cp	0
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	1
crap	6

<?php

/*
 * This file is part of the php-phantomjs.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace JonnyW\PhantomJs\Http;

use JonnyW\PhantomJs\Exception\InvalidMethodException;
use JonnyW\PhantomJs\Procedure\InputInterface;

/**
 * PHP PhantomJs
 *
 * @author Jon Wenmoth <[email protected]>
 */
abstract class AbstractRequest
    implements RequestInterface, InputInterface
{
    /**
     * Headers
     *
     * @var array
     * @access protected
     */
    protected $headers;

    /**
     * Request data
     *
     * @var array
     * @access protected
     */
    protected $data;

    /**
     * Request URL
     *
     * @var string
     * @access protected
     */
    protected $url;

    /**
     * Request method
     *
     * @var string
     * @access protected
     */
    protected $method;

    /**
     * Timeout period
     *
     * @var int
     * @access protected
     */
    protected $timeout;

    /**
     * Page load delay time.
     *
     * @var int
     * @access protected
     */
    protected $delay;

    /**
     * Viewport width.
     *
     * @var int
     * @access protected
     */
    protected $viewportWidth;

    /**
     * Viewport height.
     *
     * @var int
     * @access protected
     */
    protected $viewportHeight;

    /**
     * Body styles.
     *
     * @var array
     * @access protected
     */
    protected $bodyStyles;

    /**
     * Internal constructor
     *
     * @access public
     * @param string $url     (default: null)
     * @param string $method  (default: RequestInterface::METHOD_GET)
     * @param int    $timeout (default: 5000)
     */
    public function __construct($url = null, $method = RequestInterface::METHOD_GET, $timeout = 5000)
    {
        $this->headers         = array();
        $this->data            = array();
        $this->bodyStyles      = array();
        $this->delay           = 0;
        $this->viewportWidth   = 0;
        $this->viewportHeight  = 0;

        $this->setMethod($method);
        $this->setTimeout($timeout);

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

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->setUrl($url);
        }
    }

    /**
     * Set request method
     *
     * @access public
     * @param  string                                             $method
     * @return \JonnyW\PhantomJs\Http\AbstractRequest
     * @throws \JonnyW\PhantomJs\Exception\InvalidMethodException
     */
    public function setMethod($method)
    {
        $method     = strtoupper($method);
        $reflection = new \ReflectionClass('\JonnyW\PhantomJs\Http\RequestInterface');

        if (!$reflection->hasConstant('METHOD_' . $method)) {
            throw new InvalidMethodException(sprintf('Invalid method provided: %s', $method));
        }

        $this->method = $method;

        return $this;
    }

    /**
     * Get request method
     *
     * @access public
     * @return string
     */
    public function getMethod()
    {
        return $this->method;
    }

    /**
     * Set timeout period
     *
     * @access public
     * @param  int                                    $timeout
     * @return \JonnyW\PhantomJs\Http\AbstractRequest
     */
    public function setTimeout($timeout)
    {
        $this->timeout = $timeout;

        return $this;
    }

    /**
     * Get timeout period
     *
     * @access public
     * @return int
     */
    public function getTimeout()
    {
        return $this->timeout;
    }

    /**
     * Set page load delay time (seconds).
     *
     * @access public
     * @param  int                                    $delay
     * @return \JonnyW\PhantomJs\Http\AbstractRequest
     */
    public function setDelay($delay)
    {
        $this->delay = (int) $delay;

        return $this;
    }

    /**
     * Get page load delay time (seconds).
     *
     * @access public
     * @return int
     */
    public function getDelay()
    {
        return (int) $this->delay;
    }

    /**
     * Set viewport size.
     *
     * @access public
     * @param  int  $width
     * @param  int  $height
     * @return void
     */
    public function setViewportSize($width, $height)
    {
        $this->viewportWidth  = (int) $width;
        $this->viewportHeight = (int) $height;

        return $this;
    }

    /**
     * Get viewport width.
     *
     * @access public
     * @return int
     */
    public function getViewportWidth()
    {
        return (int) $this->viewportWidth;
    }

    /**
     * Get viewport height.
     *
     * @access public
     * @return int
     */
    public function getViewportHeight()
    {
        return (int) $this->viewportHeight;
    }

    /**
     * Set request URL
     *
     * @access public
     * @param  string                                 $url
     * @return \JonnyW\PhantomJs\Http\AbstractRequest
     */
    public function setUrl($url)
    {
        $this->url = $url;

        return $this;
    }

    /**
     * Get request URL
     *  - Assembles query string for GET
     *  and HEAD requests
     *
     * @access public
     * @return string
     */
    public function getUrl()
    {
        if (!in_array($this->getMethod(), array(RequestInterface::METHOD_GET, RequestInterface::METHOD_HEAD))) {
            return $this->url;
        }

        $url = $this->url;

        if (count($this->data)) {

            $url .= false === strpos($url, '?') ? '?' : '&';
            $url .= http_build_query($this->data);
        }

        return $url;
    }

    /**
     * Get content body
     *  - Returns query string if not GET or HEAD
     *
     * @access public
     * @return string
     */
    public function getBody()
    {
        if (in_array($this->getMethod(), array(RequestInterface::METHOD_GET, RequestInterface::METHOD_HEAD))) {
            return '';
        }

        return http_build_query($this->getRequestData());
    }

    /**
     * Set request data
     *
     * @access public
     * @param  array                                  $data
     * @return \JonnyW\PhantomJs\Http\AbstractRequest
     */
    public function setRequestData(array $data)
    {
        $this->data = $data;

        return $this;
    }

    /**
     * Get request data
     *
     * @access public
     * @param  boolean $flat
     * @return array
     */
    public function getRequestData($flat = true)
    {
        if ($flat) {
            return $this->flattenData($this->data);
        }

        return $this->data;
    }

    /**
     * Set headers
     *
     * @access public
     * @param  array                                  $headers
     * @return \JonnyW\PhantomJs\Http\AbstractRequest
     */
    public function setHeaders(array $headers)
    {
        $this->headers = $headers;
    }

    /**
     * Add single header
     *
     * @access public
     * @param  string                                 $header
     * @param  string                                 $value
     * @return \JonnyW\PhantomJs\Http\AbstractRequest
     */
    public function addHeader($header, $value)
    {
        $this->headers[$header] = $value;

        return $this;
    }

    /**
     * Merge headers with existing
     *
     * @access public
     * @param  array                                  $headers
     * @return \JonnyW\PhantomJs\Http\AbstractRequest
     */
    public function addHeaders(array $headers)
    {
        $this->headers = array_merge($this->headers, $headers);

        return $this;
    }

    /**
     * Get request headers
     *
     * @access public
     * @param  string       $format
     * @return array|string
     */
    public function getHeaders($format = 'default')
    {
        if ($format === 'json') {
            return json_encode($this->headers);
        }

        return $this->headers;
    }

    /**
     * Set body styles
     *
     * @access public
     * @param  array                                  $styles
     * @return \JonnyW\PhantomJs\Http\AbstractRequest
     */
    public function setBodyStyles(array $styles)
    {
        $this->bodyStyles = $styles;

        return $this;
    }

    /**
     * Get body styles
     *
     * @access public
     * @param  string       $format (default: 'default')
     * @return array|string
     */
    public function getBodyStyles($format = 'default')
    {
        if ($format === 'json') {
            return json_encode($this->bodyStyles);
        }

        return $this->bodyStyles;
    }

    /**
     * Flatten data into single
     * dimensional array
     *
     * @access protected
     * @param  array  $data
     * @param  string $prefix
     * @param  string $format
     * @return array
     */
    protected function flattenData(array $data, $prefix = '', $format = '%s')
    {
        $flat = array();

        foreach ($data as $name => $value) {

            $ref = $prefix . sprintf($format, $name);

            if (is_array($value)) {

                $flat += $this->flattenData($value, $ref, '[%s]');
                continue;
            }

            $flat[$ref] = $value;
        }

        return $flat;
    }
}


1		<?php
2
3		/*
4		* This file is part of the php-phantomjs.
5		*
6		* For the full copyright and license information, please view the LICENSE
7		* file that was distributed with this source code.
8		*/
9
10		namespace JonnyW\PhantomJs\Http;
11
12		use JonnyW\PhantomJs\Exception\InvalidMethodException;
13		use JonnyW\PhantomJs\Procedure\InputInterface;
14
15		/**
16		* PHP PhantomJs
17		*
18		* @author Jon Wenmoth <[email protected]>
19		*/
20		abstract class AbstractRequest
21		implements RequestInterface, InputInterface
22		{
23		/**
24		* Headers
25		*
26		* @var array
27		* @access protected
28		*/
29		protected $headers;
30
31		/**
32		* Request data
33		*
34		* @var array
35		* @access protected
36		*/
37		protected $data;
38
39		/**
40		* Request URL
41		*
42		* @var string
43		* @access protected
44		*/
45		protected $url;
46
47		/**
48		* Request method
49		*
50		* @var string
51		* @access protected
52		*/
53		protected $method;
54
55		/**
56		* Timeout period
57		*
58		* @var int
59		* @access protected
60		*/
61		protected $timeout;
62
63		/**
64		* Page load delay time.
65		*
66		* @var int
67		* @access protected
68		*/
69		protected $delay;
70
71		/**
72		* Viewport width.
73		*
74		* @var int
75		* @access protected
76		*/
77		protected $viewportWidth;
78
79		/**
80		* Viewport height.
81		*
82		* @var int
83		* @access protected
84		*/
85		protected $viewportHeight;
86
87		/**
88		* Body styles.
89		*
90		* @var array
91		* @access protected
92		*/
93		protected $bodyStyles;
94
95		/**
96		* Internal constructor
97		*
98		* @access public
99		* @param string $url (default: null)
100		* @param string $method (default: RequestInterface::METHOD_GET)
101		* @param int $timeout (default: 5000)
102		*/
103	1	public function __construct($url = null, $method = RequestInterface::METHOD_GET, $timeout = 5000)
104		{
105	1	$this->headers = array();
106	1	$this->data = array();
107	1	$this->bodyStyles = array();
108	1	$this->delay = 0;
109	1	$this->viewportWidth = 0;
110	1	$this->viewportHeight = 0;
111
112	1	$this->setMethod($method);
113	1	$this->setTimeout($timeout);
114
115	1	if ($url) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-17 10:52 UTC by Report Bug Copy Issue Report The expression `$url` of type `string\|null` is loosely compared to `true`; 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...
116		$this->setUrl($url);
117		}
118	1	}
119
120		/**
121		* Set request method
122		*
123		* @access public
124		* @param string $method
125		* @return \JonnyW\PhantomJs\Http\AbstractRequest
126		* @throws \JonnyW\PhantomJs\Exception\InvalidMethodException
127		*/
128	1	public function setMethod($method)
129		{
130	1	$method = strtoupper($method);
131	1	$reflection = new \ReflectionClass('\JonnyW\PhantomJs\Http\RequestInterface');
132
133	1	if (!$reflection->hasConstant('METHOD_' . $method)) {
134		throw new InvalidMethodException(sprintf('Invalid method provided: %s', $method));
135		}
136
137	1	$this->method = $method;
138
139	1	return $this;
140		}
141
142		/**
143		* Get request method
144		*
145		* @access public
146		* @return string
147		*/
148		public function getMethod()
149		{
150		return $this->method;
151		}
152
153		/**
154		* Set timeout period
155		*
156		* @access public
157		* @param int $timeout
158		* @return \JonnyW\PhantomJs\Http\AbstractRequest
159		*/
160	1	public function setTimeout($timeout)
161		{
162	1	$this->timeout = $timeout;
163
164	1	return $this;
165		}
166
167		/**
168		* Get timeout period
169		*
170		* @access public
171		* @return int
172		*/
173		public function getTimeout()
174		{
175		return $this->timeout;
176		}
177
178		/**
179		* Set page load delay time (seconds).
180		*
181		* @access public
182		* @param int $delay
183		* @return \JonnyW\PhantomJs\Http\AbstractRequest
184		*/
185		public function setDelay($delay)
186		{
187		$this->delay = (int) $delay;
188
189		return $this;
190		}
191
192		/**
193		* Get page load delay time (seconds).
194		*
195		* @access public
196		* @return int
197		*/
198		public function getDelay()
199		{
200		return (int) $this->delay;
201		}
202
203		/**
204		* Set viewport size.
205		*
206		* @access public
207		* @param int $width
208		* @param int $height
209		* @return void
210		*/
211		public function setViewportSize($width, $height)
212		{
213		$this->viewportWidth = (int) $width;
214		$this->viewportHeight = (int) $height;
215
216		return $this;
217		}
218
219		/**
220		* Get viewport width.
221		*
222		* @access public
223		* @return int
224		*/
225		public function getViewportWidth()
226		{
227		return (int) $this->viewportWidth;
228		}
229
230		/**
231		* Get viewport height.
232		*
233		* @access public
234		* @return int
235		*/
236		public function getViewportHeight()
237		{
238		return (int) $this->viewportHeight;
239		}
240
241		/**
242		* Set request URL
243		*
244		* @access public
245		* @param string $url
246		* @return \JonnyW\PhantomJs\Http\AbstractRequest
247		*/
248		public function setUrl($url)
249		{
250		$this->url = $url;
251
252		return $this;
253		}
254
255		/**
256		* Get request URL
257		* - Assembles query string for GET
258		* and HEAD requests
259		*
260		* @access public
261		* @return string
262		*/
263		public function getUrl()
264		{
265		if (!in_array($this->getMethod(), array(RequestInterface::METHOD_GET, RequestInterface::METHOD_HEAD))) {
266		return $this->url;
267		}
268
269		$url = $this->url;
270
271		if (count($this->data)) {
272
273		$url .= false === strpos($url, '?') ? '?' : '&';
274		$url .= http_build_query($this->data);
275		}
276
277		return $url;
278		}
279
280		/**
281		* Get content body
282		* - Returns query string if not GET or HEAD
283		*
284		* @access public
285		* @return string
286		*/
287		public function getBody()
288		{
289		if (in_array($this->getMethod(), array(RequestInterface::METHOD_GET, RequestInterface::METHOD_HEAD))) {
290		return '';
291		}
292
293		return http_build_query($this->getRequestData());
294		}
295
296		/**
297		* Set request data
298		*
299		* @access public
300		* @param array $data
301		* @return \JonnyW\PhantomJs\Http\AbstractRequest
302		*/
303		public function setRequestData(array $data)
304		{
305		$this->data = $data;
306
307		return $this;
308		}
309
310		/**
311		* Get request data
312		*
313		* @access public
314		* @param boolean $flat
315		* @return array
316		*/
317		public function getRequestData($flat = true)
318		{
319		if ($flat) {
320		return $this->flattenData($this->data);
321		}
322
323		return $this->data;
324		}
325
326		/**
327		* Set headers
328		*
329		* @access public
330		* @param array $headers
331		* @return \JonnyW\PhantomJs\Http\AbstractRequest
332		*/
333		public function setHeaders(array $headers)
334		{
335		$this->headers = $headers;
336		}
337
338		/**
339		* Add single header
340		*
341		* @access public
342		* @param string $header
343		* @param string $value
344		* @return \JonnyW\PhantomJs\Http\AbstractRequest
345		*/
346		public function addHeader($header, $value)
347		{
348		$this->headers[$header] = $value;
349
350		return $this;
351		}
352
353		/**
354		* Merge headers with existing
355		*
356		* @access public
357		* @param array $headers
358		* @return \JonnyW\PhantomJs\Http\AbstractRequest
359		*/
360		public function addHeaders(array $headers)
361		{
362		$this->headers = array_merge($this->headers, $headers);
363
364		return $this;
365		}
366
367		/**
368		* Get request headers
369		*
370		* @access public
371		* @param string $format
372		* @return array\|string
373		*/
374		public function getHeaders($format = 'default')
375		{
376		if ($format === 'json') {
377		return json_encode($this->headers);
378		}
379
380		return $this->headers;
381		}
382
383		/**
384		* Set body styles
385		*
386		* @access public
387		* @param array $styles
388		* @return \JonnyW\PhantomJs\Http\AbstractRequest
389		*/
390		public function setBodyStyles(array $styles)
391		{
392		$this->bodyStyles = $styles;
393
394		return $this;
395		}
396
397		/**
398		* Get body styles
399		*
400		* @access public
401		* @param string $format (default: 'default')
402		* @return array\|string
403		*/
404		public function getBodyStyles($format = 'default')
405		{
406		if ($format === 'json') {
407		return json_encode($this->bodyStyles);
408		}
409
410		return $this->bodyStyles;
411		}
412
413		/**
414		* Flatten data into single
415		* dimensional array
416		*
417		* @access protected
418		* @param array $data
419		* @param string $prefix
420		* @param string $format
421		* @return array
422		*/
423		protected function flattenData(array $data, $prefix = '', $format = '%s')
424		{
425		$flat = array();
426
427		foreach ($data as $name => $value) {
428
429		$ref = $prefix . sprintf($format, $name);
430
431		if (is_array($value)) {
432
433		$flat += $this->flattenData($value, $ref, '[%s]');
434		continue;
435		}
436
437		$flat[$ref] = $value;
438		}
439
440		return $flat;
441		}
442		}
443

jonnnnyw / php-phantomjs

GitHub Access Token became invalid

Push — master ( c11e1b...0baec8 )

AbstractRequest::getHeaders() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like