SessionCacheEngine - Code Metrics - Inspection of "4.0" - byjg/cache-engine-php - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#2)

by Joao

created 2017-05-27 19:07 UTC

SessionCacheEngine A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	0
loc	97
c	0
b	0
f	0
wmc	18
lcom	1
cbo	1
rs	10

9 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	checkSession()	6	2
A	keyName()	4	1
A	get()	12	2
A	delete()	13	3
A	set()	10	2
A	clear()	4	1
A	has()	15	4
A	isAvailable()	9	2

<?php

namespace ByJG\Cache\Psr16;

class SessionCacheEngine extends BaseCacheEngine
{

    protected $prefix = null;

    /**
     * SessionCacheEngine constructor.
     *
     * @param string $prefix
     */
    public function __construct($prefix = 'cache')
    {
        $this->prefix = $prefix;
    }


    protected function checkSession()
    {
        if (session_status() == PHP_SESSION_NONE) {
            session_start();
        }
    }

    protected function keyName($key)
    {
        return $this->prefix . '-' . $key;
    }

    public function get($key, $default = null)
// 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);
    }
}
    {
        $this->checkSession();

        $keyName = $this->keyName($key);

        if ($this->has($key)) {
            return $_SESSION[$keyName];
        } else {
            return $default;
        }
    }

    public function delete($key)
// 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);
    }
}
    {
        $this->checkSession();

        $keyName = $this->keyName($key);

        if (isset($_SESSION[$keyName])) {
            unset($_SESSION[$keyName]);
        }
        if (isset($_SESSION["$keyName.ttl"])) {
            unset($_SESSION["$keyName.ttl"]);
        }
    }

    public function set($key, $value, $ttl = null)
// 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);
    }
}
    {
        $this->checkSession();

        $keyName = $this->keyName($key);
        $_SESSION[$keyName] = $value;
        if (!empty($ttl)) {
            $_SESSION["$keyName.ttl"] = $this->addToNow($ttl);
        }
    }

    public function clear()
    {
        session_destroy();
    }

    public function has($key)
// 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);
    }
}
    {
        $keyName = $this->keyName($key);

        if (isset($_SESSION[$keyName])) {
            if (isset($_SESSION["$keyName.ttl"]) && time() >= $_SESSION["$keyName.ttl"]) {
                $this->delete($key);
                return false;
            }

            return true;
        }

        return false;
    }

    public function isAvailable()
    {
        try {
            $this->checkSession();
            return true;
        } catch (\Exception $ex) {
            return false;
        }
    }
}


1			<?php
2
3			namespace ByJG\Cache\Psr16;
4
5			class SessionCacheEngine extends BaseCacheEngine
6			{
7
8			protected $prefix = null;
9
10			/**
11			* SessionCacheEngine constructor.
12			*
13			* @param string $prefix
14			*/
15			public function __construct($prefix = 'cache')
16			{
17			$this->prefix = $prefix;
18			}
19
20
21			protected function checkSession()
22			{
23			if (session_status() == PHP_SESSION_NONE) {
24			session_start();
25			}
26			}
27
28			protected function keyName($key)
29			{
30			return $this->prefix . '-' . $key;
31			}
32
33			public function get($key, $default = null)
			0 ignored issues – show Coding Style introduced 2017-05-27 19:01 UTC by Report Bug Copy Issue Report `get` uses the super-global variable `$_SESSION` 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...
34			{
35			$this->checkSession();
36
37			$keyName = $this->keyName($key);
38
39			if ($this->has($key)) {
40			return $_SESSION[$keyName];
41			} else {
42			return $default;
43			}
44			}
45
46			public function delete($key)
			0 ignored issues – show Coding Style introduced 2017-05-27 19:01 UTC by Report Bug Copy Issue Report `delete` uses the super-global variable `$_SESSION` 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...
47			{
48			$this->checkSession();
49
50			$keyName = $this->keyName($key);
51
52			if (isset($_SESSION[$keyName])) {
53			unset($_SESSION[$keyName]);
54			}
55			if (isset($_SESSION["$keyName.ttl"])) {
56			unset($_SESSION["$keyName.ttl"]);
57			}
58			}
59
60			public function set($key, $value, $ttl = null)
			0 ignored issues – show Coding Style introduced 2017-05-27 19:01 UTC by Report Bug Copy Issue Report `set` uses the super-global variable `$_SESSION` 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...
61			{
62			$this->checkSession();
63
64			$keyName = $this->keyName($key);
65			$_SESSION[$keyName] = $value;
66			if (!empty($ttl)) {
67			$_SESSION["$keyName.ttl"] = $this->addToNow($ttl);
68			}
69			}
70
71			public function clear()
72			{
73			session_destroy();
74			}
75
76			public function has($key)
			0 ignored issues – show Coding Style introduced 2017-05-27 19:01 UTC by Report Bug Copy Issue Report `has` uses the super-global variable `$_SESSION` 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...
77			{
78			$keyName = $this->keyName($key);
79
80			if (isset($_SESSION[$keyName])) {
81			if (isset($_SESSION["$keyName.ttl"]) && time() >= $_SESSION["$keyName.ttl"]) {
82			$this->delete($key);
83			return false;
84			}
85
86			return true;
87			}
88
89			return false;
90			}
91
92			public function isAvailable()
93			{
94			try {
95			$this->checkSession();
96			return true;
97			} catch (\Exception $ex) {
98			return false;
99			}
100			}
101			}
102

byjg / cache-engine-php

Pull Request — master (#2)

SessionCacheEngine A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

Duplication Side-by-Side

Filter issues like