FacebookUrlManipulator::mergeUrlParams() - Code Metrics - facebook/facebook-php-sdk-v4 - Measure and Improve Code Quality continuously with Scrutinizer

FacebookUrlManipulator::mergeUrlParams() A
last analyzed 2016-08-09 11:36 UTC

↳ Parent: FacebookUrlManipulator

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	5
nc	2
nop	2
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Copyright 2016 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;

/**
 * Class FacebookUrlManipulator
 *
 * @package Facebook
 */
class FacebookUrlManipulator
{
    /**
     * 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) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            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 string|null $string
     *
     * @return string|null
     */
    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 $string;
        }

        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 2016 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			*/
24			namespace Facebook\Url;
25
26			/**
27			* Class FacebookUrlManipulator
28			*
29			* @package Facebook
30			*/
31			class FacebookUrlManipulator
32			{
33			/**
34			* Remove params from a URL.
35			*
36			* @param string $url The URL to filter.
37			* @param array $paramsToFilter The params to filter from the URL.
38			*
39			* @return string The URL with the params removed.
40			*/
41			public static function removeParamsFromUrl($url, array $paramsToFilter)
42			{
43			$parts = parse_url($url);
44
45			$query = '';
46			if (isset($parts['query'])) {
47			$params = [];
48			parse_str($parts['query'], $params);
49
50			// Remove query params
51			foreach ($paramsToFilter as $paramName) {
52			unset($params[$paramName]);
53			}
54
55			if (count($params) > 0) {
56			$query = '?' . http_build_query($params, null, '&');
57			}
58			}
59
60			$scheme = isset($parts['scheme']) ? $parts['scheme'] . '://' : '';
61			$host = isset($parts['host']) ? $parts['host'] : '';
62			$port = isset($parts['port']) ? ':' . $parts['port'] : '';
63			$path = isset($parts['path']) ? $parts['path'] : '';
64			$fragment = isset($parts['fragment']) ? '#' . $parts['fragment'] : '';
65
66			return $scheme . $host . $port . $path . $query . $fragment;
67			}
68
69			/**
70			* Gracefully appends params to the URL.
71			*
72			* @param string $url The URL that will receive the params.
73			* @param array $newParams The params to append to the URL.
74			*
75			* @return string
76			*/
77			public static function appendParamsToUrl($url, array $newParams = [])
78			{
79			if (empty($newParams)) {
80			return $url;
81			}
82
83			if (strpos($url, '?') === false) {
84			return $url . '?' . http_build_query($newParams, null, '&');
85			}
86
87			list($path, $query) = explode('?', $url, 2);
88			$existingParams = [];
89			parse_str($query, $existingParams);
90
91			// Favor params from the original URL over $newParams
92			$newParams = array_merge($newParams, $existingParams);
93
94			// Sort for a predicable order
95			ksort($newParams);
96
97			return $path . '?' . http_build_query($newParams, null, '&');
98			}
99
100			/**
101			* Returns the params from a URL in the form of an array.
102			*
103			* @param string $url The URL to parse the params from.
104			*
105			* @return array
106			*/
107			public static function getParamsAsArray($url)
108			{
109			$query = parse_url($url, PHP_URL_QUERY);
110			if (!$query) {
			0 ignored issues – show Bug Best Practice introduced 2015-12-04 22:06 UTC by Report Bug Copy Issue Report The expression `$query` of type `string\|false` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== false` 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...
111			return [];
112			}
113			$params = [];
114			parse_str($query, $params);
115
116			return $params;
117			}
118
119			/**
120			* Adds the params of the first URL to the second URL.
121			*
122			* Any params that already exist in the second URL will go untouched.
123			*
124			* @param string $urlToStealFrom The URL harvest the params from.
125			* @param string $urlToAddTo The URL that will receive the new params.
126			*
127			* @return string The $urlToAddTo with any new params from $urlToStealFrom.
128			*/
129			public static function mergeUrlParams($urlToStealFrom, $urlToAddTo)
130			{
131			$newParams = static::getParamsAsArray($urlToStealFrom);
132			// Nothing new to add, return as-is
133			if (!$newParams) {
134			return $urlToAddTo;
135			}
136
137			return static::appendParamsToUrl($urlToAddTo, $newParams);
138			}
139
140			/**
141			* Check for a "/" prefix and prepend it if not exists.
142			*
143			* @param string\|null $string
144			*
145			* @return string\|null
146			*/
147			public static function forceSlashPrefix($string)
148			{
149			if (!$string) {
			0 ignored issues – show Bug Best Practice introduced 2015-12-04 22:06 UTC by Report Bug Copy Issue Report The expression `$string` of type `string\|null` 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...
150			return $string;
151			}
152
153			return strpos($string, '/') === 0 ? $string : '/' . $string;
154			}
155
156			/**
157			* Trims off the hostname and Graph version from a URL.
158			*
159			* @param string $urlToTrim The URL the needs the surgery.
160			*
161			* @return string The $urlToTrim with the hostname and Graph version removed.
162			*/
163			public static function baseGraphUrlEndpoint($urlToTrim)
164			{
165			return '/' . preg_replace('/^https:\/\/.+\.facebook\.com(\/v.+?)?\//', '', $urlToTrim);
166			}
167			}
168

facebook / facebook-php-sdk-v4

FacebookUrlManipulator::mergeUrlParams() A last analyzed 2016-08-09 11:36 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FacebookUrlManipulator::mergeUrlParams() A
last analyzed 2016-08-09 11:36 UTC