IP::isValid() - Code Metrics - Inspection of "Add IP::isValid method" - jpkleemans/htaccess-firewall - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dc4eba...81c49b )

by Jan-Paul

created 2015-12-16 12:32 UTC

IP::isValid() A

↳ Parent: IP

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

namespace HtaccessFirewall\Host;

use HtaccessFirewall\Host\Exception\InvalidArgumentException;

class IP implements Host
{
    /**
     * @var string
     */
    private $value;

    /**
     * Initialize IP.
     *
     * @param $value
     *
     * @throws InvalidArgumentException
     */
    private function __construct($value)
    {
        if (!self::isValid($value)) {
            throw new InvalidArgumentException('The first parameter of IP must be a valid IP address.');
        }

        $this->value = $value;
    }

    /**
     * Create IP from string.
     *
     * @param $string
     *
     * @return IP
     */
    public static function fromString($string)
    {
        return new self($string);
    }

    /**
     * Create IP from current request.
     *
     * @return IP
     */
    public static function fromCurrentRequest()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        return new self($_SERVER['REMOTE_ADDR']);
    }

    /**
     * Check if string is a valid IP.
     *
     * @param string $value
     *
     * @return bool
     */
    public static function isValid($value)
    {
        return filter_var($value, FILTER_VALIDATE_IP) !== false;
    }

    /**
     * Compare equality with another Host.
     *
     * @param Host $other
     *
     * @return bool
     */
    public function equals(Host $other)
    {
        return $this->toString() === $other->toString();
    }

    /**
     * Get string representation of IP.
     *
     * @return string
     */
    public function toString()
    {
        return $this->value;
    }

    /**
     * Cast IP to string.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->toString();
    }
}


1			<?php
2
3			namespace HtaccessFirewall\Host;
4
5			use HtaccessFirewall\Host\Exception\InvalidArgumentException;
6
7			class IP implements Host
8			{
9			/**
10			* @var string
11			*/
12			private $value;
13
14			/**
15			* Initialize IP.
16			*
17			* @param $value
18			*
19			* @throws InvalidArgumentException
20			*/
21			private function __construct($value)
22			{
23			if (!self::isValid($value)) {
24			throw new InvalidArgumentException('The first parameter of IP must be a valid IP address.');
25			}
26
27			$this->value = $value;
28			}
29
30			/**
31			* Create IP from string.
32			*
33			* @param $string
34			*
35			* @return IP
36			*/
37			public static function fromString($string)
38			{
39			return new self($string);
40			}
41
42			/**
43			* Create IP from current request.
44			*
45			* @return IP
46			*/
47			public static function fromCurrentRequest()
			0 ignored issues – show Coding Style introduced 2015-12-11 13:46 UTC by Report Bug Copy Issue Report `fromCurrentRequest` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
48			{
49			return new self($_SERVER['REMOTE_ADDR']);
50			}
51
52			/**
53			* Check if string is a valid IP.
54			*
55			* @param string $value
56			*
57			* @return bool
58			*/
59			public static function isValid($value)
60			{
61			return filter_var($value, FILTER_VALIDATE_IP) !== false;
62			}
63
64			/**
65			* Compare equality with another Host.
66			*
67			* @param Host $other
68			*
69			* @return bool
70			*/
71			public function equals(Host $other)
72			{
73			return $this->toString() === $other->toString();
74			}
75
76			/**
77			* Get string representation of IP.
78			*
79			* @return string
80			*/
81			public function toString()
82			{
83			return $this->value;
84			}
85
86			/**
87			* Cast IP to string.
88			*
89			* @return string
90			*/
91			public function __toString()
92			{
93			return $this->toString();
94			}
95			}
96

jpkleemans / htaccess-firewall

Push — master ( dc4eba...81c49b )

IP::isValid() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like