Url::__toString() - Code Metrics - Inspection of "Merge pull request #15 from mjrider/test-fixes" - Ariadne-CMS/arc-web - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b1d97d...db6a3a )

by Robbert

created 2016-01-12 13:17 UTC

Url::__toString() B

↳ Parent: Url

Complexity

Conditions	6
Paths	7

Size

Total Lines	18
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	6

Importance

Changes	9
Bugs	4	Features	3

Metric	Value
c	9
b	4
f	3
dl	0
loc	18
ccs	12
cts	12
cp	1
rs	8.8571
cc	6
eloc	15
nc	7
nop	0
crap	6

<?php

/*
 * This file is part of the Ariadne Component Library.
 *
 * (c) Muze <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace arc\url;

/**
 *	Url parses a URL string and returns an object with the seperate parts. You can change
 *	these and when cast to a string Url will regenerate the URL string and make sure it
 *	is valid.
 *
 *	Usage:
 *		$url = new \arc\url\Url( 'http://www.ariadne-cms.org/' );
 *		$url->path = '/docs/search/';
 *		$url->query = 'a=1&a=2';
 *		echo $url; // => 'http://www.ariadne-cms.org/docs/search/?a=1&a=2'
 */
class Url
{
    /**
     *	All parts of the URL format, as returned by parse_url.
     *	scheme://user:pass@host:port/path?query#fragment
     */
    public $scheme, $user, $pass, $host, $port, $path, $fragment;
    private $query;

    /**
     *	@param string $url The URL to parse, the query part will remain a string.
     *  @param QueryInterface queryObject Optional. An object that parses the query string.
     */
    public function __construct($url, $queryObject = null)
    {
        $componentList = [
            'scheme', 'host', 'port', 'user', 'pass', 'path', 'query', 'fragment'
        ];
        $this->importUrlComponents( parse_url( $url ), $componentList );
        if ( isset( $queryObject ) ) {
            $this->query = $queryObject->import( $this->query );
        }
    }

    /**
     * @return string
     */
    public function __toString()
    {
        switch ($this->scheme) {
            case 'file':
                return $this->getScheme() . '//' . $this->host . $this->getFilePath();
            break;
            case 'mailto':
            case 'news':
                return ( $this->path ? $this->getScheme() . $this->getPath() : '' );
            break;
            case 'ldap':
                return $this->getSchemeAndAuthority() . $this->getPath() . $this->getLdapQuery();
            break;
            default:
                return $this->getSchemeAndAuthority() . $this->getPath() . $this->getQuery() . $this->getFragment();
            break;
        }
    }

    /**
     * @param $name
     * @return mixed
     */
    public function __get($name)
    {
        switch ( (string) $name ) {
            case 'password':
                return $this->pass;
            break;
            case 'query':
                return $this->query;
            break;
        }
    }

    /**
     * @param $name
     * @param $value
     */
    public function __set($name, $value)
    {
        switch ( (string) $name ) {
            case 'password':
                $this->pass = $value;
            break;
            case 'query':
                if ( is_object( $this->query ) ) {
                    $this->query->reset()->import( $value );
                } else {
                    $this->query = $value;
                }
            break;
        }
    }

    /**
     *
     */
    public function __clone()
    {
        if ( is_object( $this->query ) ) {
            $this->query = clone $this->query;
        }
    }

    /**
     * @param $components
     * @param $validComponents
     */
    private function importUrlComponents($components, $validComponents)
    {
        array_walk( $validComponents, function ($componentName) use ($components) {
            $this->{$componentName} = ( isset( $components[$componentName] ) ? $components[$componentName] : '' );
        } );
    }

    /**
     * @return string
     */
    private function getSchemeAndAuthority()
    {
        // note: both '//google.com/' and 'file:///C:/' are valid URL's - so if either a scheme or host is set, add the // part
        return ( ( $this->scheme || $this->host ) ? $this->getScheme() . $this->getAuthority() : '' );
    }

    /**
     * @return string
     */
    private function getScheme()
    {
        return ( $this->scheme ? $this->scheme . ':' : '' );
    }

    /**
     * @return string
     */
    private function getAuthority()
    {
        return ( $this->host ? '//' . $this->getUser() . $this->host . $this->getPort() : '' );
    }

    /**
     * @return string
     */
    private function getUser()
    {
        return ( $this->user ? rawurlencode( $this->user ) . $this->getPassword() . '@' : '' );
    }

