AutoPagingIterator::__construct() - Code Metrics - ARCANEDEV/Stripe - Measure and Improve Code Quality continuously with Scrutinizer

AutoPagingIterator::__construct() A
last analyzed 2017-11-29 19:32 UTC

↳ Parent: AutoPagingIterator

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?php namespace Arcanedev\Stripe\Utilities;

use Arcanedev\Stripe\Collection;
use Iterator;

/**
 * Class     AutoPagingIterator
 *
 * @package  Arcanedev\Stripe\Utilities
 * @author   ARCANEDEV <[email protected]>
 */
class AutoPagingIterator implements Iterator
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    private $lastId = null;

    /** @var \Arcanedev\Stripe\Collection  */
    private $page   = null;

    /** @var int */
    private $pageOffset = 0;

    /** @var array */
    private $params = [];

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * AutoPagingIterator constructor.
     *
     * @param  \Arcanedev\Stripe\Collection  $collection
     * @param  array                         $params
     */
    public function __construct(Collection $collection, array $params)
    {
        $this->page   = $collection;
        $this->params = $params;
    }

    /**
     * Make a AutoPagingIterator object.
     *
     * @param  \Arcanedev\Stripe\Collection  $collection
     * @param  array                         $params
     *
     * @return self
     */
    public static function make(Collection $collection, array $params)
    {
        return new self($collection, $params);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Return the current element.
     * @link  http://php.net/manual/en/iterator.current.php
     *
     * @return mixed
     */
    public function current()
    {
        $item         = current($this->page->data);
        $this->lastId = $item !== false ? $item['id'] : null;

        return $item;
    }

    /**
     * Move forward to next element.
     * @link  http://php.net/manual/en/iterator.next.php
     */
    public function next()
    {
        $item = next($this->page->data);

        if ($item === false) {
            // If we've run out of data on the current page, try to fetch another one
            // and increase the offset the new page would start at
            $this->pageOffset += count($this->page->data);

            if ($this->page['has_more']) {
                $this->params = array_merge(
                    $this->params ? $this->params : [],
                    ['starting_after' => $this->lastId]
                );

                $this->page   = $this->page->all($this->params);
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 return;
        }
    }

    /**
     * Return the key of the current element.
     * @link  http://php.net/manual/en/iterator.key.php
     *
     * @return mixed
     */
    public function key()
    {
        return key($this->page->data) + $this->pageOffset;
    }

    /**
     * Checks if current position is valid.
     * @link  http://php.net/manual/en/iterator.valid.php
     *
     * @return bool
     */
    public function valid()
    {
        $key  = key($this->page->data);

        return ($key !== null && $key !== false);
    }

    /**
     * Rewind the Iterator to the first element.
     * @link  http://php.net/manual/en/iterator.rewind.php
     */
    public function rewind()
    {
        // Actually rewinding would require making a copy of the original page.
    }
}


1		<?php namespace Arcanedev\Stripe\Utilities;
2
3		use Arcanedev\Stripe\Collection;
4		use Iterator;
5
6		/**
7		* Class AutoPagingIterator
8		*
9		* @package Arcanedev\Stripe\Utilities
10		* @author ARCANEDEV <[email protected]>
11		*/
12		class AutoPagingIterator implements Iterator
13		{
14		/* ------------------------------------------------------------------------------------------------
15		\| Properties
16		\| ------------------------------------------------------------------------------------------------
17		*/
18		private $lastId = null;
19
20		/** @var \Arcanedev\Stripe\Collection */
21		private $page = null;
22
23		/** @var int */
24		private $pageOffset = 0;
25
26		/** @var array */
27		private $params = [];
28
29		/* ------------------------------------------------------------------------------------------------
30		\| Constructor
31		\| ------------------------------------------------------------------------------------------------
32		*/
33		/**
34		* AutoPagingIterator constructor.
35		*
36		* @param \Arcanedev\Stripe\Collection $collection
37		* @param array $params
38		*/
39	6	public function __construct(Collection $collection, array $params)
40		{
41	6	$this->page = $collection;
42	6	$this->params = $params;
43	6	}
44
45		/**
46		* Make a AutoPagingIterator object.
47		*
48		* @param \Arcanedev\Stripe\Collection $collection
49		* @param array $params
50		*
51		* @return self
52		*/
53	6	public static function make(Collection $collection, array $params)
54		{
55	6	return new self($collection, $params);
56		}
57
58		/* ------------------------------------------------------------------------------------------------
59		\| Main Functions
60		\| ------------------------------------------------------------------------------------------------
61		*/
62		/**
63		* Return the current element.
64		* @link http://php.net/manual/en/iterator.current.php
65		*
66		* @return mixed
67		*/
68	6	public function current()
69		{
70	6	$item = current($this->page->data);
71	6	$this->lastId = $item !== false ? $item['id'] : null;
72
73	6	return $item;
74		}
75
76		/**
77		* Move forward to next element.
78		* @link http://php.net/manual/en/iterator.next.php
79		*/
80	6	public function next()
81		{
82	6	$item = next($this->page->data);
83
84	6	if ($item === false) {
85		// If we've run out of data on the current page, try to fetch another one
86		// and increase the offset the new page would start at
87	6	$this->pageOffset += count($this->page->data);
88
89	6	if ($this->page['has_more']) {
90	4	$this->params = array_merge(
91	4	$this->params ? $this->params : [],
92	4	['starting_after' => $this->lastId]
93		);
94
95	4	$this->page = $this->page->all($this->params);
		0 ignored issues – show Documentation Bug introduced 2017-09-21 10:24 UTC by Report Bug Copy Issue Report It seems like `$this->page->all($this->params)` can also be of type `array`. However, the property `$page` is declared as type `object<Arcanedev\Stripe\Collection>`. 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...
96		}
97	6	else return;
98		}
99	6	}
100
101		/**
102		* Return the key of the current element.
103		* @link http://php.net/manual/en/iterator.key.php
104		*
105		* @return mixed
106		*/
107	2	public function key()
108		{
109	2	return key($this->page->data) + $this->pageOffset;
110		}
111
112		/**
113		* Checks if current position is valid.
114		* @link http://php.net/manual/en/iterator.valid.php
115		*
116		* @return bool
117		*/
118	6	public function valid()
119		{
120	6	$key = key($this->page->data);
121
122	6	return ($key !== null && $key !== false);
123		}
124
125		/**
126		* Rewind the Iterator to the first element.
127		* @link http://php.net/manual/en/iterator.rewind.php
128		*/
129	6	public function rewind()
130		{
131		// Actually rewinding would require making a copy of the original page.
132	6	}
133		}
134

ARCANEDEV / Stripe

AutoPagingIterator::__construct() A last analyzed 2017-11-29 19:32 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

AutoPagingIterator::__construct() A
last analyzed 2017-11-29 19:32 UTC