HttpOptions::__call() - Code Metrics - Inspection of "Added support for uploading files and a few exampl..." - shahradelahi/easy-http - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 91fe13...12bba4 )

by Shahrad

created 2022-05-01 14:21 UTC

HttpOptions::__call() B

↳ Parent: HttpOptions

Complexity

Conditions	7
Paths	9

Size

Total Lines	26
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	14
c	0
b	0
f	0
dl	0
loc	26
rs	8.8333
cc	7
nc	9
nop	2

<?php

namespace EasyHttp\Model;

/**
 * Http Options
 *
 * @link    https://github.com/shahradelahi/easy-http
 * @author  Shahrad Elahi (https://github.com/shahradelahi)
 * @license https://github.com/shahradelahi/easy-http/blob/master/LICENSE (MIT License)
 *
 * @method array       getHeader()          Get the header
 * @method array       getCookie()          Get the cookie
 * @method string|null getBody()            Get the body
 * @method int         getTimeout()         Get the timeout
 * @method array       getMultipart()       Get the multipart
 * @method ProxyServer getProxy()           Get the proxy
 * @method array       getQuery()           Get the query
 * @method array       getCurlOptions()     Get the curl options
 *
 * @method $this setHeader(array $header)           Set the header
 * @method $this setCookie(array $cookie)           Set the cookie
 * @method $this setQuery(array $query)             Set the query
 * @method $this setTimeout(int $timeout)           Set the timeout
 * @method $this setMultipart(array $multipart)     Set the multipart
 */
class HttpOptions
{

    /**
     * An array of HTTP header fields to set, in the format array('<em>Content-type: text/plain</em>', '<em>Content-length: 100</em>')
     *
     * @var array
     */
    private array $header = [];

    /**
     * An array of cookies to set, in the format array('name' => 'value', 'name2' => 'value2')
     *
     * @var array
     */
    private array $cookie = [];

    /**
     * An array of query data (e.g., array('id' => '123', 'name' => 'John')) for use in the query string part of the URI (e.g., http://example.com/index.php?id=123&name=John)
     *
     * @var array
     */
    private array $query = [];

    /**
     * The body of the HTTP request
     *
     * @var ?string
     */
    private ?string $body = null;

    /**
     * The maximum number of seconds to allow cURL functions to execute
     *
     * @var int
     */
    private int $timeout = 30;

    /**
     * An array of multipart data (e.g., array('name', 'contents', 'size')), for use in the multipart/form-data part of the request body
     *
     * @var array
     */
    private array $multipart = [];

    /**
     * An array of cURL options
     *
     * @var array
     */
    private array $curlOptions = [];

    /**
     * The proxy server to use
     *
     * @var ?ProxyServer
     */
    private ?ProxyServer $proxy = null;

    /**
     * Http Options constructor.
     *
     * @param array $options
     */
    public function __construct(array $options = [])
    {
        $this->setOptions($options);
    }

    /**
     * Returns the class as an array
     *
     * @return array
     */
    public function toArray(): array
    {
        $result = [];
        foreach (get_object_vars($this) as $key => $value) {
            $result[$key] = $value;
        }
        return $result;
    }

    /**
     * Set Options
     *
     * @param array $options
     * @return void
     */
    public function setOptions(array $options): void
    {
        foreach ($options as $key => $value) {
            if (method_exists($this, 'set' . ucfirst($key))) {
                if ($value !== null) {
                    $this->{'set' . ucfirst($key)}($value);
                }
            } else {
                if (property_exists($this, $key)) {
                    $this->{$key} = $value;
                } else {
                    throw new \InvalidArgumentException("Invalid option: $key");
                }
            }
        }
    }

    /**
     * Set Body of Http request
     *
     * @param ?string|array $body The body of the request - On array it will be converted to json
     * @return void
     */
    public function setBody(string|array|null $body): void
    {
        if (is_array($body)) {

            $this->body = json_encode($body);
            $this->headers['Content-Type'] = 'application/json';

        } else {
            $this->body = $body;
        }
    }

