Config::gcLifeTime() - Code Metrics - Inspection of "4352650baac6cc99cb919a05de6fb1591585dcc3" - Phauthentic/session - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Branch — master (435265)

by Florian

created 2020-04-29 23:50 UTC

Config::gcLifeTime() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Phauthentic\Infrastructure\Http\Session;

use RuntimeException;

/**
 * Session Configuration Abstraction
 *
 * This class provides a way to configure most of the session settings
 *
 * @link https://www.php.net/manual/en/session.security.ini.php
 */
class Config implements ConfigInterface
{
    /**
     * @param array $array Array
     * @return $this
     */
    public static function fromArray(array $array): ConfigInterface
    {
        $instance = new static();

        foreach ($array as $key => $value) {
            $method = 'set' . $key;
            if (method_exists($instance, $method)) {
                $instance->{$method}($value);
            }
        }

        return $instance;
    }

    /**
     * @inheritDoc
     */
    public function setUseTransSid(bool $useTransSid): ConfigInterface
    {
        $this->iniSet('session.use_trans_sid', $useTransSid);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function setSerializeHandler(string $handler): ConfigInterface
    {
        $this->iniSet('session.serialize_handler', $handler);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function setStrictMode(bool $useStrictMode): ConfigInterface
    {
        $this->iniSet('session.use_strict_mode', $useStrictMode);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function setCookiePath(bool $path): ConfigInterface
    {
        $this->iniSet('session.cookie_path', $path);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function setCookieHttpOnly(bool $onlyHttp): ConfigInterface
    {
        $this->iniSet('session.cookie_httponly', $onlyHttp);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function cookieHttpOnly(): bool
    {
        return (bool)ini_get('session.cookie_httponly');
    }

    /**
     * @inheritDoc
     */
    public function setCookieSecure(bool $secure): ConfigInterface
    {
        $this->iniSet('session.cookie_secure', $secure);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function setSessionName(bool $name): ConfigInterface
    {
        $this->iniSet('session.name', $name);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function setUseCookies(bool $useCookies): ConfigInterface
    {
        $this->iniSet('session.use_cookies', $useCookies);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function setSavePath(string $path): ConfigInterface
    {
        $this->iniSet('session.save_path', $path);

        return $this;
    }

    /**
     * Checks an edge case for the handler
     *
     * @link https://github.com/php/php-src/commit/a93a51c3bf4ea1638ce0adc4a899cb93531b9f0d
     * @link http://php.net/manual/en/session.configuration.php
     * @param string $handler Handler
     * @return void
     */
    protected function checkHandler(string $handler): void
    {
        if (
            version_compare(PHP_VERSION, '7.2.0', '>=')
            && $handler === 'user'
        ) {
            throw new RuntimeException(
                'You can\'t set the `user` save handler any longer in php >= 7.2. '
                . 'See https://github.com/php/php-src/commit/a93a51c3bf4ea1638ce0adc4a899cb93531b9f0d'
            );
        }
    }

    /**
     * @inheritDoc
     */
    public function setSaveHandler(string $handler): ConfigInterface
    {
        $this->checkHandler($handler);
        $this->iniSet('session.save_handler', $handler);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function useTransSid(): bool
    {
        return (bool)ini_get('session.use_trans_sid');
    }

    /**
     * @inheritDoc
     */
    public function serializeHandler(): string
    {
        return ini_get('session.serialize_handler');
    }

    /**
     * @inheritDoc
     */
    public function useCookies(): string
    {
        return ini_get('session.use_cookies');
    }

    /**
     * @inheritDoc
     */
    public function savePath(): string
    {
        return ini_get('session.save_path');
    }

    /**
     * @inheritDoc
     */
    public function saveHandler(): string
    {
        return ini_get('session.save_handler');
    }

    /**
     * @inheritDoc
     */
    public function setGcLifeTime(int $minutes): ConfigInterface
    {
        $this->iniSet('session.gc_maxlifetime', 60 * $minutes);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function gcLifeTime(): int
    {
        return (int)ini_get('session.gc_maxlifetime') / 60;
    }

    /**
     * @inheritDoc
     */
    public function iniSet(string $setting, $value)
    {
        $result = ini_set($setting, (string)$value);
        if ($result === false) {
            throw new RuntimeException(sprintf('Could not set `%s`', $setting));
        }

        return $result;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Phauthentic\Infrastructure\Http\Session;
6
7		use RuntimeException;
8
9		/**
10		* Session Configuration Abstraction
11		*
12		* This class provides a way to configure most of the session settings
13		*
14		* @link https://www.php.net/manual/en/session.security.ini.php
15		*/
16		class Config implements ConfigInterface
17		{
18		/**
19		* @param array $array Array
20		* @return $this
21		*/
22		public static function fromArray(array $array): ConfigInterface
23		{
24		$instance = new static();
25
26		foreach ($array as $key => $value) {
27		$method = 'set' . $key;
28		if (method_exists($instance, $method)) {
29		$instance->{$method}($value);
30		}
31		}
32
33		return $instance;
34		}
35
36		/**
37		* @inheritDoc
38		*/
39	4	public function setUseTransSid(bool $useTransSid): ConfigInterface
40		{
41	4	$this->iniSet('session.use_trans_sid', $useTransSid);
42
43	4	return $this;
44		}
45
46		/**
47		* @inheritDoc
48		*/
49		public function setSerializeHandler(string $handler): ConfigInterface
50		{
51		$this->iniSet('session.serialize_handler', $handler);
52
53		return $this;
54		}
55
56		/**
57		* @inheritDoc
58		*/
59		public function setStrictMode(bool $useStrictMode): ConfigInterface
60		{
61		$this->iniSet('session.use_strict_mode', $useStrictMode);
62
63		return $this;
64		}
65
66		/**
67		* @inheritDoc
68		*/
69		public function setCookiePath(bool $path): ConfigInterface
70		{
71		$this->iniSet('session.cookie_path', $path);
72
73		return $this;
74		}
75
76		/**
77		* @inheritDoc
78		*/
79	2	public function setCookieHttpOnly(bool $onlyHttp): ConfigInterface
80		{
81	2	$this->iniSet('session.cookie_httponly', $onlyHttp);
82
83	2	return $this;
84		}
85
86		/**
87		* @inheritDoc
88		*/
89	2	public function cookieHttpOnly(): bool
90		{
91	2	return (bool)ini_get('session.cookie_httponly');
92		}
93
94		/**
95		* @inheritDoc
96		*/
97		public function setCookieSecure(bool $secure): ConfigInterface
98		{
99		$this->iniSet('session.cookie_secure', $secure);
100
101		return $this;
102		}
103
104		/**
105		* @inheritDoc
106		*/
107		public function setSessionName(bool $name): ConfigInterface
108		{
109		$this->iniSet('session.name', $name);
110
111		return $this;
112		}
113
114		/**
115		* @inheritDoc
116		*/
117		public function setUseCookies(bool $useCookies): ConfigInterface
118		{
119		$this->iniSet('session.use_cookies', $useCookies);
120
121		return $this;
122		}
123
124		/**
125		* @inheritDoc
126		*/
127		public function setSavePath(string $path): ConfigInterface
128		{
129		$this->iniSet('session.save_path', $path);
130
131		return $this;
132		}
133
134		/**
135		* Checks an edge case for the handler
136		*
137		* @link https://github.com/php/php-src/commit/a93a51c3bf4ea1638ce0adc4a899cb93531b9f0d
138		* @link http://php.net/manual/en/session.configuration.php
139		* @param string $handler Handler
140		* @return void
141		*/
142		protected function checkHandler(string $handler): void
143		{
144		if (
145		version_compare(PHP_VERSION, '7.2.0', '>=')
146		&& $handler === 'user'
147		) {
148		throw new RuntimeException(
149		'You can\'t set the `user` save handler any longer in php >= 7.2. '
150		. 'See https://github.com/php/php-src/commit/a93a51c3bf4ea1638ce0adc4a899cb93531b9f0d'
151		);
152		}
153		}
154
155		/**
156		* @inheritDoc
157		*/
158		public function setSaveHandler(string $handler): ConfigInterface
159		{
160		$this->checkHandler($handler);
161		$this->iniSet('session.save_handler', $handler);
162
163		return $this;
164		}
165
166		/**
167		* @inheritDoc
168		*/
169	2	public function useTransSid(): bool
170		{
171	2	return (bool)ini_get('session.use_trans_sid');
172		}
173
174		/**
175		* @inheritDoc
176		*/
177		public function serializeHandler(): string
178		{
179		return ini_get('session.serialize_handler');
180		}
181
182		/**
183		* @inheritDoc
184		*/
185		public function useCookies(): string
186		{
187		return ini_get('session.use_cookies');
188		}
189
190		/**
191		* @inheritDoc
192		*/
193		public function savePath(): string
194		{
195		return ini_get('session.save_path');
196		}
197
198		/**
199		* @inheritDoc
200		*/
201		public function saveHandler(): string
202		{
203		return ini_get('session.save_handler');
204		}
205
206		/**
207		* @inheritDoc
208		*/
209	2	public function setGcLifeTime(int $minutes): ConfigInterface
210		{
211	2	$this->iniSet('session.gc_maxlifetime', 60 * $minutes);
212
213	2	return $this;
214		}
215
216		/**
217		* @inheritDoc
218		*/
219	2	public function gcLifeTime(): int
220		{
221	2	return (int)ini_get('session.gc_maxlifetime') / 60;
222		}
223
224		/**
225		* @inheritDoc
226		*/
227	4	public function iniSet(string $setting, $value)
228		{
229	4	$result = ini_set($setting, (string)$value);
230	4	if ($result === false) {
231		throw new RuntimeException(sprintf('Could not set `%s`', $setting));
232		}
233
234	4	return $result;
235		}
236		}
237

Phauthentic / session

Branch — master (435265)

Config::gcLifeTime() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like