Url::generate() - Code Metrics - Inspection of "Ignore dot in URL, so e.g. index.php not matched." - mysociety/theyworkforyou - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Branch — master (3ce7e2)

by Nick

created 2018-06-21 14:13 UTC

Url::generate() C

↳ Parent: Url

Complexity

Conditions	9
Paths	16

Size

Total Lines	24
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	9.3752

Importance

Changes

Metric	Value
cc	9
eloc	16
c	0
b	0
f	0
nc	16
nop	2
dl	0
loc	24
rs	5.3563
ccs	15
cts	18
cp	0.8333
crap	9.3752

<?php
/**
 * URL Class
 *
 * @package TheyWorkForYou
 */

namespace MySociety\TheyWorkForYou;

/**
 * URL Class
 *
 * The URL class is used for generating URLs and other related things.
 * Relies on there being a get_http_var() function.
 *
 * This is probably how you'll use it most:
 *
 * ```php
 * $URL = new \MySociety\TheyWorkForYou\Url("YOURPAGENAME");
 * print $URL->generate();
 * ```
 *
 * In the metadata you should set a session_vars variable, an array.
 * The default page session_vars may be just array("debug").
 * These can then be overridden on a per-page basis.
 * Session vars are GET/POST vars that will be passed by default to that page.
 * ie, if "foo=bar" is in the current URL and you generate a URL to a page that has "foo"
 * as a session_var, "foo=bar" will be automatically added to the generated URL.
 * You can modify the session vars that will be included in the URL generated using the functions below.
 *
 * @author Phil Gyford <[email protected]>
 */

class Url {

    public function __construct($pagename) {
        // Initialise.
        global $DATA;
function myFunction($a, $b) {
    // Do something
}

        // The page we're going to be generating URL(s) for.
        $this->destinationpage = $pagename;


        // These stores an associative array of key/value pairs that
        // we'll want passed on to other pages.
        $this->session_vars = array ();


        // Prevent things using $DATA running if it hasn't been set, ie in testing
        if (isset($DATA)) {

            // Set the contents of $this->session_vars.
            // session_vars are variables we generally want to pass between pages, if any.
            // Will only be added as vars if they have values.

            $keys = $DATA->page_metadata($this->destinationpage, "session_vars");
            foreach ($keys as $key) {
                if (get_http_var($key) != "") {
                    $this->session_vars[$key] = get_http_var($key);
                }
            }

            // Some pages have the same URL, modified by a "pg" variable.
            // See if this page is one such, and add the variable if so.
            if ($pg = $DATA->page_metadata($this->destinationpage, "pg")) {
                $this->session_vars["pg"] = $pg;
            }

        }

        // So we can restore the originals.
        $this->original_session_vars = $this->session_vars;


    }

    /**
     * Restore Session Variables
     *
     * Restores the session variables to their state when the object was
     * instantiated.
     */

    public function restore() {
        // Call this to reset the session vars to how they were when
        // the object was instantiated.
        $this->session_vars = $this->original_session_vars;


    }

    /**
     * Reset Session Variables
     *
     * Removes all session variables.
     */

    public function reset() {
        // Call this to remove all the session_vars.
        $this->session_vars = array ();

    }

    /**
     * Insert Session Key/Value Pairs
     *
     * @param array $arr An associative array of key/value pairs
     */

    public function insert($arr) {
        // $arr is an associative array of key/value pairs.
        // These will be used as session_vars in addition to any that
        // already exist.
        foreach ($arr as $key => $val) {
            $this->session_vars[$key] = $val;

        }
    }

    /**
     * Remove Session Key/Value Pair
     *
     * @param array $arr A list array of key names to remove
     */

    public function remove($arr) {
        // $arr is a list array of key names. Any key/value pairs
        // in session_vars with keys found in $arr will be removed.
        foreach ($arr as $key) {
            if (isset($this->session_vars[$key])) {
                unset($this->session_vars[$key]);
            }
        }
    }

    /**
     * Update Values
     *
     * Any keys in session_vars that are also in $arr
     * will have their values overwritten by those in $arr.
     * Other session_var key/vals are not affected.
     *
     * @param array $arr An associative array of key/value pairs.
     */

