RecordIterator - Code Metrics - Inspection of "Added `$resetResumptionToken` (default: `TRUE`) to..." - caseyamcl/phpoaipmh - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1c1d25...ad59d4 )

by Casey

created 2020-12-21 15:21 UTC

RecordIterator A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	319
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	36
lcom	1
cbo	3
dl	0
loc	319
rs	9.52
c	0
b	0
f	0

17 Methods

Rating	Name	Size	Complexity
A	current()	6	2
A	next()	4	1
A	key()	8	2
A	valid()	4	1
A	rewind()	4	1
A	__construct()	13	2
A	getClient()	4	1
A	getNumRequests()	4	1
A	getNumRetrieved()	4	1
A	getResumptionToken()	4	1
A	getExpirationDate()	4	1
A	getTotalRecordCount()	8	2
B	nextItem()	23	6
A	getItemNodeName()	11	2
A	getBatch()	4	1
B	retrieveNextBatch()	54	9
A	reset()	15	2

<?php

/**
 * PHPOAIPMH Library
 *
 * @license http://opensource.org/licenses/MIT
 * @link https://github.com/caseyamcl/phpoaipmh
 * @version 3.0
 * @package caseyamcl/phpoaipmh
 * @author Casey McLaughlin <[email protected]>
 *
 * For the full copyright and license information, -please view the LICENSE.md
 * file that was distributed with this source code.
 *
 * ------------------------------------------------------------------
 */

namespace Phpoaipmh;

use DateTime;
use DateTimeInterface;
use Iterator;
use Phpoaipmh\Exception\BaseOaipmhException;
use Phpoaipmh\Exception\MalformedResponseException;
use SimpleXMLElement;

/**
 * Response List Entity iterates over records returned from an OAI-PMH Endpoint
 *
 * @author Casey McLaughlin <[email protected]>
 * @since v2.0
 */
class RecordIterator implements Iterator, RecordIteratorInterface
{
    /**
     * @var Client
     */
    private $oaipmhClient;

    /**
     * @var string  The verb to use
     */
    private $verb;

    /**
     * @var array  OAI-PMH parameters passed as part of the request
     */
    private $params;

    /**
     * @var int  The number of total entities (if available)
     */
    private $totalRecordsInCollection;

    /**
     * @var DateTimeInterface  RecordSet expiration date (if specified)
     */
    private $expireDate;

    /**
     * @var string  The resumption token
     */
    private $resumptionToken;

    /**
     * @var array  Array of records
     */
    private $batch;

    /**
     * @var int Total number of records processed
     */
    private $numProcessed = 0;

    /**
     * @var boolean  Total number of requests made
     */
    private $numRequests = 0;

    /**
     * @var SimpleXMLElement|null  Used for tracking the iterator
     */
    private $currItem;

    /**
     * Constructor
     *
     * @param ClientInterface $client           The client to use
     * @param string          $verb             The verb to use when retrieving results from the client
     * @param array           $params           Optional parameters passed to OAI-PMH
     * @param string|null     $resumptionToken  Resumption token, if one exists
     */
    public function __construct(ClientInterface $client, $verb, array $params = [], $resumptionToken = null)
    {
        //Set parameters
        $this->oaipmhClient     = $client;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        $this->verb             = $verb;
        $this->params           = $params;
        $this->resumptionToken  = $resumptionToken;

        //Node name error?
        if (! $this->getItemNodeName()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            throw new BaseOaipmhException('Cannot determine item name for verb: ' . $this->verb);
        }
    }

    /**
     * @return ClientInterface
     */
    public function getClient()
    {
        return $this->oaipmhClient;
    }

    /**
     * Get the total number of requests made during this run
     *
     * @return int The number of HTTP requests made
     */
    public function getNumRequests()
    {
        return $this->numRequests;
    }

    /**
     * Get the total number of records processed during this run
     *
     * @return int The number of records processed
     */
    public function getNumRetrieved()
    {
        return $this->numProcessed;
    }