    /**
     * Set proxy server
     *
     * @param array $proxy ["host", "port", "user", "pass"]
     * @return void
     */
    public function setProxy(array $proxy): void
    {
        $this->proxy = (new ProxyServer())->setProxy($proxy);
    }

    /**
     * Generate URL-encoded query string.
     *
     * @return string
     */
    public function getQueryString(): string
    {
        return http_build_query($this->query);
    }

    /**
     * Set Curl Options
     *
     * @param array $options [{"CURLOPT_*": "value"}, ...]
     * @return void
     */
    public function setCurlOptions(array $options): void
    {
        if (count($options) > 0) {
            foreach ($options as $option => $value) {
                $this->curlOptions[$option] = $value;
            }
        }
    }

    /**
     * Add Multipart Data
     *
     * @param array $multipart [{"name", "path"}, ...]
     * @return void
     */
    public function addMultiPart(array $multipart): void
    {
        $this->multipart[] = $multipart;
    }

    /**
     * @param string $name
     * @param array $arguments
     * @return mixed
     */
    public function __call(string $name, array $arguments): mixed
    {
        if (method_exists($this, $name)) {
            return $this->{$name}(...$arguments);
        }

        if (property_exists($this, $name)) {
            return $this->{$name};
        }

        if (str_starts_with($name, 'set')) {
            $property = lcfirst(substr($name, 3));
            if (property_exists($this, $property)) {
                $this->{$property} = $arguments[0];
                return $this;
            }
        }

        if (str_starts_with($name, 'get')) {
            $property = lcfirst(substr($name, 3));
            if (property_exists($this, $property)) {
                return $this->{$property};
            }
        }

        throw new \BadMethodCallException("Method $name does not exist");
    }

}

