GlobalSession::clear() - Code Metrics - jasny/session-middleware - Measure and Improve Code Quality continuously with Scrutinizer

GlobalSession::clear() A
last analyzed 2020-04-17 00:48 UTC

↳ Parent: GlobalSession

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Jasny\Session;

use Jasny\Session\Flash\FlashBag;
use Jasny\Session\Flash\FlashTrait;

/**
 * Wrapper round $_SESSION.
 */
class GlobalSession implements SessionInterface
{
    use FlashTrait;

    /** @var array<string,mixed> */
    protected array $options;

    /**
     * Session constructor.
     *
     * @param array<string,mixed> $options   Passed to session_start()
     * @param FlashBag|null       $flashBag
     */
    public function __construct(array $options = [], ?FlashBag $flashBag = null)
    {
        $this->options = $options;
        $this->flashBag = $flashBag ?? new FlashBag();
    }

    /**
     * Start the session.
     * @see session_start()
     */
    public function start(): void
    {
        session_start($this->options);
    }

    /**
     * Write session data and end session.
     * @see session_write_close()
     */
    public function stop(): void
    {
        session_write_close();
    }

    /**
     * Discard session array changes and finish session.
     * @see session_abort()
     *
     * Only a shallow clone is done to save the original data. If the session data contains objects, make sure that
     *   `__clone()` is overwritten, so it does a deep clone.
     */
    public function abort(): void
    {
        session_abort();
    }


    /**
     * Get the sessions status.
     * @see session_status()
     */
    public function status(): int
    {
        return session_status();
    }


    /**
     * Clear all data from the session.
     */
    public function clear(): void
    {
        $this->assertStarted();

        $_SESSION = [];
    }

    /**
     * @inheritDoc
     */
    public function kill(): void
    {
        $this->assertStarted();

        $this->removeCookie(session_name());
        $_SESSION = [];
        session_destroy();
    }

    /**
     * Remove the session cookie.
     * @codeCoverageIgnore
     */
    protected function removeCookie(string $name): void
    {
        if (!(bool)ini_get("session.use_cookies")) {
            return;
        }

        $options = ['expires' => time() - 42000] + session_get_cookie_params();
        unset($options['lifetime']);

        setcookie($name, '', $options);
    }

    /**
     * @inheritDoc
     */
    public function rotate(?callable $copy = null): void
    {
        $this->assertStarted();

        $data = isset($copy) ? $copy($_SESSION) : [];

        $_SESSION = [];
        $this->regenerateId(true);

        $_SESSION = $data;
    }

    /**
     * Wrapper around `session_regenerate_id()`
     * @codeCoverageIgnore
     */
    protected function regenerateId(bool $delete): void
    {
        session_regenerate_id($delete);
    }


    /**
     * @param string $offset
     * @return bool
     */
    public function offsetExists($offset): bool
    {
        $this->assertStarted();

        return array_key_exists($offset, $_SESSION);
    }

    /**
     * @param string $offset
     * @return mixed
     */
    public function offsetGet($offset)
    {
        $this->assertStarted();

        return $_SESSION[$offset];
    }

    /**
     * @param string $offset
     * @param mixed  $value
     */
    public function offsetSet($offset, $value): void

    {
        $this->assertStarted();

        $_SESSION[$offset] = $value;
    }

    /**
     * @param string $offset
     */
    public function offsetUnset($offset): void
    {
        $this->assertStarted();

        unset($_SESSION[$offset]);
    }