    /**
     * @return string
     */
    private function getPassword()
    {
        return ( $this->user && $this->pass ?  ':' . rawurlencode( $this->pass ) : '' );
    }

    /**
     * @return string
     */
    private function getPort()
    {
        return ( $this->port ? ':' . (int) $this->port : '' );
    }

    /**
     * @return mixed|string
     */
    private function getPath()
    {
        if (!$this->path) {
            return '';
        }
        $path = $this->path;
        if ( $this->host && ( !$path || $path[0] !== '/' ) ) {
            // note: if a host is set, the path _must_ be made absolute or the URL will be invalid
            $path = '/' . $path;
        }
        // urlencode encodes too many characters for the path part, so we decode them back to get readable urls.
        return str_replace( [ '%3D', '%2B', '%3A', '%40' ], [ '=', '+', ':', '@' ], join( '/', array_map( 'urlencode', explode( '/', $path ) ) ) );
    }

    /**
     * @return mixed|string
     */
    private function getFilePath()
    {
        // in the file: scheme, a path must start with a '/' even if no host is set. This contradicts with the email: scheme.
        $path = $this->getPath();
        if ($path && $path[0]!=='/') {
            $path = '/' . $path;
        }

        return $path;
    }

    /**
     * @return string
     */
    private function getQuery()
    {
        // queries are assumed to handle themselves, so no encoding here.
        $query = (string) $this->query; // convert explicitly to string first, because the query object may exist but still return an empty string

        return ( $query ? '?' . $query : '' );
    }

    /**
     * @return string
     */
    private function getLdapQuery()
    {
        // ldap queries may contain multiple ? tokens - so these are unencoded here.
        $query = (string) $this->query; // convert explicitly to string first, because the query object may exist but still return an empty string

        return ( $query ? '?' . str_replace( '%3F', '?', $query ) : '' );
    }

    /**
     * @return string
     */
    private function getFragment()
    {
        return ( $this->fragment ? '#' . urlencode($this->fragment) : '' );
    }

}


