Client::record() - Code Metrics - scriptotek/php-oai-pmh-client - Measure and Improve Code Quality continuously with Scrutinizer

Client::record() A
last analyzed 2016-12-11 12:21 UTC

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?php namespace Scriptotek\OaiPmh;

use GuzzleHttp\Client as HttpClient;
use Evenement\EventEmitter;

/**
 * OAI client
 */
class Client extends EventEmitter
{

    // When we no longer need to support PHP 5.3:
    // - Upgrade to Evenement 2.0 and use trait instead of extending

    /** @var HttpClient */
    protected $httpClient;

    /** @var string OAI service base URL */
    public $url;

    /** @var string Requested schema for the returned records */
    public $schema;

    /** @var string Some user agent string to identify our client */
    public $userAgent;

    /**
     * @var string|string[] Proxy configuration details.
     *
     * Either a string 'host:port' or an 
     * array('host:port', 'username', 'password').
     */
    public $proxy;

    /**
     * @var string[] Array containing username and password
     */
    public $credentials;

    /**
     * @var integer Max number of retries before giving up
     */
    public $maxRetries;

    /**
     * @var float Sleep time in seconds before retrying when getting an errorneous response
     */
    public $sleepTimeOnError;

    /**
     * @var integer Timeout for each request in seconds
     */
    public $timeout;

    protected function arrayGet($arr, $key, $default = null)
    {
        return (isset($arr[$key])) ? $arr[$key] : $default;
    }

    /**
     * Create a new client
     *
     * @param string $url Base URL to the OAI-PMH service
     * @param array $options Associative array of options
     * @param HttpClient $httpClient
     */
    public function __construct($url, $options = array(), $httpClient = null)
    {
        $this->url = $url;
        $this->httpClient = $httpClient ?: new HttpClient;

        $this->schema = $this->arrayGet($options, 'schema', 'marcxchange');
        $this->userAgent = $this->arrayGet($options, 'user-agent', 'php-oaipmh-client');
        $this->credentials = $this->arrayGet($options, 'credentials');
        $this->proxy = $this->arrayGet($options, 'proxy');
        $this->maxRetries = $this->arrayGet($options, 'max-retries', 30);
        $this->sleepTimeOnError = $this->arrayGet($options, 'sleep-time-on-error', 1.0);
        $this->timeout = $this->arrayGet($options, 'timeout', 60.0);
    }

    /**
     * Get HTTP client configuration options (authentication, proxy)
     * 
     * @return array
     */
    public function getHttpOptions()
    {
        $options = array(
            'headers' => $this->getHttpHeaders(),
            'connect_timeout' => $this->timeout,
            'timeout' => $this->timeout,
        );
        if ($this->credentials) {

            $options['auth'] = $this->credentials;
        }
        if ($this->proxy) {
            $options['proxy'] = $this->proxy;
        }
        return $options;
    }

    /**
     * Get HTTP client headers
     * 
     * @return array
     */
    public function getHttpHeaders()
    {
        $headers = array(
            'Accept' => 'application/xml'
        );
        if ($this->userAgent) {
            $headers['User-Agent'] = $this->userAgent;
        }
        return $headers;
    }

    /**
     * Construct the URL for an OAI-PMH query
     *
     * @param string $verb The OAI-PMH verb
     * @param array $arguments OAI-PMH arguments
     * @return string
     */
    public function urlBuilder($verb, $arguments = array())
    {
        $qs = array(
            'verb' => $verb,
            'metadataPrefix' => $this->schema,
        );

        foreach ($arguments as $key => $value) {
            $qs[$key] = $value;
            if (is_null($value)) {
                // Allow removal of default arguments like 'metadataPrefix'
                unset($qs[$key]);
            }
        }

        return $this->url . '?' . http_build_query($qs);
    }

