Session::destroy() - Code Metrics - Inspection of "sonar-scanner added" - linna/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 76c58c...a7ff4a )

by Sebastian
created 2020-09-08 18:09 UTC
Session::destroy() A

↳ Parent: Session
Complexity

Conditions	1
Paths	1
Size

Total Lines	14
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	6
CRAP Score	1
Importance

Changes	1
Bugs	1	Features	0
Metric	Value
eloc	5
c	1
b	1
f	0
dl	0
loc	14
ccs	6
cts	6
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1
<?php

/**
 * Linna Framework.
 *
 * @author Sebastian Rapetti <[email protected]>
 * @copyright (c) 2018, Sebastian Rapetti
 * @license http://opensource.org/licenses/MIT MIT License
 */
declare(strict_types=1);

namespace Linna\Session;

use ArrayAccess;
use SessionHandlerInterface;

/**
 * Manage session lifetime and session data.
 *
 * @property int   $time      Time of session
 * @property array $login     Login information set by Login class
 * @property int   $loginTime Login time set by Login class
 * @property int   $expire    Login time set for Login class
 */
class Session implements ArrayAccess
{
    use PropertyAccessTrait;
    use ArrayAccessTrait;

    /**
     * @var int Session expire time in seconds.
     */
    private int $expire = 1800;

    /**
     * @var string Cookie domain.
     */
    private string $cookieDomain = '/';

    /**
     * @var string Coockie path.
     */
    private string $cookiePath = '/';

    /**
     * @var bool Cookie transmitted over https only?.
     */
    private bool $cookieSecure = false;

    /**
     * @var bool Cookie accessible only through http?.
     */
    private bool $cookieHttpOnly = true;

    /**
     *
     * @var string Cookie same site for cross site requests.
     */
    private string $cookieSameSite = 'lax';

    /**
     * @var array<mixed> Session data reference property
     */
    private array $data = [];

    /**
     * @var string Session id
     */
    public string $id = '';

    /**
     * @var string Session name
     */
    public string $name = 'linna_session';

    /**
     * @var int session_status function result
     */
    public int $status = 0;

    /**
     * Constructor.
     *
     * @param array<mixed> $options
     */
    public function __construct(array $options = [])
    {
        [
            'expire'         => $this->expire,
            'name'           => $this->name,
            'cookieDomain'   => $this->cookieDomain,
            'cookiePath'     => $this->cookiePath,
            'cookieSecure'   => $this->cookieSecure,
            'cookieHttpOnly' => $this->cookieHttpOnly
        ] = \array_replace_recursive([
            'expire'         => $this->expire,
            'name'           => $this->name,
            'cookieDomain'   => $this->cookieDomain,
            'cookiePath'     => $this->cookiePath,
            'cookieSecure'   => $this->cookieSecure,
            'cookieHttpOnly' => $this->cookieHttpOnly
        ], $options);

        $this->status = \session_status();
    }

    /**
     * Regenerate session_id without double cookie problem.
     *
     * @return void
     */
    public function regenerate(): void
    {
        //regenerate session id
        \session_regenerate_id();

        //store new session data
        $this->setSessionData(\time());
    }

    /**
     * Start session.
     *
     * @return void
     */
    public function start(): void
    {
        if (\session_status() !== PHP_SESSION_ACTIVE) {

            //prepare the session start
            \session_name($this->name);

            //start session
            \session_start([
                'cookie_path'      => $this->cookiePath,
                'cookie_domain'    => $this->cookieDomain,
                'cookie_lifetime'  => $this->expire,//($this->expire > 0) ? time() + $this->expire : 0,
                'cookie_secure'    => $this->cookieSecure,
                'cookie_httponly'  => $this->cookieHttpOnly,
                'cookie_samesite'  => $this->cookieSameSite
            ]);

            //link session super global to $data property
            $this->data = &$_SESSION;
        }

        //refresh session
        $this->refresh();
    }

    /**
     * Refresh session.
     *
     * @return void
     */
    private function refresh(): void
    {
        $time = \time();

        if (isset($this->data['time']) && $this->data['time'] <= ($time - $this->expire)) {

            //delete session data
            $this->data = [];

            //regenerate session
            $this->regenerate();
        }

        $this->setSessionData($time);

        //it fix the behavior of session that die because it does not refresh
        //expiration time, also if present user interaction, with browser.

        //PHP 7.2 version
        /*\setcookie($this->name, $this->id,
            $this->expire, //($this->expire > 0) ? time() + $this->expire : 0, //expire
            //($time + $this->expire),    //expire
            $this->cookiePath,          //path
            $this->cookieDomain,        //domain
            $this->cookieSecure,        //secure
            $this->cookieHttpOnly       //http only
        );*/

        //PHP 7.3 version
        //https://www.php.net/manual/en/migration73.other-changes.php
        \setcookie($this->name, $this->id, [
        \setcookie($this->name, $this->id, /** @scrutinizer ignore-type */ [
            'path'      => $this->cookiePath,
            'domain'    => $this->cookieDomain,
            'expires'   => $time + $this->expire,
            'secure'    => $this->cookieSecure,
            'httponly'  => $this->cookieHttpOnly,
            'samesite'  => $this->cookieSameSite
        ]);
    }

    /**
     * Set Session Data.
     *
     * @param int $time
     *
     * @return void
     */
    private function setSessionData(int $time): void
    {
        $this->id = \session_id();
        $this->data['time'] = $time;
        $this->data['expire'] = $this->expire;
        //$this->data['server'] = $_SERVER;
        $this->status = \session_status();
    }

    /**
     * Set session handler for new instance.
     *
     * @param SessionHandlerInterface $handler
     *
     * @return void
     */
    public function setSessionHandler(SessionHandlerInterface $handler): void
    {
        //setting a different save handler if passed
        \session_set_save_handler($handler, true);
    }

    /**
     * Destroy session.
     *
     * @return void
     */
    public function destroy(): void
    {
        //delete session data
        $this->data = [];
        $this->id = '';

        //destroy cookie
        \setcookie($this->name, 'NothingToSeeHere.', \time());

        //call session destroy
        \session_destroy();

        //update status
        $this->status = \session_status();
    }

    /**
     * Write session data and end session.
     *
     * @return void
     */
    public function commit(): void
    {
        \session_write_close();

        //update status
        $this->status = \session_status();
    }
}

linna / framework

Push — master ( 76c58c...a7ff4a )

Session::destroy() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