1			<?php
2
3			namespace EasyHttp\Model;
4
5			/**
6			* Http Options
7			*
8			* @link https://github.com/shahradelahi/easy-http
9			* @author Shahrad Elahi (https://github.com/shahradelahi)
10			* @license https://github.com/shahradelahi/easy-http/blob/master/LICENSE (MIT License)
11			*
12			* @method array getHeader() Get the header
13			* @method array getCookie() Get the cookie
14			* @method string\|null getBody() Get the body
15			* @method int getTimeout() Get the timeout
16			* @method array getMultipart() Get the multipart
17			* @method ProxyServer getProxy() Get the proxy
18			* @method array getQuery() Get the query
19			* @method array getCurlOptions() Get the curl options
20			*
21			* @method $this setHeader(array $header) Set the header
22			* @method $this setCookie(array $cookie) Set the cookie
23			* @method $this setQuery(array $query) Set the query
24			* @method $this setTimeout(int $timeout) Set the timeout
25			* @method $this setMultipart(array $multipart) Set the multipart
26			*/
27			class HttpOptions
28			{
29
30			/**
31			* An array of HTTP header fields to set, in the format array('<em>Content-type: text/plain</em>', '<em>Content-length: 100</em>')
32			*
33			* @var array
34			*/
35			private array $header = [];
36
37			/**
38			* An array of cookies to set, in the format array('name' => 'value', 'name2' => 'value2')
39			*
40			* @var array
41			*/
42			private array $cookie = [];
43
44			/**
45			* An array of query data (e.g., array('id' => '123', 'name' => 'John')) for use in the query string part of the URI (e.g., http://example.com/index.php?id=123&name=John)
46			*
47			* @var array
48			*/
49			private array $query = [];
50
51			/**
52			* The body of the HTTP request
53			*
54			* @var ?string
55			*/
56			private ?string $body = null;
57
58			/**
59			* The maximum number of seconds to allow cURL functions to execute
60			*
61			* @var int
62			*/
63			private int $timeout = 30;
64
65			/**
66			* An array of multipart data (e.g., array('name', 'contents', 'size')), for use in the multipart/form-data part of the request body
67			*
68			* @var array
69			*/
70			private array $multipart = [];
71
72			/**
73			* An array of cURL options
74			*
75			* @var array
76			*/
77			private array $curlOptions = [];
78
79			/**
80			* The proxy server to use
81			*
82			* @var ?ProxyServer
83			*/
84			private ?ProxyServer $proxy = null;
85
86			/**
87			* Http Options constructor.
88			*
89			* @param array $options
90			*/
91			public function __construct(array $options = [])
92			{
93			$this->setOptions($options);
94			}
95
96			/**
97			* Returns the class as an array
98			*
99			* @return array
100			*/
101			public function toArray(): array
102			{
103			$result = [];
104			foreach (get_object_vars($this) as $key => $value) {
105			$result[$key] = $value;
106			}
107			return $result;
108			}
109
110			/**
111			* Set Options
112			*
113			* @param array $options
114			* @return void
115			*/
116			public function setOptions(array $options): void
117			{
118			foreach ($options as $key => $value) {
119			if (method_exists($this, 'set' . ucfirst($key))) {
120			if ($value !== null) {
121			$this->{'set' . ucfirst($key)}($value);
122			}
123			} else {
124			if (property_exists($this, $key)) {
125			$this->{$key} = $value;
126			} else {
127			throw new \InvalidArgumentException("Invalid option: $key");
128			}
129			}
130			}
131			}
132
133			/**
134			* Set Body of Http request
135			*
136			* @param ?string\|array $body The body of the request - On array it will be converted to json
137			* @return void
138			*/
139			public function setBody(string\|array\|null $body): void
140			{
141			if (is_array($body)) {
			0 ignored issues – show introduced 2022-04-19 22:45 UTC by Report Bug Copy Issue Report The condition `is_array($body)` is always `true`. Loading history...
142			$this->body = json_encode($body);
143			$this->headers['Content-Type'] = 'application/json';
			0 ignored issues – show Bug Best Practice introduced 2022-05-01 14:31 UTC by Report Bug Copy Issue Report The property `headers` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
144			} else {
145			$this->body = $body;
146			}
147			}
148
149			/**
150			* Set proxy server
151			*
152			* @param array $proxy ["host", "port", "user", "pass"]
153			* @return void
154			*/
155			public function setProxy(array $proxy): void
156			{
157			$this->proxy = (new ProxyServer())->setProxy($proxy);
158			}
159
160			/**
161			* Generate URL-encoded query string.
162			*
163			* @return string
164			*/
165			public function getQueryString(): string
166			{
167			return http_build_query($this->query);
168			}
169
170			/**
171			* Set Curl Options
172			*
173			* @param array $options [{"CURLOPT_*": "value"}, ...]
174			* @return void
175			*/
176			public function setCurlOptions(array $options): void
177			{
178			if (count($options) > 0) {
179			foreach ($options as $option => $value) {
180			$this->curlOptions[$option] = $value;
181			}
182			}
183			}
184
185			/**
186			* Add Multipart Data
187			*
188			* @param array $multipart [{"name", "path"}, ...]
189			* @return void
190			*/
191			public function addMultiPart(array $multipart): void
192			{
193			$this->multipart[] = $multipart;
194			}
195
196			/**
197			* @param string $name
198			* @param array $arguments
199			* @return mixed
200			*/
201			public function __call(string $name, array $arguments): mixed
202			{
203			if (method_exists($this, $name)) {
204			return $this->{$name}(...$arguments);
205			}
206
207			if (property_exists($this, $name)) {
208			return $this->{$name};
209			}
210
211			if (str_starts_with($name, 'set')) {
212			$property = lcfirst(substr($name, 3));
213			if (property_exists($this, $property)) {
214			$this->{$property} = $arguments[0];
215			return $this;
216			}
217			}
218
219			if (str_starts_with($name, 'get')) {
220			$property = lcfirst(substr($name, 3));
221			if (property_exists($this, $property)) {
222			return $this->{$property};
223			}
224			}
225
226			throw new \BadMethodCallException("Method $name does not exist");
227			}
228
229			}

shahradelahi / easy-http

Push — master ( 91fe13...12bba4 )

HttpOptions::__call() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like