UrlManipulator::getParamsAsArray() - Code Metrics - Inspection of "Removed "Facebook" prefix form all classes" - facebook/php-graph-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#888)

by Yassine

created 2017-12-05 12:07 UTC

UrlManipulator::getParamsAsArray() A

↳ Parent: UrlManipulator

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes

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

<?php
/**
 * Copyright 2017 Facebook, Inc.
 *
 * You are hereby granted a non-exclusive, worldwide, royalty-free license to
 * use, copy, modify, and distribute this software in source code or binary
 * form for use in connection with the web services and APIs provided by
 * Facebook.
 *
 * As with any software that integrates with the Facebook platform, your use
 * of this software is subject to the Facebook Developer Principles and
 * Policies [http://developers.facebook.com/policy/]. This copyright notice
 * shall be included in all copies or substantial portions of the software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
namespace Facebook\Url;

/**
 * @package Facebook
 */
class UrlManipulator
{
    /**
     * Remove params from a URL.
     *
     * @param string $url            the URL to filter
     * @param array  $paramsToFilter the params to filter from the URL
     *
     * @return string the URL with the params removed
     */
    public static function removeParamsFromUrl($url, array $paramsToFilter)
    {
        $parts = parse_url($url);

        $query = '';
        if (isset($parts['query'])) {
            $params = [];
            parse_str($parts['query'], $params);

            // Remove query params
            foreach ($paramsToFilter as $paramName) {
                unset($params[$paramName]);
            }

            if (count($params) > 0) {
                $query = '?' . http_build_query($params, null, '&');
            }
        }

        $scheme = isset($parts['scheme']) ? $parts['scheme'] . '://' : '';
        $host = isset($parts['host']) ? $parts['host'] : '';
        $port = isset($parts['port']) ? ':' . $parts['port'] : '';
        $path = isset($parts['path']) ? $parts['path'] : '';
        $fragment = isset($parts['fragment']) ? '#' . $parts['fragment'] : '';

        return $scheme . $host . $port . $path . $query . $fragment;
    }

    /**
     * Gracefully appends params to the URL.
     *
     * @param string $url       the URL that will receive the params
     * @param array  $newParams the params to append to the URL
     *
     * @return string
     */
    public static function appendParamsToUrl($url, array $newParams = [])
    {
        if (empty($newParams)) {
            return $url;
        }

        if (strpos($url, '?') === false) {
            return $url . '?' . http_build_query($newParams, null, '&');
        }

        list($path, $query) = explode('?', $url, 2);
        $existingParams = [];
        parse_str($query, $existingParams);

        // Favor params from the original URL over $newParams
        $newParams = array_merge($newParams, $existingParams);

        // Sort for a predicable order
        ksort($newParams);

        return $path . '?' . http_build_query($newParams, null, '&');
    }

    /**
     * Returns the params from a URL in the form of an array.
     *
     * @param string $url the URL to parse the params from
     *
     * @return array
     */
    public static function getParamsAsArray($url)
    {
        $query = parse_url($url, PHP_URL_QUERY);
        if (!$query) {
            return [];
        }
        $params = [];
        parse_str($query, $params);

        return $params;
    }

    /**
     * Adds the params of the first URL to the second URL.
     *
     * Any params that already exist in the second URL will go untouched.
     *
     * @param string $urlToStealFrom the URL harvest the params from
     * @param string $urlToAddTo     the URL that will receive the new params
     *
     * @return string the $urlToAddTo with any new params from $urlToStealFrom
     */
    public static function mergeUrlParams($urlToStealFrom, $urlToAddTo)
    {
        $newParams = static::getParamsAsArray($urlToStealFrom);
        // Nothing new to add, return as-is
        if (!$newParams) {

            return $urlToAddTo;
        }

        return static::appendParamsToUrl($urlToAddTo, $newParams);
    }

    /**
     * Check for a "/" prefix and prepend it if not exists.
     *
     * @param null|string $string
     *
     * @return string
     */
    public static function forceSlashPrefix($string)
    {
        if (!$string) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return '';
        }

        return strpos($string, '/') === 0 ? $string : '/' . $string;
    }

    /**
     * Trims off the hostname and Graph version from a URL.
     *
     * @param string $urlToTrim the URL the needs the surgery
     *
     * @return string the $urlToTrim with the hostname and Graph version removed
     */
    public static function baseGraphUrlEndpoint($urlToTrim)
    {
        return '/' . preg_replace('/^https:\/\/.+\.facebook\.com(\/v.+?)?\//', '', $urlToTrim);
    }
}


