Completed
Pull Request — master (#29)
by Andreas
01:58
created

IconParser::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 5
rs 9.4285
cc 1
eloc 3
nc 1
nop 1
1
<?php
2
/**
3
 * Copyright (c) Andreas Heigl<[email protected]>
4
 *
5
 * Permission is hereby granted, free of charge, to any person obtaining a copy
6
 * of this software and associated documentation files (the "Software"), to deal
7
 * in the Software without restriction, including without limitation the rights
8
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
 * copies of the Software, and to permit persons to whom the Software is
10
 * furnished to do so, subject to the following conditions:
11
 *
12
 * The above copyright notice and this permission notice shall be included in
13
 * all copies or substantial portions of the Software.
14
 *
15
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
 * THE SOFTWARE.
22
 *
23
 * @author    Andreas Heigl<[email protected]>
24
 * @copyright Andreas Heigl
25
 * @license   http://www.opensource.org/licenses/mit-license.php MIT-License
26
 * @since     31.01.2017
27
 * @link      http://github.com/heiglandreas/callingallpapers
28
 */
29
30
namespace Callingallpapers\Parser;
31
32
use GuzzleHttp\Client;
33
34
class IconParser
35
{
36
    private $client;
37
38
    private $dom;
39
40
    public function __construct(Client $client)
41
    {
42
        $this->client = $client;
43
        $this->dom = new \DOMDocument('1.0', 'UTF-8');
44
    }
45
46
    /**
47
     * This parser tries to identify the URI for an icon for the given Event
48
     *
49
     * For that we parse the websites sourcecode and try to find an icon.
50
     *
51
     * The URI to that Icon is then returned.
52
     *
53
     * @param string $url The URI of the event-page
0 ignored issues
show
Bug introduced by
There is no parameter named $url. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
54
     *
55
     * @throws \Exception should no Icon be retrievable
56
     * @return string
57
     */
58
    public function parse($eventPageUri)
59
    {
60
        $result = $this->client->get($eventPageUri);
61
62
        $this->dom->loadHTML($result->getBody()->getContents());
63
64
        $xpath = new \DOMXPath($this->dom);
65
66
        if ($icon = $this->getIcon($xpath)) {
0 ignored issues
show
Bug introduced by
Are you sure the assignment to $icon is correct as $this->getIcon($xpath) (which targets Callingallpapers\Parser\IconParser::getIcon()) seems to always return null.

This check looks for function or method calls that always return null and whose return value is assigned to a variable.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

The method getObject() can return nothing but null, so it makes no sense to assign that value to a variable.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
67
            return $icon;
68
        }
69
70
        return $icon;
71
    }
72
73
    public function getIcon($xpath)
74
    {
75
        $icons = $xpath->query('icon');
0 ignored issues
show
Unused Code introduced by
$icons is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
76
    }
77
}
78