Request::setQueryParam() - Code Metrics - NatLibFi/Skosmos - Measure and Improve Code Quality continuously with Scrutinizer

Request::setQueryParam() A
last analyzed 2025-10-29 14:21 UTC

↳ Parent: Request

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	2
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

/**
 * Provides access to the http request information
 */
class Request
{
    private $lang;
    private $clang;
    private $page;
    private $vocab;
    private $vocabids;
    private $uri;
    private $letter;
    private $model;
    private $queryParams;
    private $queryParamsPOST;
    private $serverConstants;
    private $cookies;

    /**
     * Initializes the Request Object
     */
    public function __construct($model)
    {
        $this->model = $model;

        // Store GET parameters in a local array, so we can mock them in tests.
        // We do not apply any filters at this point.
        $this->queryParams = [];
        foreach (filter_input_array(INPUT_GET) ?: [] as $key => $val) {
            $this->queryParams[$key] = $val;
        }

        // Store POST parameters in a local array, so we can mock them in tests.
        // We do not apply any filters at this point.
        $this->queryParamsPOST = [];
        foreach (filter_input_array(INPUT_POST) ?: [] as $key => $val) {
            $this->queryParamsPOST[$key] = $val;
        }

        // Store SERVER parameters in a local array, so we can mock them in tests.
        // We do not apply any filters at this point.
        $this->serverConstants = [];
        foreach (filter_input_array(INPUT_SERVER) ?: [] as $key => $val) {
            $this->serverConstants[$key] = $val;
        }

        // Store cookies in a local array, so we can mock them in tests.
        // We do not apply any filters at this point.
        $this->cookies = [];
        foreach (filter_input_array(INPUT_COOKIE) ?: [] as $key => $val) {
            $this->cookies[$key] = $val;
        }
    }

    /**
     * Set a GET query parameter to mock it in tests.
     * @param string $paramName parameter name
     * @param string $value parameter value
     */
    public function setQueryParam($paramName, $value)
    {
        $this->queryParams[$paramName] = $value;
    }

    /**
     * Set a SERVER constant to mock it in tests.
     * @param string $paramName parameter name
     * @param string $value parameter value
     */
    public function setServerConstant($paramName, $value)
    {
        $this->serverConstants[$paramName] = $value;
    }

    /**
     * Set a cookie to mock it in tests.
     * @param string $paramName parameter name
     * @param string $value parameter value
     */
    public function setCookie($paramName, $value)
    {
        $this->cookies[$paramName] = $value;
    }

    /**
     * Return the requested GET query parameter as a string. Backslashes are stripped for security reasons.
     * @param string $paramName parameter name
     * @return string parameter content, or null if no parameter found
     */
    public function getQueryParam($paramName)
    {
        if (!isset($this->queryParams[$paramName])) {
            return null;
        }
        $val = filter_var($this->queryParams[$paramName], FILTER_SANITIZE_FULL_SPECIAL_CHARS);

        return ($val !== null ? str_replace('\\', '', $val) : null);
    }

    /**
     * Return the requested GET query parameter as a string, with no sanitizing.
     * @param string $paramName parameter name
     * @return string parameter content, or null if no parameter found
     */
    public function getQueryParamRaw($paramName)
    {
        return isset($this->queryParams[$paramName]) ? $this->queryParams[$paramName] : null;
    }

    public function getQueryParamPOST($paramName)
    {
        if (!isset($this->queryParamsPOST[$paramName])) {
            return null;
        }
        return filter_var($this->queryParamsPOST[$paramName], FILTER_SANITIZE_FULL_SPECIAL_CHARS);

    }