    public function update($arr) {
        //
        //
        foreach ($arr as $key => $val) {
            if (isset($this->session_vars[$key])) {
                $this->session_vars[$key] = $arr[$key];

            }
        }
    }

    /**
     * Generate URL
     *
     * Generate a URL to the page specified with session vars.
     *
     * @param string encode       "html" will make the URL suitable for inclusion
filter:
    dependency_paths: ["lib/*"]
     *                            in a page directly, "none" will leave it alone,
     *                            "url" will do exactly the same.
     * @param array  overrideVars A key=>value mapping which allows some specific
filter:
    dependency_paths: ["lib/*"]
     *                            variable/value pairs to be overridden/inserted
     *                            into the query. Use this when you want to keep
     *                            the standard 'session vars' in a url, but
     *                            override just one or two of them.
     */

    public function generate($encode = "html", $overrideVars=array()) {

        global $DATA;
function myFunction($a, $b) {
    // Do something
}

        $url_args = array ();

        foreach (array_merge($this->session_vars, $overrideVars) as $key => $var) {
            if (is_array($var)) {
                foreach ($var as $v) {
                    $url_args[] = "$key=" . urlencode(stripslashes($v));
                }
            } elseif ($var != null)
                $url_args[] = "$key=" . urlencode(stripslashes($var));
        }

        $page_url = WEBPATH . $DATA->page_metadata($this->destinationpage, "url");


        if (sizeof($url_args) == 0) {
            return $page_url;
        } else {
            if ($encode == "html") {
                return $page_url . "?" . implode("&amp;", $url_args);
            } elseif ($encode == "none" || $encode == "url") {
                return $page_url . "?" . implode("&", $url_args);
            }
        }
    }

}


Branch — master (3ce7e2)