    /**
     * Get the resumption token if it is specified
     *
     * @return null|string
     */
    public function getResumptionToken()
    {
        return $this->resumptionToken;
    }

    /**
     * @return DateTimeInterface|null
     */
    public function getExpirationDate()
    {
        return $this->expireDate;
    }

    /**
     * Get the total number of records in the collection if available
     *
     * This only returns a value if the OAI-PMH server provides this information
     * in the response, which not all servers do (it is optional in the OAI-PMH spec)
     *
     * Also, the number of records may change during the requests, so it should
     * be treated as an estimate
     *
     * @return int|null
     */
    public function getTotalRecordCount()
    {
        if ($this->currItem === null) {
            $this->next();
        }

        return $this->totalRecordsInCollection;
    }

    /**
     * Get the next item
     *
     * Return an item from the currently-retrieved batch, get next batch and
     * return first record from it, or return false if no more records
     *
     * @return SimpleXMLElement|bool
     */
    public function nextItem()
    {
        if ($this->batch === null) {
            $this->batch = [];
        }
        
        //If no items in batch, and we have a resumptionToken or need to make initial request...
        if (count($this->batch) == 0 && ($this->resumptionToken or $this->numRequests == 0)) {
            $this->retrieveNextBatch();
        }

        //if still items in current batch, return one
        if (count($this->batch) > 0) {
            $this->numProcessed++;

            $item = array_shift($this->batch);
            $this->currItem = clone $item;
        } else {
            $this->currItem = false;

        }

        return $this->currItem;
    }

    /**
     * Do a request to get the next batch of items
     *
     * @return int The number of items in the batch after the retrieve
     */
    public function retrieveNextBatch()
    {
        // Set OAI-PMH parameters for request
        // If resumptionToken, then we ignore params and just use that
        $params = ($this->resumptionToken)
            ? ['resumptionToken' => $this->resumptionToken]
            : $this->params;

        // Node name and verb
        $nodeName = $this->getItemNodeName();
        $verb = $this->verb;

        //Do it..
        $resp = $this->oaipmhClient->request($verb, $params);
        $this->numRequests++;

        //Result format error?
        if (! isset($resp->$verb->$nodeName)) {
            throw new MalformedResponseException(sprintf(
                "Expected XML element list '%s' missing for verb '%s'",
                $nodeName,
                $verb
            ));
        }

        //Set the resumption token and expiration date, if specified in the response
        if (isset($resp->$verb->resumptionToken)) {
            $this->resumptionToken = (string) $resp->$verb->resumptionToken;

            if (isset($resp->$verb->resumptionToken['completeListSize'])) {
                $this->totalRecordsInCollection = (int) $resp->$verb->resumptionToken['completeListSize'];
            }
            if (isset($resp->$verb->resumptionToken['expirationDate'])) {
                $t = $resp->$verb->resumptionToken['expirationDate'];
                $this->expireDate = DateTime::createFromFormat(DateTime::ISO8601, $t);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            }
        } else {
            //Unset the resumption token when we're at the end of the list
            $this->resumptionToken = null;
        }

        //Process the results
        foreach ($resp->$verb->$nodeName as $node) {
            $this->batch[] = $node;
        }

        // If the entire set was sent in one request, store the total count.
        if ($this->numRequests == 1 && $this->resumptionToken === null) {
            $this->totalRecordsInCollection = count($this->batch);
        }

        //Return a count
        return count($this->batch);
    }

    /**
     * Get Item Node Name
     *
     * Map the item node name based on the verb
     *
     * @return string|boolean The element name for the mapping, or false if unmapped
     */
    private function getItemNodeName()
    {
        $mappings = array(
            'ListMetadataFormats' => 'metadataFormat',
            'ListSets'            => 'set',
            'ListIdentifiers'     => 'header',
            'ListRecords'         => 'record'
        );

        return (isset($mappings[$this->verb])) ? $mappings[$this->verb] : false;
    }