    public function getQueryParamBoolean($paramName, $default)
    {
        $val = $this->getQueryParamRaw($paramName);
        if ($val !== null) {

            $val = filter_var($val, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
        }
        return ($val !== null) ? $val : $default;
    }

    public function getServerConstant($paramName)
    {
        if (!isset($this->serverConstants[$paramName])) {
            return null;
        }
        return filter_var($this->serverConstants[$paramName], FILTER_SANITIZE_ADD_SLASHES);
    }

    public function getCookie($paramName)
    {
        if (!isset($this->cookies[$paramName])) {
            return null;
        }
        return filter_var($this->cookies[$paramName], FILTER_SANITIZE_FULL_SPECIAL_CHARS);

    }

    public function getLang()
    {
        return $this->lang;
    }

    /**
     * Sets the language variable
     * @param string $lang
     */
    public function setLang($lang)
    {
        if ($lang !== '') {
            $this->lang = $lang;
        }

    }

    public function getContentLang()
    {
        return $this->clang;
    }

    /**
     * Sets the language variable
     * @param string $clang
     */
    public function setContentLang($clang)
    {
        $this->clang = $this->verifyContentLang($clang);
    }

    private function verifyContentLang($lang)
    {
        if ($this->vocab) {
            return $this->vocab->verifyVocabularyLanguage($lang);
        }

        return $lang;
    }

    public function getPage()
    {
        return $this->page;
    }

    /**
     * Sets the page id variable eg. 'groups'
     * @param string $page
     */
    public function setPage($page)
    {
        if ($page !== '') {
            $this->page = $page;
        }

    }

    public function getRequestUri()
    {
        return $this->getServerConstant('HTTP_HOST') . $this->getServerConstant('REQUEST_URI');
    }

    /**
     * Returns the relative page url eg. '/yso/fi/search?clang=en&q=cat'
     * @param string $newlang new UI language to set
     * @return string the relative url of the page
     */
    public function getLangUrl($newlang = null)
    {
        $script_name = str_replace('/src/index.php', '', $this->getServerConstant('SCRIPT_NAME'));
        $langurl = substr(str_replace($script_name, '', strval($this->getServerConstant('REQUEST_URI'))), 1);
        if ($newlang !== null) {
            $langurl = preg_replace("#^(.*/)?{$this->lang}/#", "$1{$newlang}/", $langurl);
        }
        // make sure that the resulting URL isn't interpreted as an absolute URL
        $langurl = str_replace(":", "", $langurl);
        return $langurl;
    }

    public function getLetter()
    {
        return (isset($this->letter)) ? $this->letter : '';
    }

    /**
     * Sets the page id variable eg. 'B'
     * @param string $letter
     */
    public function setLetter($letter)
    {
        if ($letter !== '') {
            $this->letter = $letter;
        }

    }

    public function getURI()
    {
        return $this->uri;
    }

    /**
     * Sets the uri variable
     * @param string $uri
     */
    public function setURI($uri)
    {
        if ($uri !== '') {
            $this->uri = rtrim(strval($uri));
        }

    }

    /**
     * Used to set the vocab id variable when multiple vocabularies have been chosen eg. 'lcsh+yso'
     * @param string $ids
     */
    public function setVocabids($ids)
    {
        $this->vocabids = $ids;
    }

    public function getVocabid()
    {
        if ($this->vocabids) {
            return $this->vocabids;
        }

        return isset($this->vocab) ? $this->vocab->getId() : '';
    }

    /**
     * Creates a Vocabulary object
     * @param string $vocabid
     */
    public function setVocab($vocabid)
    {
        if (strpos($vocabid, ' ') !== false) { // if there are multiple vocabularies just storing the string
            $this->setVocabids($vocabid);
        } else {
            $this->vocab = $this->model->getVocabulary($vocabid);
        }

    }

    /**
     * @return Vocabulary
     */
    public function getVocab()
    {
        return $this->vocab;
    }

    public function getVocabList()
    {
        return $this->model->getVocabularyList();
    }

    public function getPlugins()
    {
        if ($this->vocab) {
            return $this->vocab->getConfig()->getPluginRegister();
        }
        return new PluginRegister($this->model->getConfig()->getGlobalPlugins());
    }

    /**
     * Return the version of this Skosmos installation, or "unknown" if
     * it cannot be determined. The version information is based on Git tags.
     * @return string version
     */
    public function getVersion(): string
    {
        return $this->model->getVersion();
    }
}


1			<?php
2
3			/**
4			* Provides access to the http request information
5			*/
6			class Request
7			{
8			private $lang;
9			private $clang;
10			private $page;
11			private $vocab;
12			private $vocabids;
13			private $uri;
14			private $letter;
15			private $model;
16			private $queryParams;
17			private $queryParamsPOST;
18			private $serverConstants;
19			private $cookies;
20
21			/**
22			* Initializes the Request Object
23			*/
24			public function __construct($model)
25			{
26			$this->model = $model;
27
28			// Store GET parameters in a local array, so we can mock them in tests.
29			// We do not apply any filters at this point.
30			$this->queryParams = [];
31			foreach (filter_input_array(INPUT_GET) ?: [] as $key => $val) {
32			$this->queryParams[$key] = $val;
33			}
34
35			// Store POST parameters in a local array, so we can mock them in tests.
36			// We do not apply any filters at this point.
37			$this->queryParamsPOST = [];
38			foreach (filter_input_array(INPUT_POST) ?: [] as $key => $val) {
39			$this->queryParamsPOST[$key] = $val;
40			}
41
42			// Store SERVER parameters in a local array, so we can mock them in tests.
43			// We do not apply any filters at this point.
44			$this->serverConstants = [];
45			foreach (filter_input_array(INPUT_SERVER) ?: [] as $key => $val) {
46			$this->serverConstants[$key] = $val;
47			}
48
49			// Store cookies in a local array, so we can mock them in tests.
50			// We do not apply any filters at this point.
51			$this->cookies = [];
52			foreach (filter_input_array(INPUT_COOKIE) ?: [] as $key => $val) {
53			$this->cookies[$key] = $val;
54			}
55			}
56
57			/**
58			* Set a GET query parameter to mock it in tests.
59			* @param string $paramName parameter name
60			* @param string $value parameter value
61			*/
62			public function setQueryParam($paramName, $value)
63			{
64			$this->queryParams[$paramName] = $value;
65			}
66
67			/**
68			* Set a SERVER constant to mock it in tests.
69			* @param string $paramName parameter name
70			* @param string $value parameter value
71			*/
72			public function setServerConstant($paramName, $value)
73			{
74			$this->serverConstants[$paramName] = $value;
75			}
76
77			/**
78			* Set a cookie to mock it in tests.
79			* @param string $paramName parameter name
80			* @param string $value parameter value
81			*/
82			public function setCookie($paramName, $value)
83			{
84			$this->cookies[$paramName] = $value;
85			}
86
87			/**
88			* Return the requested GET query parameter as a string. Backslashes are stripped for security reasons.
89			* @param string $paramName parameter name
90			* @return string parameter content, or null if no parameter found
91			*/
92			public function getQueryParam($paramName)
93			{
94			if (!isset($this->queryParams[$paramName])) {
95			return null;
96			}
97			$val = filter_var($this->queryParams[$paramName], FILTER_SANITIZE_FULL_SPECIAL_CHARS);
			0 ignored issues – show Bug introduced 2022-11-03 20:21 UTC by Report Bug Copy Issue Report The constant `FILTER_SANITIZE_FULL_SPECIAL_CHARS` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
98			return ($val !== null ? str_replace('\\', '', $val) : null);
99			}
100
101			/**
102			* Return the requested GET query parameter as a string, with no sanitizing.
103			* @param string $paramName parameter name
104			* @return string parameter content, or null if no parameter found
105			*/
106			public function getQueryParamRaw($paramName)
107			{
108			return isset($this->queryParams[$paramName]) ? $this->queryParams[$paramName] : null;
109			}
110
111			public function getQueryParamPOST($paramName)
112			{
113			if (!isset($this->queryParamsPOST[$paramName])) {
114			return null;
115			}
116			return filter_var($this->queryParamsPOST[$paramName], FILTER_SANITIZE_FULL_SPECIAL_CHARS);
			0 ignored issues – show Bug introduced 2022-11-03 20:21 UTC by Report Bug Copy Issue Report The constant `FILTER_SANITIZE_FULL_SPECIAL_CHARS` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
117			}
118
119			public function getQueryParamBoolean($paramName, $default)
120			{
121			$val = $this->getQueryParamRaw($paramName);
122			if ($val !== null) {
			0 ignored issues – show introduced 2024-01-23 14:26 UTC by Report Bug Copy Issue Report The condition `$val !== null` is always `true`. Loading history...
123			$val = filter_var($val, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
124			}
125			return ($val !== null) ? $val : $default;
126			}
127
128			public function getServerConstant($paramName)
129			{
130			if (!isset($this->serverConstants[$paramName])) {
131			return null;
132			}
133			return filter_var($this->serverConstants[$paramName], FILTER_SANITIZE_ADD_SLASHES);
134			}
135
136			public function getCookie($paramName)
137			{
138			if (!isset($this->cookies[$paramName])) {
139			return null;
140			}
141			return filter_var($this->cookies[$paramName], FILTER_SANITIZE_FULL_SPECIAL_CHARS);
			0 ignored issues – show Bug introduced 2023-05-25 06:29 UTC by Report Bug Copy Issue Report The constant `FILTER_SANITIZE_FULL_SPECIAL_CHARS` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
142			}
143
144			public function getLang()
145			{
146			return $this->lang;
147			}
148
149			/**
150			* Sets the language variable
151			* @param string $lang
152			*/
153			public function setLang($lang)
154			{
155			if ($lang !== '') {
156			$this->lang = $lang;
157			}
158
159			}
160
161			public function getContentLang()
162			{
163			return $this->clang;
164			}
165
166			/**
167			* Sets the language variable
168			* @param string $clang
169			*/
170			public function setContentLang($clang)
171			{
172			$this->clang = $this->verifyContentLang($clang);
173			}
174
175			private function verifyContentLang($lang)
176			{
177			if ($this->vocab) {
178			return $this->vocab->verifyVocabularyLanguage($lang);
179			}
180
181			return $lang;
182			}
183
184			public function getPage()
185			{
186			return $this->page;
187			}
188
189			/**
190			* Sets the page id variable eg. 'groups'
191			* @param string $page
192			*/
193			public function setPage($page)
194			{
195			if ($page !== '') {
196			$this->page = $page;
197			}
198
199			}
200
201			public function getRequestUri()
202			{
203			return $this->getServerConstant('HTTP_HOST') . $this->getServerConstant('REQUEST_URI');
204			}
205
206			/**
207			* Returns the relative page url eg. '/yso/fi/search?clang=en&q=cat'
208			* @param string $newlang new UI language to set
209			* @return string the relative url of the page
210			*/
211			public function getLangUrl($newlang = null)
212			{
213			$script_name = str_replace('/src/index.php', '', $this->getServerConstant('SCRIPT_NAME'));
214			$langurl = substr(str_replace($script_name, '', strval($this->getServerConstant('REQUEST_URI'))), 1);
215			if ($newlang !== null) {
216			$langurl = preg_replace("#^(.*/)?{$this->lang}/#", "$1{$newlang}/", $langurl);
217			}
218			// make sure that the resulting URL isn't interpreted as an absolute URL
219			$langurl = str_replace(":", "", $langurl);
220			return $langurl;
221			}
222
223			public function getLetter()
224			{
225			return (isset($this->letter)) ? $this->letter : '';
226			}
227
228			/**
229			* Sets the page id variable eg. 'B'
230			* @param string $letter
231			*/
232			public function setLetter($letter)
233			{
234			if ($letter !== '') {
235			$this->letter = $letter;
236			}
237
238			}
239
240			public function getURI()
241			{
242			return $this->uri;
243			}
244
245			/**
246			* Sets the uri variable
247			* @param string $uri
248			*/
249			public function setURI($uri)
250			{
251			if ($uri !== '') {
252			$this->uri = rtrim(strval($uri));
253			}
254
255			}
256
257			/**
258			* Used to set the vocab id variable when multiple vocabularies have been chosen eg. 'lcsh+yso'
259			* @param string $ids
260			*/
261			public function setVocabids($ids)
262			{
263			$this->vocabids = $ids;
264			}
265
266			public function getVocabid()
267			{
268			if ($this->vocabids) {
269			return $this->vocabids;
270			}
271
272			return isset($this->vocab) ? $this->vocab->getId() : '';
273			}
274
275			/**
276			* Creates a Vocabulary object
277			* @param string $vocabid
278			*/
279			public function setVocab($vocabid)
280			{
281			if (strpos($vocabid, ' ') !== false) { // if there are multiple vocabularies just storing the string
282			$this->setVocabids($vocabid);
283			} else {
284			$this->vocab = $this->model->getVocabulary($vocabid);
285			}
286
287			}
288
289			/**
290			* @return Vocabulary
291			*/
292			public function getVocab()
293			{
294			return $this->vocab;
295			}
296
297			public function getVocabList()
298			{
299			return $this->model->getVocabularyList();
300			}
301
302			public function getPlugins()
303			{
304			if ($this->vocab) {
305			return $this->vocab->getConfig()->getPluginRegister();
306			}
307			return new PluginRegister($this->model->getConfig()->getGlobalPlugins());
308			}
309
310			/**
311			* Return the version of this Skosmos installation, or "unknown" if
312			* it cannot be determined. The version information is based on Git tags.
313			* @return string version
314			*/
315			public function getVersion(): string
316			{
317			return $this->model->getVersion();
318			}
319			}
320

NatLibFi / Skosmos

Request::setQueryParam() A last analyzed 2025-10-29 14:21 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Request::setQueryParam() A
last analyzed 2025-10-29 14:21 UTC