Url::generate() C

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1		<?php
2		/**
3		* URL Class
4		*
5		* @package TheyWorkForYou
6		*/
7
8		namespace MySociety\TheyWorkForYou;
9
10		/**
11		* URL Class
12		*
13		* The URL class is used for generating URLs and other related things.
14		* Relies on there being a get_http_var() function.
15		*
16		* This is probably how you'll use it most:
17		*
18		* ```php
19		* $URL = new \MySociety\TheyWorkForYou\Url("YOURPAGENAME");
20		* print $URL->generate();
21		* ```
22		*
23		* In the metadata you should set a session_vars variable, an array.
24		* The default page session_vars may be just array("debug").
25		* These can then be overridden on a per-page basis.
26		* Session vars are GET/POST vars that will be passed by default to that page.
27		* ie, if "foo=bar" is in the current URL and you generate a URL to a page that has "foo"
28		* as a session_var, "foo=bar" will be automatically added to the generated URL.
29		* You can modify the session vars that will be included in the URL generated using the functions below.
30		*
31		* @author Phil Gyford <[email protected]>
32		*/
33
34		class Url {
35
36	25	public function __construct($pagename) {
37		// Initialise.
38	25	global $DATA;
		0 ignored issues – show Compatibility Best Practice introduced 2017-07-12 14:20 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
39
40		// The page we're going to be generating URL(s) for.
41	25	$this->destinationpage = $pagename;
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `destinationpage` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
42
43		// These stores an associative array of key/value pairs that
44		// we'll want passed on to other pages.
45	25	$this->session_vars = array ();
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `session_vars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
46
47		// Prevent things using $DATA running if it hasn't been set, ie in testing
48	25	if (isset($DATA)) {
49
50		// Set the contents of $this->session_vars.
51		// session_vars are variables we generally want to pass between pages, if any.
52		// Will only be added as vars if they have values.
53
54	25	$keys = $DATA->page_metadata($this->destinationpage, "session_vars");
55	25	foreach ($keys as $key) {
56	25	if (get_http_var($key) != "") {
57		$this->session_vars[$key] = get_http_var($key);
58		}
59	25	}
60
61		// Some pages have the same URL, modified by a "pg" variable.
62		// See if this page is one such, and add the variable if so.
63	25	if ($pg = $DATA->page_metadata($this->destinationpage, "pg")) {
64		$this->session_vars["pg"] = $pg;
65		}
66
67	25	}
68
69		// So we can restore the originals.
70	25	$this->original_session_vars = $this->session_vars;
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `original_session_vars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
71
72	25	}
73
74		/**
75		* Restore Session Variables
76		*
77		* Restores the session variables to their state when the object was
78		* instantiated.
79		*/
80
81		public function restore() {
82		// Call this to reset the session vars to how they were when
83		// the object was instantiated.
84		$this->session_vars = $this->original_session_vars;
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `session_vars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
85
86		}
87
88		/**
89		* Reset Session Variables
90		*
91		* Removes all session variables.
92		*/
93
94	1	public function reset() {
95		// Call this to remove all the session_vars.
96	1	$this->session_vars = array ();
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `session_vars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
97	1	}
98
99		/**
100		* Insert Session Key/Value Pairs
101		*
102		* @param array $arr An associative array of key/value pairs
103		*/
104
105	19	public function insert($arr) {
106		// $arr is an associative array of key/value pairs.
107		// These will be used as session_vars in addition to any that
108		// already exist.
109	19	foreach ($arr as $key => $val) {
110	19	$this->session_vars[$key] = $val;
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `session_vars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
111	19	}
112	19	}
113
114		/**
115		* Remove Session Key/Value Pair
116		*
117		* @param array $arr A list array of key names to remove
118		*/
119
120	5	public function remove($arr) {
121		// $arr is a list array of key names. Any key/value pairs
122		// in session_vars with keys found in $arr will be removed.
123	5	foreach ($arr as $key) {
124	5	if (isset($this->session_vars[$key])) {
125	4	unset($this->session_vars[$key]);
126	4	}
127	5	}
128	5	}
129
130		/**
131		* Update Values
132		*
133		* Any keys in session_vars that are also in $arr
134		* will have their values overwritten by those in $arr.
135		* Other session_var key/vals are not affected.
136		*
137		* @param array $arr An associative array of key/value pairs.
138		*/
139
140	8	public function update($arr) {
141		//
142		//
143	8	foreach ($arr as $key => $val) {
144	8	if (isset($this->session_vars[$key])) {
145	8	$this->session_vars[$key] = $arr[$key];
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `session_vars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
146	8	}
147	8	}
148	8	}
149
150		/**
151		* Generate URL
152		*
153		* Generate a URL to the page specified with session vars.
154		*
155		* @param string encode "html" will make the URL suitable for inclusion
		0 ignored issues – show Bug introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The type `MySociety\TheyWorkForYou\encode` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
156		* in a page directly, "none" will leave it alone,
157		* "url" will do exactly the same.
158		* @param array overrideVars A key=>value mapping which allows some specific
		0 ignored issues – show Bug introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The type `MySociety\TheyWorkForYou\overrideVars` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
159		* variable/value pairs to be overridden/inserted
160		* into the query. Use this when you want to keep
161		* the standard 'session vars' in a url, but
162		* override just one or two of them.
163		*/
164
165	25	public function generate($encode = "html", $overrideVars=array()) {
166
167	25	global $DATA;
		0 ignored issues – show Compatibility Best Practice introduced 2017-11-01 08:55 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
168
169	25	$url_args = array ();
170
171	25	foreach (array_merge($this->session_vars, $overrideVars) as $key => $var) {
172	19	if (is_array($var)) {
173		foreach ($var as $v) {
174		$url_args[] = "$key=" . urlencode(stripslashes($v));
175		}
176	19	} elseif ($var != null)
177	19	$url_args[] = "$key=" . urlencode(stripslashes($var));
178	25	}
179
180	25	$page_url = WEBPATH . $DATA->page_metadata($this->destinationpage, "url");
		1 ignored issue – show Bug introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The constant `MySociety\TheyWorkForYou\WEBPATH` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
181
182	25	if (sizeof($url_args) == 0) {
183	10	return $page_url;
184		} else {
185	19	if ($encode == "html") {
186	11	return $page_url . "?" . implode("&", $url_args);
187	8	} elseif ($encode == "none" \|\| $encode == "url") {
188	8	return $page_url . "?" . implode("&", $url_args);
189		}
190		}
191		}
192
193		}
194

mysociety / theyworkforyou

Branch — master (3ce7e2)

Url::generate() C

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like