    // ----------------------------------------------------------------
    // Leaky abstraction methods

    /**
     * Get the current batch of records retrieved
     *
     * @return array|SimpleXMLElement[]
     */
    public function getBatch()
    {
        return $this->batch;
    }

    /**
     * Reset the request state
     * @param bool $resetResumptionToken
     */
    public function reset($resetResumptionToken = true)
    {
        $this->numRequests  = 0;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->numProcessed = 0;

        $this->currItem                 = null;
        $this->totalRecordsInCollection = null;
        $this->expireDate               = null;

        if ($resetResumptionToken) {
            $this->resumptionToken = null;
        }

        $this->batch = [];
    }

    // ----------------------------------------------------------------
    // Iterator methods

    public function current()
    {
        return ($this->currItem === null)
            ? $this->nextItem()
            : $this->currItem;
    }

    public function next()
    {
        return $this->nextItem();
    }

    public function key()
    {
        if ($this->currItem === null) {
            $this->nextItem();
        }

        return $this->getNumRetrieved();
    }

    public function valid()
    {
        return ($this->currItem !== false);
    }

    public function rewind()
    {
        $this->reset();
    }
}


1			<?php
2
3			/**
4			* PHPOAIPMH Library
5			*
6			* @license http://opensource.org/licenses/MIT
7			* @link https://github.com/caseyamcl/phpoaipmh
8			* @version 3.0
9			* @package caseyamcl/phpoaipmh
10			* @author Casey McLaughlin <[email protected]>
11			*
12			* For the full copyright and license information, -please view the LICENSE.md
13			* file that was distributed with this source code.
14			*
15			* ------------------------------------------------------------------
16			*/
17
18			namespace Phpoaipmh;
19
20			use DateTime;
21			use DateTimeInterface;
22			use Iterator;
23			use Phpoaipmh\Exception\BaseOaipmhException;
24			use Phpoaipmh\Exception\MalformedResponseException;
25			use SimpleXMLElement;
26
27			/**
28			* Response List Entity iterates over records returned from an OAI-PMH Endpoint
29			*
30			* @author Casey McLaughlin <[email protected]>
31			* @since v2.0
32			*/
33			class RecordIterator implements Iterator, RecordIteratorInterface
34			{
35			/**
36			* @var Client
37			*/
38			private $oaipmhClient;
39
40			/**
41			* @var string The verb to use
42			*/
43			private $verb;
44
45			/**
46			* @var array OAI-PMH parameters passed as part of the request
47			*/
48			private $params;
49
50			/**
51			* @var int The number of total entities (if available)
52			*/
53			private $totalRecordsInCollection;
54
55			/**
56			* @var DateTimeInterface RecordSet expiration date (if specified)
57			*/
58			private $expireDate;
59
60			/**
61			* @var string The resumption token
62			*/
63			private $resumptionToken;
64
65			/**
66			* @var array Array of records
67			*/
68			private $batch;
69
70			/**
71			* @var int Total number of records processed
72			*/
73			private $numProcessed = 0;
74
75			/**
76			* @var boolean Total number of requests made
77			*/
78			private $numRequests = 0;
79
80			/**
81			* @var SimpleXMLElement\|null Used for tracking the iterator
82			*/
83			private $currItem;
84
85			/**
86			* Constructor
87			*
88			* @param ClientInterface $client The client to use
89			* @param string $verb The verb to use when retrieving results from the client
90			* @param array $params Optional parameters passed to OAI-PMH
91			* @param string\|null $resumptionToken Resumption token, if one exists
92			*/
93			public function __construct(ClientInterface $client, $verb, array $params = [], $resumptionToken = null)
94			{
95			//Set parameters
96			$this->oaipmhClient = $client;
			0 ignored issues – show Documentation Bug introduced 2017-07-30 02:23 UTC by Report Bug Copy Issue Report `$client` is of type `object<Phpoaipmh\ClientInterface>`, but the property `$oaipmhClient` was declared to be of type `object<Phpoaipmh\Client>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
97			$this->verb = $verb;
98			$this->params = $params;
99			$this->resumptionToken = $resumptionToken;
100
101			//Node name error?
102			if (! $this->getItemNodeName()) {
			0 ignored issues – show Bug Best Practice introduced 2016-03-29 22:11 UTC by Report Bug Copy Issue Report The expression `$this->getItemNodeName()` of type `string\|false` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== false` 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...
103			throw new BaseOaipmhException('Cannot determine item name for verb: ' . $this->verb);
104			}
105			}
106
107			/**
108			* @return ClientInterface
109			*/
110			public function getClient()
111			{
112			return $this->oaipmhClient;
113			}
114
115			/**
116			* Get the total number of requests made during this run
117			*
118			* @return int The number of HTTP requests made
119			*/
120			public function getNumRequests()
121			{
122			return $this->numRequests;
123			}
124
125			/**
126			* Get the total number of records processed during this run
127			*
128			* @return int The number of records processed
129			*/
130			public function getNumRetrieved()
131			{
132			return $this->numProcessed;
133			}
134
135
136			/**
137			* Get the resumption token if it is specified
138			*
139			* @return null\|string
140			*/
141			public function getResumptionToken()
142			{
143			return $this->resumptionToken;
144			}
145
146			/**
147			* @return DateTimeInterface\|null
148			*/
149			public function getExpirationDate()
150			{
151			return $this->expireDate;
152			}
153
154			/**
155			* Get the total number of records in the collection if available
156			*
157			* This only returns a value if the OAI-PMH server provides this information
158			* in the response, which not all servers do (it is optional in the OAI-PMH spec)
159			*
160			* Also, the number of records may change during the requests, so it should
161			* be treated as an estimate
162			*
163			* @return int\|null
164			*/
165			public function getTotalRecordCount()
166			{
167			if ($this->currItem === null) {
168			$this->next();
169			}
170
171			return $this->totalRecordsInCollection;
172			}
173
174			/**
175			* Get the next item
176			*
177			* Return an item from the currently-retrieved batch, get next batch and
178			* return first record from it, or return false if no more records
179			*
180			* @return SimpleXMLElement\|bool
181			*/
182			public function nextItem()
183			{
184			if ($this->batch === null) {
185			$this->batch = [];
186			}
187
188			//If no items in batch, and we have a resumptionToken or need to make initial request...
189			if (count($this->batch) == 0 && ($this->resumptionToken or $this->numRequests == 0)) {
190			$this->retrieveNextBatch();
191			}
192
193			//if still items in current batch, return one
194			if (count($this->batch) > 0) {
195			$this->numProcessed++;
196
197			$item = array_shift($this->batch);
198			$this->currItem = clone $item;
199			} else {
200			$this->currItem = false;
			0 ignored issues – show Documentation Bug introduced 2016-03-29 22:11 UTC by Report Bug Copy Issue Report It seems like `false` of type `false` is incompatible with the declared type `object<SimpleXMLElement>\|null` of property `$currItem`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
201			}
202
203			return $this->currItem;
204			}
205
206			/**
207			* Do a request to get the next batch of items
208			*
209			* @return int The number of items in the batch after the retrieve
210			*/
211			public function retrieveNextBatch()
212			{
213			// Set OAI-PMH parameters for request
214			// If resumptionToken, then we ignore params and just use that
215			$params = ($this->resumptionToken)
216			? ['resumptionToken' => $this->resumptionToken]
217			: $this->params;
218
219			// Node name and verb
220			$nodeName = $this->getItemNodeName();
221			$verb = $this->verb;
222
223			//Do it..
224			$resp = $this->oaipmhClient->request($verb, $params);
225			$this->numRequests++;
226
227			//Result format error?
228			if (! isset($resp->$verb->$nodeName)) {
229			throw new MalformedResponseException(sprintf(
230			"Expected XML element list '%s' missing for verb '%s'",
231			$nodeName,
232			$verb
233			));
234			}
235
236			//Set the resumption token and expiration date, if specified in the response
237			if (isset($resp->$verb->resumptionToken)) {
238			$this->resumptionToken = (string) $resp->$verb->resumptionToken;
239
240			if (isset($resp->$verb->resumptionToken['completeListSize'])) {
241			$this->totalRecordsInCollection = (int) $resp->$verb->resumptionToken['completeListSize'];
242			}
243			if (isset($resp->$verb->resumptionToken['expirationDate'])) {
244			$t = $resp->$verb->resumptionToken['expirationDate'];
245			$this->expireDate = DateTime::createFromFormat(DateTime::ISO8601, $t);
			0 ignored issues – show Documentation Bug introduced 2018-10-15 14:56 UTC by Report Bug Copy Issue Report It seems like `\DateTime::createFromFor...\DateTime::ISO8601, $t)` can also be of type `false`. However, the property `$expireDate` is declared as type `object<DateTimeInterface>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
246			}
247			} else {
248			//Unset the resumption token when we're at the end of the list
249			$this->resumptionToken = null;
250			}
251
252			//Process the results
253			foreach ($resp->$verb->$nodeName as $node) {
254			$this->batch[] = $node;
255			}
256
257			// If the entire set was sent in one request, store the total count.
258			if ($this->numRequests == 1 && $this->resumptionToken === null) {
259			$this->totalRecordsInCollection = count($this->batch);
260			}
261
262			//Return a count
263			return count($this->batch);
264			}
265
266			/**
267			* Get Item Node Name
268			*
269			* Map the item node name based on the verb
270			*
271			* @return string\|boolean The element name for the mapping, or false if unmapped
272			*/
273			private function getItemNodeName()
274			{
275			$mappings = array(
276			'ListMetadataFormats' => 'metadataFormat',
277			'ListSets' => 'set',
278			'ListIdentifiers' => 'header',
279			'ListRecords' => 'record'
280			);
281
282			return (isset($mappings[$this->verb])) ? $mappings[$this->verb] : false;
283			}
284
285			// ----------------------------------------------------------------
286			// Leaky abstraction methods
287
288			/**
289			* Get the current batch of records retrieved
290			*
291			* @return array\|SimpleXMLElement[]
292			*/
293			public function getBatch()
294			{
295			return $this->batch;
296			}
297
298			/**
299			* Reset the request state
300			* @param bool $resetResumptionToken
301			*/
302			public function reset($resetResumptionToken = true)
303			{
304			$this->numRequests = 0;
			0 ignored issues – show Documentation Bug introduced 2020-12-21 15:22 UTC by Report Bug Copy Issue Report The property `$numRequests` was declared of type `boolean`, but `0` is of type `integer`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
305			$this->numProcessed = 0;
306
307			$this->currItem = null;
308			$this->totalRecordsInCollection = null;
309			$this->expireDate = null;
310
311			if ($resetResumptionToken) {
312			$this->resumptionToken = null;
313			}
314
315			$this->batch = [];
316			}
317
318			// ----------------------------------------------------------------
319			// Iterator methods
320
321			public function current()
322			{
323			return ($this->currItem === null)
324			? $this->nextItem()
325			: $this->currItem;
326			}
327
328			public function next()
329			{
330			return $this->nextItem();
331			}
332
333			public function key()
334			{
335			if ($this->currItem === null) {
336			$this->nextItem();
337			}
338
339			return $this->getNumRetrieved();
340			}
341
342			public function valid()
343			{
344			return ($this->currItem !== false);
345			}
346
347			public function rewind()
348			{
349			$this->reset();
350			}
351			}
352

caseyamcl / phpoaipmh

Push — master ( 1c1d25...ad59d4 )

RecordIterator A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

17 Methods

Duplication Side-by-Side

Filter issues like