1		<?php
2		/**
3		* Copyright 2017 Facebook, Inc.
4		*
5		* You are hereby granted a non-exclusive, worldwide, royalty-free license to
6		* use, copy, modify, and distribute this software in source code or binary
7		* form for use in connection with the web services and APIs provided by
8		* Facebook.
9		*
10		* As with any software that integrates with the Facebook platform, your use
11		* of this software is subject to the Facebook Developer Principles and
12		* Policies [http://developers.facebook.com/policy/]. This copyright notice
13		* shall be included in 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
18		* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20		* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21		* DEALINGS IN THE SOFTWARE.
22		*/
23		namespace Facebook\Url;
24
25		/**
26		* @package Facebook
27		*/
28		class UrlManipulator
29		{
30		/**
31		* Remove params from a URL.
32		*
33		* @param string $url the URL to filter
34		* @param array $paramsToFilter the params to filter from the URL
35		*
36		* @return string the URL with the params removed
37		*/
38	102	public static function removeParamsFromUrl($url, array $paramsToFilter)
39		{
40	102	$parts = parse_url($url);
41
42	102	$query = '';
43	102	if (isset($parts['query'])) {
44	37	$params = [];
45	37	parse_str($parts['query'], $params);
46
47		// Remove query params
48	37	foreach ($paramsToFilter as $paramName) {
49	37	unset($params[$paramName]);
50		}
51
52	37	if (count($params) > 0) {
53	35	$query = '?' . http_build_query($params, null, '&');
54		}
55		}
56
57	102	$scheme = isset($parts['scheme']) ? $parts['scheme'] . '://' : '';
58	102	$host = isset($parts['host']) ? $parts['host'] : '';
59	102	$port = isset($parts['port']) ? ':' . $parts['port'] : '';
60	102	$path = isset($parts['path']) ? $parts['path'] : '';
61	102	$fragment = isset($parts['fragment']) ? '#' . $parts['fragment'] : '';
62
63	102	return $scheme . $host . $port . $path . $query . $fragment;
64		}
65
66		/**
67		* Gracefully appends params to the URL.
68		*
69		* @param string $url the URL that will receive the params
70		* @param array $newParams the params to append to the URL
71		*
72		* @return string
73		*/
74	15	public static function appendParamsToUrl($url, array $newParams = [])
75		{
76	15	if (empty($newParams)) {
77	1	return $url;
78		}
79
80	15	if (strpos($url, '?') === false) {
81	12	return $url . '?' . http_build_query($newParams, null, '&');
82		}
83
84	4	list($path, $query) = explode('?', $url, 2);
85	4	$existingParams = [];
86	4	parse_str($query, $existingParams);
87
88		// Favor params from the original URL over $newParams
89	4	$newParams = array_merge($newParams, $existingParams);
90
91		// Sort for a predicable order
92	4	ksort($newParams);
93
94	4	return $path . '?' . http_build_query($newParams, null, '&');
95		}
96
97		/**
98		* Returns the params from a URL in the form of an array.
99		*
100		* @param string $url the URL to parse the params from
101		*
102		* @return array
103		*/
104	96	public static function getParamsAsArray($url)
105		{
106	96	$query = parse_url($url, PHP_URL_QUERY);
107	96	if (!$query) {
108	67	return [];
109		}
110	30	$params = [];
111	30	parse_str($query, $params);
112
113	30	return $params;
114		}
115
116		/**
117		* Adds the params of the first URL to the second URL.
118		*
119		* Any params that already exist in the second URL will go untouched.
120		*
121		* @param string $urlToStealFrom the URL harvest the params from
122		* @param string $urlToAddTo the URL that will receive the new params
123		*
124		* @return string the $urlToAddTo with any new params from $urlToStealFrom
125		*/
126	4	public static function mergeUrlParams($urlToStealFrom, $urlToAddTo)
127		{
128	4	$newParams = static::getParamsAsArray($urlToStealFrom);
129		// Nothing new to add, return as-is
130	4	if (!$newParams) {
		0 ignored issues – show Bug Best Practice introduced 2017-12-04 21:02 UTC by Report Bug Copy Issue Report The expression `$newParams` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
131	2	return $urlToAddTo;
132		}
133
134	2	return static::appendParamsToUrl($urlToAddTo, $newParams);
135		}
136
137		/**
138		* Check for a "/" prefix and prepend it if not exists.
139		*
140		* @param null\|string $string
141		*
142		* @return string
143		*/
144	23	public static function forceSlashPrefix($string)
145		{
146	23	if (!$string) {
		0 ignored issues – show Bug Best Practice introduced 2017-12-04 21:02 UTC by Report Bug Copy Issue Report The expression `$string` of type `null\|string` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
147	17	return '';
148		}
149
150	23	return strpos($string, '/') === 0 ? $string : '/' . $string;
151		}
152
153		/**
154		* Trims off the hostname and Graph version from a URL.
155		*
156		* @param string $urlToTrim the URL the needs the surgery
157		*
158		* @return string the $urlToTrim with the hostname and Graph version removed
159		*/
160	4	public static function baseGraphUrlEndpoint($urlToTrim)
161		{
162	4	return '/' . preg_replace('/^https:\/\/.+\.facebook\.com(\/v.+?)?\//', '', $urlToTrim);
163		}
164		}
165

facebook / php-graph-sdk

Pull Request — master (#888)

UrlManipulator::getParamsAsArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like