ByPass::extensionHandles() - Code Metrics - phossa2/libs - Measure and Improve Code Quality continuously with Scrutinizer

ByPass::extensionHandles() A
last analyzed 2016-10-12 00:59 UTC

↳ Parent: ByPass

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0

<?php
/**
 * Phossa Project
 *
 * PHP version 5.4
 *
 * @category  Library
 * @package   Phossa2\Cache
 * @copyright Copyright (c) 2016 phossa.com
 * @license   http://mit-license.org/ MIT License
 * @link      http://www.phossa.com/
 */
/*# declare(strict_types=1); */

namespace Phossa2\Cache\Extension;

use Phossa2\Cache\CachePool;
use Phossa2\Cache\Message\Message;
use Phossa2\Event\Interfaces\EventInterface;
use Phossa2\Event\EventableExtensionAbstract;

/**
 * ByPass extension
 *
 * Bypass the cache if URL has 'nocache=true' set
 *
 * ```php
 * $ext = new ByPass(['trigger' => 'nocache']);
 *
 * // enable this ext
 * $cachePool->addExtension($ext);
 * ```
 *
 * @package Phossa2\Cache
 * @author  Hong Zhang <[email protected]>
 * @see     EventableExtensionAbstract
 * @see     CachePool
 * @version 2.0.1
 * @since   2.0.0 added
 * @since   2.0.1 moved to EventableExtensionAbstract
 */
class ByPass extends EventableExtensionAbstract
{
    /**
     * bypass trigger in the url
     *
     * @var    string
     * @access protected
     */
    protected $trigger = 'nocache';

    /**
     * {@inheritDoc}
     */
    public function methodsAvailable()/*# : array */
    {
        return ['byPassCache'];
    }

    /**
     * {@inheritDoc}
     */
    protected function extensionHandles()/*# : array */
    {
        return [
            ['event' => 'cache.*', 'handler' => ['byPassCache', 100]]
        ];
    }

    /**
     * Skip the cache
     *
     * 1. $this->trigger = '', always bypass the cache
     * 2. if sees $this->trigger in $_REQUEST, bypass the cache
     *
     * @param  EventInterface $event
     * @return bool
     * @access public
     */
    public function byPassCache(EventInterface $event)/*# : bool */
// 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);
    }
}
    {
        /* @var CachePool $pool */
        $pool = $event->getTarget();

        if ($this->trigger === '' || isset($_REQUEST[$this->trigger])) {
            return $pool->setError(
                Message::get(Message::CACHE_EXT_BYPASS),
                Message::CACHE_EXT_BYPASS
            );
        } else {
            return true;
        }
    }
}


1			<?php
2			/**
3			* Phossa Project
4			*
5			* PHP version 5.4
6			*
7			* @category Library
8			* @package Phossa2\Cache
9			* @copyright Copyright (c) 2016 phossa.com
10			* @license http://mit-license.org/ MIT License
11			* @link http://www.phossa.com/
12			*/
13			/# declare(strict_types=1); /
14
15			namespace Phossa2\Cache\Extension;
16
17			use Phossa2\Cache\CachePool;
18			use Phossa2\Cache\Message\Message;
19			use Phossa2\Event\Interfaces\EventInterface;
20			use Phossa2\Event\EventableExtensionAbstract;
21
22			/**
23			* ByPass extension
24			*
25			* Bypass the cache if URL has 'nocache=true' set
26			*
27			* ```php
28			* $ext = new ByPass(['trigger' => 'nocache']);
29			*
30			* // enable this ext
31			* $cachePool->addExtension($ext);
32			* ```
33			*
34			* @package Phossa2\Cache
35			* @author Hong Zhang <[email protected]>
36			* @see EventableExtensionAbstract
37			* @see CachePool
38			* @version 2.0.1
39			* @since 2.0.0 added
40			* @since 2.0.1 moved to EventableExtensionAbstract
41			*/
42			class ByPass extends EventableExtensionAbstract
43			{
44			/**
45			* bypass trigger in the url
46			*
47			* @var string
48			* @access protected
49			*/
50			protected $trigger = 'nocache';
51
52			/**
53			* {@inheritDoc}
54			*/
55			public function methodsAvailable()/# : array /
56			{
57			return ['byPassCache'];
58			}
59
60			/**
61			* {@inheritDoc}
62			*/
63			protected function extensionHandles()/# : array /
64			{
65			return [
66			['event' => 'cache.*', 'handler' => ['byPassCache', 100]]
67			];
68			}
69
70			/**
71			* Skip the cache
72			*
73			* 1. $this->trigger = '', always bypass the cache
74			* 2. if sees $this->trigger in $_REQUEST, bypass the cache
75			*
76			* @param EventInterface $event
77			* @return bool
78			* @access public
79			*/
80			public function byPassCache(EventInterface $event)/# : bool /
			0 ignored issues – show Coding Style introduced 2016-09-27 11:59 UTC by Report Bug Copy Issue Report `byPassCache` 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...
81			{
82			/* @var CachePool $pool */
83			$pool = $event->getTarget();
84
85			if ($this->trigger === '' \|\| isset($_REQUEST[$this->trigger])) {
86			return $pool->setError(
87			Message::get(Message::CACHE_EXT_BYPASS),
88			Message::CACHE_EXT_BYPASS
89			);
90			} else {
91			return true;
92			}
93			}
94			}
95

phossa2 / libs

ByPass::extensionHandles() A last analyzed 2016-10-12 00:59 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ByPass::extensionHandles() A
last analyzed 2016-10-12 00:59 UTC