CrawlerDetect::setUserAgent() - Code Metrics - Inspection of "Proof of concept for IP checking" - JayBizzle/Crawler-Detect - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#189)

by Mark

created 2017-04-24 21:55 UTC

CrawlerDetect::setUserAgent() B

↳ Parent: Project

Complexity

Conditions	5
Paths	7

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	15
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	9
nc	7
nop	1

<?php

/*
 * This file is part of Crawler Detect - the web crawler detection library.
 *
 * (c) Mark Beech <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Jaybizzle\CrawlerDetect;

use Jaybizzle\CrawlerDetect\Detectors\IpDetector;
use Jaybizzle\CrawlerDetect\Detectors\AgentDetector;

class CrawlerDetect
{
    /**
     * Check agent setting.
     *
     * @var null|bool
     */
    protected $checkAgent = null;

    /**
     * Check IP setting.
     * 
     * @var null|bool
     */
    protected $checkIp = null;

    /**
     * Array of detectors.
     * 
     * @var array
     */
    protected $detectors = array();

    /**
     * Check the user agent.
     * 
     * @return $this
     */
    public function agent($userAgent = null)
    {
        $this->checkAgent = true;

        if (! isset($detectors['agent'])) {

            $this->detectors['agent'] = new AgentDetector($userAgent);
        }

        return $this;
    }

    /**
     * Check the IP address.
     * 
     * @return $this
     */
    public function ip($userIp)
    {
        $this->checkIp = true;

        if (! isset($detectors['ip'])) {

            $this->detectors['ip'] = new IpDetector($userIp);
        }

        return $this;
    }

    /**
     * Check user agent string against the regex.
     *
     * @param string|null $userAgent
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return bool
     */
    public function isCrawler()
    {
        if ($this->checkAgent && ! $this->checkIp) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
            return $this->detectors['agent']->check();
        }

        if ($this->checkIp && ! $this->checkAgent) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
            return $this->detectors['ip']->check();
        }

        if (is_null($this->checkIp) && is_null($this->checkAgent)) {
            $this->ip()->agent();


            return $this->detectors['agent']->check() && $this->detectors['ip']->check();
        }
    }

    /**
     * Return the matches.
     *
     * @return string|null
     */
    public function getMatches()
    {
        return isset($this->matches[0]) ? $this->matches[0] : null;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }
}


1			<?php
2
3			/*
4			* This file is part of Crawler Detect - the web crawler detection library.
5			*
6			* (c) Mark Beech <[email protected]>
7			*
8			* This source file is subject to the MIT license that is bundled
9			* with this source code in the file LICENSE.
10			*/
11
12			namespace Jaybizzle\CrawlerDetect;
13
14			use Jaybizzle\CrawlerDetect\Detectors\IpDetector;
15			use Jaybizzle\CrawlerDetect\Detectors\AgentDetector;
16
17			class CrawlerDetect
18			{
19			/**
20			* Check agent setting.
21			*
22			* @var null\|bool
23			*/
24			protected $checkAgent = null;
25
26			/**
27			* Check IP setting.
28			*
29			* @var null\|bool
30			*/
31			protected $checkIp = null;
32
33			/**
34			* Array of detectors.
35			*
36			* @var array
37			*/
38			protected $detectors = array();
39
40			/**
41			* Check the user agent.
42			*
43			* @return $this
44			*/
45			public function agent($userAgent = null)
46			{
47			$this->checkAgent = true;
48
49			if (! isset($detectors['agent'])) {
			0 ignored issues – show Bug introduced 2017-04-24 21:20 UTC by Report Bug Copy Issue Report The variable `$detectors` seems to never exist, and therefore `isset` should always return `false`. Did you maybe rename this variable? This check looks for calls to `isset(...)` or `empty()` on variables that are yet undefined. These calls will always produce the same result and can be removed. This is most likely caused by the renaming of a variable or the removal of a function/method parameter. Loading history...
50			$this->detectors['agent'] = new AgentDetector($userAgent);
51			}
52
53			return $this;
54			}
55
56			/**
57			* Check the IP address.
58			*
59			* @return $this
60			*/
61			public function ip($userIp)
62			{
63			$this->checkIp = true;
64
65			if (! isset($detectors['ip'])) {
			0 ignored issues – show Bug introduced 2017-04-24 21:20 UTC by Report Bug Copy Issue Report The variable `$detectors` seems to never exist, and therefore `isset` should always return `false`. Did you maybe rename this variable? This check looks for calls to `isset(...)` or `empty()` on variables that are yet undefined. These calls will always produce the same result and can be removed. This is most likely caused by the renaming of a variable or the removal of a function/method parameter. Loading history...
66			$this->detectors['ip'] = new IpDetector($userIp);
67			}
68
69			return $this;
70			}
71
72			/**
73			* Check user agent string against the regex.
74			*
75			* @param string\|null $userAgent
			0 ignored issues – show Bug introduced 2017-04-24 19:50 UTC by Report Bug Copy Issue Report There is no parameter named `$userAgent`. 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...
76			*
77			* @return bool
78			*/
79			public function isCrawler()
80			{
81			if ($this->checkAgent && ! $this->checkIp) {
			0 ignored issues – show Bug Best Practice introduced 2017-04-24 22:15 UTC by Report Bug Copy Issue Report The expression `$this->checkIp` of type `null\|boolean` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
82			return $this->detectors['agent']->check();
83			}
84
85			if ($this->checkIp && ! $this->checkAgent) {
			0 ignored issues – show Bug Best Practice introduced 2017-04-24 22:15 UTC by Report Bug Copy Issue Report The expression `$this->checkAgent` of type `null\|boolean` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
86			return $this->detectors['ip']->check();
87			}
88
89			if (is_null($this->checkIp) && is_null($this->checkAgent)) {
90			$this->ip()->agent();
			0 ignored issues – show Bug introduced 2017-04-24 21:20 UTC by Report Bug Copy Issue Report The call to `ip()` misses a required argument `$userIp`. This check looks for function calls that miss required arguments. Loading history...
91
92			return $this->detectors['agent']->check() && $this->detectors['ip']->check();
93			}
94			}
95
96			/**
97			* Return the matches.
98			*
99			* @return string\|null
100			*/
101			public function getMatches()
102			{
103			return isset($this->matches[0]) ? $this->matches[0] : null;
			0 ignored issues – show Bug introduced 2017-04-24 21:20 UTC by Report Bug Copy Issue Report The property `matches` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
104			}
105			}
106

JayBizzle / Crawler-Detect

Pull Request — master (#189)

CrawlerDetect::setUserAgent() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like