    /**
     * Perform a single OAI-PMH request
     *
     * @param string $verb The OAI-PMH verb
     * @param array $arguments OAI-PMH arguments
     * @return string
     * @throws ConnectionError
     */
    public function request($verb, $arguments)
    {
        $this->emit('request.start', array(
            'verb' => $verb,
            'arguments' => $arguments
        ));
        $url = $this->urlBuilder($verb, $arguments);
        $attempt = 0;
        while (true) {
            try {
                $res = $this->httpClient->get($url, $this->getHttpOptions());
                break;
            } catch (\GuzzleHttp\Exception\ConnectException $e) {
                // Thrown in case of a networking error (connection timeout, DNS errors, etc.)
                $this->emit('request.error', array(
                    'message' => $e->getMessage(),
                ));
                time_nanosleep(intval($this->sleepTimeOnError), intval($this->sleepTimeOnError * 1000000000));
            } catch (\GuzzleHttp\Exception\ServerException $e) {
                // Thrown in case of 500 errors
                $this->emit('request.error', array(
                    'message' => $e->getMessage(),
                ));
                time_nanosleep(intval($this->sleepTimeOnError), intval($this->sleepTimeOnError * 1000000000));
            }
            $attempt++;
            if ($attempt > $this->maxRetries) {
                throw new ConnectionError('Failed to get a response from the server. Max retries (' . $this->maxRetries . ') exceeded.');
            }
        }
        $body = (string) $res->getBody();
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        $this->emit('request.complete', array(
            'verb' => $verb,
            'arguments' => $arguments,
            'response' => $body
        ));
        return $body;
    }

    /**
     * Perform a GetRecord request
     *
     * @param string $identifier
     * @return GetRecordResponse
     */
    public function record($identifier)
    {
        $data = $this->request('GetRecord', array('identifier' => $identifier));
        return new GetRecordResponse($data);
    }

    /**
     * Perform a ListRecords request and return an iterator over the records
     *
     * @param string $from Start date
     * @param string $until End date
     * @param string $set Data set
     * @param string $resumptionToken To resume a harvest
     * @param array $extraParams Extra GET parameters
     * @return Records
     */
    public function records($from, $until, $set, $resumptionToken = null, $extraParams = array())
    {
        return new Records($from, $until, $set, $this, $resumptionToken, $extraParams);

    }
}