    /**
     * Assert that there is an active session.
     *
     * @throws NoSessionException
     */
    protected function assertStarted(): void
    {
        if (session_status() !== \PHP_SESSION_ACTIVE) {
            throw new NoSessionException("Session not started");
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Jasny\Session;
6
7		use Jasny\Session\Flash\FlashBag;
8		use Jasny\Session\Flash\FlashTrait;
9
10		/**
11		* Wrapper round $_SESSION.
12		*/
13		class GlobalSession implements SessionInterface
14		{
15		use FlashTrait;
16
17		/** @var array<string,mixed> */
18		protected array $options;
19
20		/**
21		* Session constructor.
22		*
23		* @param array<string,mixed> $options Passed to session_start()
24		* @param FlashBag\|null $flashBag
25		*/
26	8	public function __construct(array $options = [], ?FlashBag $flashBag = null)
27		{
28	8	$this->options = $options;
29	8	$this->flashBag = $flashBag ?? new FlashBag();
30	8	}
31
32		/**
33		* Start the session.
34		* @see session_start()
35		*/
36	3	public function start(): void
37		{
38	3	session_start($this->options);
39	3	}
40
41		/**
42		* Write session data and end session.
43		* @see session_write_close()
44		*/
45	3	public function stop(): void
46		{
47	3	session_write_close();
48	3	}
49
50		/**
51		* Discard session array changes and finish session.
52		* @see session_abort()
53		*
54		* Only a shallow clone is done to save the original data. If the session data contains objects, make sure that
55		* `__clone()` is overwritten, so it does a deep clone.
56		*/
57	2	public function abort(): void
58		{
59	2	session_abort();
60	2	}
61
62
63		/**
64		* Get the sessions status.
65		* @see session_status()
66		*/
67	5	public function status(): int
68		{
69	5	return session_status();
70		}
71
72
73		/**
74		* Clear all data from the session.
75		*/
76	1	public function clear(): void
77		{
78	1	$this->assertStarted();
79
80	1	$_SESSION = [];
81	1	}
82
83		/**
84		* @inheritDoc
85		*/
86	1	public function kill(): void
87		{
88	1	$this->assertStarted();
89
90	1	$this->removeCookie(session_name());
91	1	$_SESSION = [];
92	1	session_destroy();
93	1	}
94
95		/**
96		* Remove the session cookie.
97		* @codeCoverageIgnore
98		*/
99		protected function removeCookie(string $name): void
100		{
101		if (!(bool)ini_get("session.use_cookies")) {
102		return;
103		}
104
105		$options = ['expires' => time() - 42000] + session_get_cookie_params();
106		unset($options['lifetime']);
107
108		setcookie($name, '', $options);
109		}
110
111		/**
112		* @inheritDoc
113		*/
114	1	public function rotate(?callable $copy = null): void
115		{
116	1	$this->assertStarted();
117
118	1	$data = isset($copy) ? $copy($_SESSION) : [];
119
120	1	$_SESSION = [];
121	1	$this->regenerateId(true);
122
123	1	$_SESSION = $data;
124	1	}
125
126		/**
127		* Wrapper around `session_regenerate_id()`
128		* @codeCoverageIgnore
129		*/
130		protected function regenerateId(bool $delete): void
131		{
132		session_regenerate_id($delete);
133		}
134
135
136		/**
137		* @param string $offset
138		* @return bool
139		*/
140	1	public function offsetExists($offset): bool
141		{
142	1	$this->assertStarted();
143
144	1	return array_key_exists($offset, $_SESSION);
145		}
146
147		/**
148		* @param string $offset
149		* @return mixed
150		*/
151	1	public function offsetGet($offset)
152		{
153	1	$this->assertStarted();
154
155	1	return $_SESSION[$offset];
156		}
157
158		/**
159		* @param string $offset
160		* @param mixed $value
161		*/
162	4	public function offsetSet($offset, $value): void
		0 ignored issues – show introduced 2020-04-16 00:07 UTC by Report Bug Copy Issue Report Parameter #1 $offset (string) of method Jasny\Session\GlobalSession::offsetSet() should be contravariant with parameter $offset (string\|null) of method ArrayAccess<string,mixed>::offsetSet() Loading history...
163		{
164	4	$this->assertStarted();
165
166	3	$_SESSION[$offset] = $value;
167	3	}
168
169		/**
170		* @param string $offset
171		*/
172	1	public function offsetUnset($offset): void
173		{
174	1	$this->assertStarted();
175
176	1	unset($_SESSION[$offset]);
177	1	}
178
179
180		/**
181		* Assert that there is an active session.
182		*
183		* @throws NoSessionException
184		*/
185	7	protected function assertStarted(): void
186		{
187	7	if (session_status() !== \PHP_SESSION_ACTIVE) {
188	1	throw new NoSessionException("Session not started");
189		}
190	6	}
191		}
192

jasny / session-middleware

GlobalSession::clear() A last analyzed 2020-04-17 00:48 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

GlobalSession::clear() A
last analyzed 2020-04-17 00:48 UTC