Port::getPort() - Code Metrics - Inspection of "DLMN-9 added Port::getPort to retrieve raw port da..." - twistofreality/dilmun - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 35abb3...8654c8 )

by Derek

created 2017-03-19 00:50 UTC

Port::getPort() A

↳ Parent: Port

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php
namespace Subreality\Dilmun\Anshar\Http\UriParts;

use Subreality\Dilmun\Anshar\Http\SchemePortsTrait;
use Subreality\Dilmun\Anshar\Utils\ArrayHelper;

/**
 * Class Port
 * @package Subreality\Dilmun\Anshar\Http\UriParts
 */
class Port implements UriPartInterface
{
    use SchemePortsTrait;

    protected $port = null;

    protected static $part_pattern  = '[0-9]{0,4}';
    protected static $valid_pattern = '/^[0-9]{0,4}$/';

    /**
     * Port constructor. Accepts an integer or null value representing a URI port component. Construction will throw an
     * exception if port is not an integer or is not null or if the given integer is outside of the allowed TCP/UDP
     * range of 1 to 65535.
     *
     * port = *DIGIT
     *
     * @see https://tools.ietf.org/html/rfc3986#appendix-A
     *
     * @throws \InvalidArgumentException if the given port is not an integer or null or if the given integer is out of
     * range
     *
     * @param int|null $port    A string representing a URI port
     */
    public function __construct($port)
    {
        if (!is_int($port) && !is_null($port)) {
            throw new \InvalidArgumentException("Port must be an integer or null");
        } elseif (!self::isValid($port)) {
            throw new \InvalidArgumentException("Port must be between 1 and 65535 inclusive");
        }

        $this->port = $port;
    }

    /**
     * Returns a string representation of the port.
     *
     * @return string   The string representation of the port
     */
    public function __toString()
    {
        return (string) $this->port;
    }

    /**
     * Returns the raw port data
     *
     * @return int|null
     */
    public function getPort()
    {
        return $this->port;
    }

    /**
     * Returns a string representing a valid pattern for a URI port
     *
     * @return string
     */
    public static function getValidPattern()
    {
        return self::$part_pattern;
    }

    /**
     * Validates a given port. A port is valid if it is either null or an integer between 1 and 65535 inclusive.
     *
     * @param mixed $port   The port to be validated
     * @return bool         Returns true if the given port is valid
     *                      Returns false otherwise
     */
    public static function isValid($port)
    {
        $port_valid = false;

        if (is_int($port)) {
            $port_valid = self::portIsInValidRange($port);
        } elseif (is_null($port)) {
            $port_valid = true;
        }

        return $port_valid;
    }

    /**
     * Returns a string representation of the port formatted so that it can be compiled into a complete URI string
     * per the Uri object's string specification.
     *
     * If the port is empty, toUriString returns an empty string; if the port is not empty, toUriString returns the
     * port prefixed with a colon.
     *
     * toUriString will also check the port against an optionally-provided scheme; if the port is standard for the given
     * scheme, toUriString returns an empty string.
     *
     * @see Uri::__toString
     *
     * @param Scheme|null $scheme   [optional] A scheme against which to check if the port is the standard
     *
     * @return string               A string representation of the port formatted for a complete URI string
     */
    public function toUriString(Scheme $scheme = null)
    {
        $normalized_port = $this->normalizePortAgainstScheme($scheme);

        $uri_string = (string) $normalized_port;

        if (!is_null($normalized_port)) {
            $uri_string = ":" . $uri_string;
        }

        return $uri_string;
    }

    /**
     * Normalizes the port against a given scheme so that the scheme is reported as null if the port is standard for the
     * scheme.
     *
     * For example, given a http scheme and a port of 80, the normalized port will be reported as null; given a https
     * scheme and a port of 80, the normalized port will be reported as 80.
     *
     * @see Port::toUriString()
     * @see SchemePortsTrait
     *
     * @param Scheme|null $scheme
     * @return int|null
     */
    public function normalizePortAgainstScheme(Scheme $scheme = null)
    {
        $scheme_port_array = new ArrayHelper($this->scheme_ports);
        $scheme_string     = (string) $scheme;

        $standard_port = $scheme_port_array->valueLookup($scheme_string);

        if ($this->port == $standard_port) {
            $normalized_port = null;
        } else {
            $normalized_port = $this->port;
        }

        return $normalized_port;
    }

    /**
     * Validates whether a given port falls within the range of valid ports for TCP/UDP (1 to 65535)
     *
     * @param int $port The port to be validated
     *
     * @return bool     Returns true if the port falls within the valid range
     *                  Returns false otherwise
     */
    private static function portIsInValidRange($port)
    {
        if ($port > 0 && $port < 65536) {
            return true;
        } else {
            return false;
        }
    }
}