1			<?php namespace Scriptotek\OaiPmh;
2
3			use GuzzleHttp\Client as HttpClient;
4			use Evenement\EventEmitter;
5
6			/**
7			* OAI client
8			*/
9			class Client extends EventEmitter
10			{
11
12			// When we no longer need to support PHP 5.3:
13			// - Upgrade to Evenement 2.0 and use trait instead of extending
14
15			/** @var HttpClient */
16			protected $httpClient;
17
18			/** @var string OAI service base URL */
19			public $url;
20
21			/** @var string Requested schema for the returned records */
22			public $schema;
23
24			/** @var string Some user agent string to identify our client */
25			public $userAgent;
26
27			/**
28			* @var string\|string[] Proxy configuration details.
29			*
30			* Either a string 'host:port' or an
31			* array('host:port', 'username', 'password').
32			*/
33			public $proxy;
34
35			/**
36			* @var string[] Array containing username and password
37			*/
38			public $credentials;
39
40			/**
41			* @var integer Max number of retries before giving up
42			*/
43			public $maxRetries;
44
45			/**
46			* @var float Sleep time in seconds before retrying when getting an errorneous response
47			*/
48			public $sleepTimeOnError;
49
50			/**
51			* @var integer Timeout for each request in seconds
52			*/
53			public $timeout;
54
55			protected function arrayGet($arr, $key, $default = null)
56			{
57			return (isset($arr[$key])) ? $arr[$key] : $default;
58			}
59
60			/**
61			* Create a new client
62			*
63			* @param string $url Base URL to the OAI-PMH service
64			* @param array $options Associative array of options
65			* @param HttpClient $httpClient
66			*/
67			public function __construct($url, $options = array(), $httpClient = null)
68			{
69			$this->url = $url;
70			$this->httpClient = $httpClient ?: new HttpClient;
71
72			$this->schema = $this->arrayGet($options, 'schema', 'marcxchange');
73			$this->userAgent = $this->arrayGet($options, 'user-agent', 'php-oaipmh-client');
74			$this->credentials = $this->arrayGet($options, 'credentials');
75			$this->proxy = $this->arrayGet($options, 'proxy');
76			$this->maxRetries = $this->arrayGet($options, 'max-retries', 30);
77			$this->sleepTimeOnError = $this->arrayGet($options, 'sleep-time-on-error', 1.0);
78			$this->timeout = $this->arrayGet($options, 'timeout', 60.0);
79			}
80
81			/**
82			* Get HTTP client configuration options (authentication, proxy)
83			*
84			* @return array
85			*/
86			public function getHttpOptions()
87			{
88			$options = array(
89			'headers' => $this->getHttpHeaders(),
90			'connect_timeout' => $this->timeout,
91			'timeout' => $this->timeout,
92			);
93			if ($this->credentials) {
			0 ignored issues – show Bug Best Practice introduced 2016-08-20 22:20 UTC by Report Bug Copy Issue Report The expression `$this->credentials` of type `string[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
94			$options['auth'] = $this->credentials;
95			}
96			if ($this->proxy) {
97			$options['proxy'] = $this->proxy;
98			}
99			return $options;
100			}
101
102			/**
103			* Get HTTP client headers
104			*
105			* @return array
106			*/
107			public function getHttpHeaders()
108			{
109			$headers = array(
110			'Accept' => 'application/xml'
111			);
112			if ($this->userAgent) {
113			$headers['User-Agent'] = $this->userAgent;
114			}
115			return $headers;
116			}
117
118			/**
119			* Construct the URL for an OAI-PMH query
120			*
121			* @param string $verb The OAI-PMH verb
122			* @param array $arguments OAI-PMH arguments
123			* @return string
124			*/
125			public function urlBuilder($verb, $arguments = array())
126			{
127			$qs = array(
128			'verb' => $verb,
129			'metadataPrefix' => $this->schema,
130			);
131
132			foreach ($arguments as $key => $value) {
133			$qs[$key] = $value;
134			if (is_null($value)) {
135			// Allow removal of default arguments like 'metadataPrefix'
136			unset($qs[$key]);
137			}
138			}
139
140			return $this->url . '?' . http_build_query($qs);
141			}
142
143			/**
144			* Perform a single OAI-PMH request
145			*
146			* @param string $verb The OAI-PMH verb
147			* @param array $arguments OAI-PMH arguments
148			* @return string
149			* @throws ConnectionError
150			*/
151			public function request($verb, $arguments)
152			{
153			$this->emit('request.start', array(
154			'verb' => $verb,
155			'arguments' => $arguments
156			));
157			$url = $this->urlBuilder($verb, $arguments);
158			$attempt = 0;
159			while (true) {
160			try {
161			$res = $this->httpClient->get($url, $this->getHttpOptions());
162			break;
163			} catch (\GuzzleHttp\Exception\ConnectException $e) {
164			// Thrown in case of a networking error (connection timeout, DNS errors, etc.)
165			$this->emit('request.error', array(
166			'message' => $e->getMessage(),
167			));
168			time_nanosleep(intval($this->sleepTimeOnError), intval($this->sleepTimeOnError * 1000000000));
169			} catch (\GuzzleHttp\Exception\ServerException $e) {
170			// Thrown in case of 500 errors
171			$this->emit('request.error', array(
172			'message' => $e->getMessage(),
173			));
174			time_nanosleep(intval($this->sleepTimeOnError), intval($this->sleepTimeOnError * 1000000000));
175			}
176			$attempt++;
177			if ($attempt > $this->maxRetries) {
178			throw new ConnectionError('Failed to get a response from the server. Max retries (' . $this->maxRetries . ') exceeded.');
179			}
180			}
181			$body = (string) $res->getBody();
			0 ignored issues – show Bug introduced 2016-08-20 22:20 UTC by Report Bug Copy Issue Report The variable `$res` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
182			$this->emit('request.complete', array(
183			'verb' => $verb,
184			'arguments' => $arguments,
185			'response' => $body
186			));
187			return $body;
188			}
189
190			/**
191			* Perform a GetRecord request
192			*
193			* @param string $identifier
194			* @return GetRecordResponse
195			*/
196			public function record($identifier)
197			{
198			$data = $this->request('GetRecord', array('identifier' => $identifier));
199			return new GetRecordResponse($data);
200			}
201
202			/**
203			* Perform a ListRecords request and return an iterator over the records
204			*
205			* @param string $from Start date
206			* @param string $until End date
207			* @param string $set Data set
208			* @param string $resumptionToken To resume a harvest
209			* @param array $extraParams Extra GET parameters
210			* @return Records
211			*/
212			public function records($from, $until, $set, $resumptionToken = null, $extraParams = array())
213			{
214			return new Records($from, $until, $set, $this, $resumptionToken, $extraParams);
			0 ignored issues – show Unused Code introduced 2016-11-27 21:20 UTC by Report Bug Copy Issue Report The call to `Records::__construct()` has too many arguments starting with `$extraParams`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
215			}
216			}
217

scriptotek / php-oai-pmh-client

Client::record() A last analyzed 2016-12-11 12:21 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Client::record() A
last analyzed 2016-12-11 12:21 UTC