SessionManager::__construct() - Code Metrics - ByTIC/framework - Measure and Improve Code Quality continuously with Scrutinizer

SessionManager::__construct() A
last analyzed 2017-08-07 20:36 UTC

↳ Parent: SessionManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Nip\Session;

use Nip\Application;
use Nip\Cookie\Jar as CookieJar;

/**
 * Class SessionManager
 * @package Nip\Session
 */
class SessionManager
{
    protected $id;

    protected $_lifetime;

    /**
     * SessionManager constructor.
     * @param Application $app
     */
    public function __construct(Application $app)

    {
        $this->_lifetime = get_cfg_var("session.gc_maxlifetime");

//		ini_set('session.save_handler', 'user');

        register_shutdown_function('session_write_close');
    }

    public function init()
    {
        $id = $this->checkRequestId();
        $this->start($id);
    }

    /**
     * Gets the session ID from REQUEST
     * @return int
     */
    public function checkRequestId()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (isset($_REQUEST['session_id'])) {
            return $_REQUEST['session_id'];
        }

        return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Starts the session, with optional session id
     * @param string|boolean $id
     */
    protected function start($id = false)
    {
        if ($id) {
            session_id($id);
        }
        session_start();
    }

    /**
     * Restarts the session, with new optional session id
     *
     * @param string|boolean $id
     */
    public function reinitialize($id = false)
    {
        session_write_close();
        $this->start($id);
    }

    /**
     * Public method to return the session id
     * @todo implement a verification method ( ex: adding another validation string in the sessionID )
     * @return int
     */
    public function getId()
    {
        return session_id();
    }

    /**
     * @param int $lifetime
     * @return $this
     */
    public function setLifetime($lifetime)
    {
        if ($lifetime && is_numeric($lifetime)) {
            $this->_lifetime = $lifetime;
        }

        return $this;
    }

    /**
     * @param $domain
     */
    public function setRootDomain($domain)
    {
        if ($domain !== 'localhost') {
            ini_set('session.cookie_domain', '.'.$domain);
        }

        CookieJar::instance()->setDefaults(
            ['domain' => '.' . $domain]
        );
    }

    /**
     * @return bool
     */
    public function isAutoStart()
    {
        return ini_get('session.auto_start') && (strtolower(ini_get('session.auto_start')) == 'on');
    }
}


1			<?php
2
3			namespace Nip\Session;
4
5			use Nip\Application;
6			use Nip\Cookie\Jar as CookieJar;
7
8			/**
9			* Class SessionManager
10			* @package Nip\Session
11			*/
12			class SessionManager
13			{
14			protected $id;
15
16			protected $_lifetime;
17
18			/**
19			* SessionManager constructor.
20			* @param Application $app
21			*/
22			public function __construct(Application $app)
			0 ignored issues – show Unused Code introduced 2017-08-03 19:41 UTC by Report Bug Copy Issue Report The parameter `$app` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
23			{
24			$this->_lifetime = get_cfg_var("session.gc_maxlifetime");
25
26			// ini_set('session.save_handler', 'user');
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-20 20:47 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
27			register_shutdown_function('session_write_close');
28			}
29
30			public function init()
31			{
32			$id = $this->checkRequestId();
33			$this->start($id);
34			}
35
36			/**
37			* Gets the session ID from REQUEST
38			* @return int
39			*/
40			public function checkRequestId()
			0 ignored issues – show Coding Style introduced 2017-08-03 19:41 UTC by Report Bug Copy Issue Report `checkRequestId` uses the super-global variable `$_REQUEST` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
41			{
42			if (isset($_REQUEST['session_id'])) {
43			return $_REQUEST['session_id'];
44			}
45
46			return false;
			0 ignored issues – show Bug Best Practice introduced 2017-07-29 13:16 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `Nip\Session\SessionManager::checkRequestId` of type `integer`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
47			}
48
49			/**
50			* Starts the session, with optional session id
51			* @param string\|boolean $id
52			*/
53			protected function start($id = false)
54			{
55			if ($id) {
56			session_id($id);
57			}
58			session_start();
59			}
60
61			/**
62			* Restarts the session, with new optional session id
63			*
64			* @param string\|boolean $id
65			*/
66			public function reinitialize($id = false)
67			{
68			session_write_close();
69			$this->start($id);
70			}
71
72			/**
73			* Public method to return the session id
74			* @todo implement a verification method ( ex: adding another validation string in the sessionID )
75			* @return int
76			*/
77			public function getId()
78			{
79			return session_id();
80			}
81
82			/**
83			* @param int $lifetime
84			* @return $this
85			*/
86			public function setLifetime($lifetime)
87			{
88			if ($lifetime && is_numeric($lifetime)) {
89			$this->_lifetime = $lifetime;
90			}
91
92			return $this;
93			}
94
95			/**
96			* @param $domain
97			*/
98			public function setRootDomain($domain)
99			{
100			if ($domain !== 'localhost') {
101			ini_set('session.cookie_domain', '.'.$domain);
102			}
103
104			CookieJar::instance()->setDefaults(
105			['domain' => '.' . $domain]
106			);
107			}
108
109			/**
110			* @return bool
111			*/
112			public function isAutoStart()
113			{
114			return ini_get('session.auto_start') && (strtolower(ini_get('session.auto_start')) == 'on');
115			}
116			}
117

ByTIC / framework

GitHub Access Token became invalid

SessionManager::__construct() A last analyzed 2017-08-07 20:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

SessionManager::__construct() A
last analyzed 2017-08-07 20:36 UTC