1		<?php
2
3		/*
4		* This file is part of the Ariadne Component Library.
5		*
6		* (c) Muze <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace arc\url;
13
14		/**
15		* Url parses a URL string and returns an object with the seperate parts. You can change
16		* these and when cast to a string Url will regenerate the URL string and make sure it
17		* is valid.
18		*
19		* Usage:
20		* $url = new \arc\url\Url( 'http://www.ariadne-cms.org/' );
21		* $url->path = '/docs/search/';
22		* $url->query = 'a=1&a=2';
23		* echo $url; // => 'http://www.ariadne-cms.org/docs/search/?a=1&a=2'
24		*/
25		class Url
26		{
27		/**
28		* All parts of the URL format, as returned by parse_url.
29		* scheme://user:pass@host:port/path?query#fragment
30		*/
31		public $scheme, $user, $pass, $host, $port, $path, $fragment;
32		private $query;
33
34		/**
35		* @param string $url The URL to parse, the query part will remain a string.
36		* @param QueryInterface queryObject Optional. An object that parses the query string.
37		*/
38	14	public function __construct($url, $queryObject = null)
39		{
40		$componentList = [
41	14	'scheme', 'host', 'port', 'user', 'pass', 'path', 'query', 'fragment'
42	14	];
43	14	$this->importUrlComponents( parse_url( $url ), $componentList );
44	14	if ( isset( $queryObject ) ) {
45	14	$this->query = $queryObject->import( $this->query );
46	14	}
47	14	}
48
49		/**
50		* @return string
51		*/
52	12	public function __toString()
53		{
54	12	switch ($this->scheme) {
55	12	case 'file':
56	1	return $this->getScheme() . '//' . $this->host . $this->getFilePath();
57		break;
58	12	case 'mailto':
59	12	case 'news':
60	1	return ( $this->path ? $this->getScheme() . $this->getPath() : '' );
61		break;
62	12	case 'ldap':
63	1	return $this->getSchemeAndAuthority() . $this->getPath() . $this->getLdapQuery();
64		break;
65	12	default:
66	12	return $this->getSchemeAndAuthority() . $this->getPath() . $this->getQuery() . $this->getFragment();
67		break;
68	12	}
69		}
70
71		/**
72		* @param $name
73		* @return mixed
74		*/
75	5	public function __get($name)
76		{
77	5	switch ( (string) $name ) {
78	5	case 'password':
79		return $this->pass;
80		break;
81	5	case 'query':
82	5	return $this->query;
83		break;
84		}
85		}
86
87		/**
88		* @param $name
89		* @param $value
90		*/
91		public function __set($name, $value)
92		{
93		switch ( (string) $name ) {
94		case 'password':
95		$this->pass = $value;
96		break;
97		case 'query':
98		if ( is_object( $this->query ) ) {
99		$this->query->reset()->import( $value );
100		} else {
101		$this->query = $value;
102		}
103		break;
104		}
105		}
106
107		/**
108		*
109		*/
110		public function __clone()
111		{
112		if ( is_object( $this->query ) ) {
113		$this->query = clone $this->query;
114		}
115		}
116
117		/**
118		* @param $components
119		* @param $validComponents
120		*/
121		private function importUrlComponents($components, $validComponents)
122		{
123	14	array_walk( $validComponents, function ($componentName) use ($components) {
124	14	$this->{$componentName} = ( isset( $components[$componentName] ) ? $components[$componentName] : '' );
125	14	} );
126	14	}
127
128		/**
129		* @return string
130		*/
131	12	private function getSchemeAndAuthority()
132		{
133		// note: both '//google.com/' and 'file:///C:/' are valid URL's - so if either a scheme or host is set, add the // part
134	12	return ( ( $this->scheme \|\| $this->host ) ? $this->getScheme() . $this->getAuthority() : '' );
135		}
136
137		/**
138		* @return string
139		*/
140	10	private function getScheme()
141		{
142	10	return ( $this->scheme ? $this->scheme . ':' : '' );
143		}
144
145		/**
146		* @return string
147		*/
148	10	private function getAuthority()
149		{
150	10	return ( $this->host ? '//' . $this->getUser() . $this->host . $this->getPort() : '' );
151		}
152
153		/**
154		* @return string
155		*/
156	10	private function getUser()
157		{
158	10	return ( $this->user ? rawurlencode( $this->user ) . $this->getPassword() . '@' : '' );
159		}
160
161		/**
162		* @return string
163		*/
164	1	private function getPassword()
165		{
166	1	return ( $this->user && $this->pass ? ':' . rawurlencode( $this->pass ) : '' );
167		}
168
169		/**
170		* @return string
171		*/
172	10	private function getPort()
173		{
174	10	return ( $this->port ? ':' . (int) $this->port : '' );
175		}
176
177		/**
178		* @return mixed\|string
179		*/
180	12	private function getPath()
181		{
182	12	if (!$this->path) {
183	1	return '';
184		}
185	12	$path = $this->path;
186	12	if ( $this->host && ( !$path \|\| $path[0] !== '/' ) ) {
187		// note: if a host is set, the path _must_ be made absolute or the URL will be invalid
188		$path = '/' . $path;
189		}
190		// urlencode encodes too many characters for the path part, so we decode them back to get readable urls.
191	12	return str_replace( [ '%3D', '%2B', '%3A', '%40' ], [ '=', '+', ':', '@' ], join( '/', array_map( 'urlencode', explode( '/', $path ) ) ) );
192		}
193
194		/**
195		* @return mixed\|string
196		*/
197	1	private function getFilePath()
198		{
199		// in the file: scheme, a path must start with a '/' even if no host is set. This contradicts with the email: scheme.
200	1	$path = $this->getPath();
201	1	if ($path && $path[0]!=='/') {
202	1	$path = '/' . $path;
203	1	}
204
205	1	return $path;
206		}
207
208		/**
209		* @return string
210		*/
211	12	private function getQuery()
212		{
213		// queries are assumed to handle themselves, so no encoding here.
214	12	$query = (string) $this->query; // convert explicitly to string first, because the query object may exist but still return an empty string
215
216	12	return ( $query ? '?' . $query : '' );
217		}
218
219		/**
220		* @return string
221		*/
222	1	private function getLdapQuery()
223		{
224		// ldap queries may contain multiple ? tokens - so these are unencoded here.
225	1	$query = (string) $this->query; // convert explicitly to string first, because the query object may exist but still return an empty string
226
227	1	return ( $query ? '?' . str_replace( '%3F', '?', $query ) : '' );
228		}
229
230		/**
231		* @return string
232		*/
233	12	private function getFragment()
234		{
235	12	return ( $this->fragment ? '#' . urlencode($this->fragment) : '' );
236		}
237
238		}
239

Ariadne-CMS / arc-web

Push — master ( b1d97d...db6a3a )

Url::__toString() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like