Passed
Push — master ( 342193...f80fe6 )
by Andrea Marco
03:14 queued 11s
created

Outcome   A

Complexity

Total Complexity 5

Size/Duplication

Total Lines 74
Duplicated Lines 0 %

Test Coverage

Coverage 100%

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 5
eloc 15
c 1
b 0
f 0
dl 0
loc 74
ccs 18
cts 18
cp 1
rs 10

4 Methods

Rating   Name   Duplication   Size   Complexity  
A addItemsFromPage() 0 7 1
A pullFailedPages() 0 7 1
A pullItems() 0 9 2
A addFailedPage() 0 5 1
1
<?php
2
3
namespace Cerbero\LazyJsonPages;
4
5
use Cerbero\LazyJson\Source;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, Cerbero\LazyJsonPages\Source. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
6
use Psr\Http\Message\ResponseInterface;
7
use Traversable;
8
9
/**
10
 * The pages fetching outcome.
11
 *
12
 */
13
class Outcome
14
{
15
    /**
16
     * The item generators.
17
     *
18
     * @var \Generator[]
19
     */
20
    protected $items = [];
21
22
    /**
23
     * The pages unable to be fetched.
24
     *
25
     * @var array
26
     */
27
    protected $failedPages = [];
28
29
    /**
30
     * Add the items from the given page
31
     *
32
     * @param int $page
33
     * @param ResponseInterface $response
34
     * @param string $path
35
     * @return self
36
     */
37 11
    public function addItemsFromPage(int $page, ResponseInterface $response, string $path): self
38
    {
39 11
        $this->items[$page] = (function () use ($response, $path) {
40 11
            yield from new Source($response, $path);
41 11
        })();
42
43 11
        return $this;
44
    }
45
46
    /**
47
     * Traverse and unset the items
48
     *
49
     * @return Traversable
50
     */
51 12
    public function pullItems(): Traversable
52
    {
53 12
        ksort($this->items);
54
55 12
        foreach ($this->items as $generator) {
56 11
            yield from $generator;
57
        }
58
59 12
        $this->items = [];
60 12
    }
61
62
    /**
63
     * Add the given page to the failed pages
64
     *
65
     * @param string|int $page
66
     * @return self
67
     */
68 2
    public function addFailedPage($page): self
69
    {
70 2
        $this->failedPages[] = $page;
71
72 2
        return $this;
73
    }
74
75
    /**
76
     * Retrieve and unset the failed pages
77
     *
78
     * @return array
79
     */
80 12
    public function pullFailedPages(): array
81
    {
82 12
        $failedPages = $this->failedPages;
83
84 12
        $this->failedPages = [];
85
86 12
        return $failedPages;
87
    }
88
}
89