1		<?php
2		namespace Subreality\Dilmun\Anshar\Http\UriParts;
3
4		use Subreality\Dilmun\Anshar\Http\SchemePortsTrait;
5		use Subreality\Dilmun\Anshar\Utils\ArrayHelper;
6
7		/**
8		* Class Port
9		* @package Subreality\Dilmun\Anshar\Http\UriParts
10		*/
11		class Port implements UriPartInterface
12		{
13		use SchemePortsTrait;
14
15		protected $port = null;
16
17		protected static $part_pattern = '[0-9]{0,4}';
18		protected static $valid_pattern = '/^[0-9]{0,4}$/';
19
20		/**
21		* Port constructor. Accepts an integer or null value representing a URI port component. Construction will throw an
22		* exception if port is not an integer or is not null or if the given integer is outside of the allowed TCP/UDP
23		* range of 1 to 65535.
24		*
25		* port = *DIGIT
26		*
27		* @see https://tools.ietf.org/html/rfc3986#appendix-A
28		*
29		* @throws \InvalidArgumentException if the given port is not an integer or null or if the given integer is out of
30		* range
31		*
32		* @param int\|null $port A string representing a URI port
33		*/
34	112	public function __construct($port)
35		{
36	112	if (!is_int($port) && !is_null($port)) {
37	6	throw new \InvalidArgumentException("Port must be an integer or null");
38	106	} elseif (!self::isValid($port)) {
39	4	throw new \InvalidArgumentException("Port must be between 1 and 65535 inclusive");
40		}
41
42	102	$this->port = $port;
43	102	}
44
45		/**
46		* Returns a string representation of the port.
47		*
48		* @return string The string representation of the port
49		*/
50	5	public function __toString()
51		{
52	5	return (string) $this->port;
53		}
54
55		/**
56		* Returns the raw port data
57		*
58		* @return int\|null
59		*/
60	2	public function getPort()
61		{
62	2	return $this->port;
63		}
64
65		/**
66		* Returns a string representing a valid pattern for a URI port
67		*
68		* @return string
69		*/
70	17	public static function getValidPattern()
71		{
72	17	return self::$part_pattern;
73		}
74
75		/**
76		* Validates a given port. A port is valid if it is either null or an integer between 1 and 65535 inclusive.
77		*
78		* @param mixed $port The port to be validated
79		* @return bool Returns true if the given port is valid
80		* Returns false otherwise
81		*/
82	111	public static function isValid($port)
83		{
84	111	$port_valid = false;
85
86	111	if (is_int($port)) {
87	46	$port_valid = self::portIsInValidRange($port);
88	111	} elseif (is_null($port)) {
89	65	$port_valid = true;
90	65	}
91
92	111	return $port_valid;
93		}
94
95		/**
96		* Returns a string representation of the port formatted so that it can be compiled into a complete URI string
97		* per the Uri object's string specification.
98		*
99		* If the port is empty, toUriString returns an empty string; if the port is not empty, toUriString returns the
100		* port prefixed with a colon.
101		*
102		* toUriString will also check the port against an optionally-provided scheme; if the port is standard for the given
103		* scheme, toUriString returns an empty string.
104		*
105		* @see Uri::__toString
106		*
107		* @param Scheme\|null $scheme [optional] A scheme against which to check if the port is the standard
108		*
109		* @return string A string representation of the port formatted for a complete URI string
110		*/
111	12	public function toUriString(Scheme $scheme = null)
112		{
113	12	$normalized_port = $this->normalizePortAgainstScheme($scheme);
114
115	12	$uri_string = (string) $normalized_port;
116
117	12	if (!is_null($normalized_port)) {
118	7	$uri_string = ":" . $uri_string;
119	7	}
120
121	12	return $uri_string;
122		}
123
124		/**
125		* Normalizes the port against a given scheme so that the scheme is reported as null if the port is standard for the
126		* scheme.
127		*
128		* For example, given a http scheme and a port of 80, the normalized port will be reported as null; given a https
129		* scheme and a port of 80, the normalized port will be reported as 80.
130		*
131		* @see Port::toUriString()
132		* @see SchemePortsTrait
133		*
134		* @param Scheme\|null $scheme
135		* @return int\|null
136		*/
137	16	public function normalizePortAgainstScheme(Scheme $scheme = null)
138		{
139	16	$scheme_port_array = new ArrayHelper($this->scheme_ports);
140	16	$scheme_string = (string) $scheme;
141
142	16	$standard_port = $scheme_port_array->valueLookup($scheme_string);
143
144	16	if ($this->port == $standard_port) {
145	8	$normalized_port = null;
146	8	} else {
147	8	$normalized_port = $this->port;
148		}
149
150	16	return $normalized_port;
151		}
152
153		/**
154		* Validates whether a given port falls within the range of valid ports for TCP/UDP (1 to 65535)
155		*
156		* @param int $port The port to be validated
157		*
158		* @return bool Returns true if the port falls within the valid range
159		* Returns false otherwise
160		*/
161	46	private static function portIsInValidRange($port)
162		{
163	46	if ($port > 0 && $port < 65536) {
164	40	return true;
165		} else {
166	6	return false;
167		}
168		}
169		}
170

twistofreality / dilmun

Push — master ( 35abb3...8654c8 )

Port::getPort() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like