ServerCache::dump() - Code Metrics - Inspection of "fix request method recognition in server cache" - comodojo/dispatcher.framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 4.0 ( e97ee6...38d142 )

by Marco

created 2016-08-09 21:14 UTC

ServerCache::dump() B

↳ Parent: ServerCache

Complexity

Conditions	5
Paths	2

Size

Total Lines	28
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	28
ccs	0
cts	19
cp	0
rs	8.439
cc	5
eloc	15
nc	2
nop	4
crap	30

<?php namespace Comodojo\Dispatcher\Components;

use \Comodojo\Dispatcher\Request\Model as Request;
use \Comodojo\Dispatcher\Router\Route;
use \Comodojo\Dispatcher\Response\Model as Response;
use \Comodojo\Cache\Cache;

/**
 * @package     Comodojo Dispatcher
 * @author      Marco Giovinazzi <[email protected]>
 * @author      Marco Castiello <[email protected]>
 * @license     GPL-3.0+
 *
 * LICENSE:
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */


class ServerCache {
    
    // @NOTE: Server cache will not consider cacheable POST or PUT requests
    //        because of dispatcher internal structure: if post request is cached
    //        subsequent requests will never reach the service.
    private static $cachable_methods = array('GET', 'HEAD');
    
    private static $cachable_statuses = array(200, 203, 300, 301, 302, 404, 410);
    
    public static function read(
        Request $request,
        Response $response,
        Cache $cache
    ) {

        $name = (string) $request->method . (string) $this->request->uri;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        $cache_object = $this->cache->setNamespace('dispatcherservice')->get($name);
class MyClass { }

$x = new MyClass();
$x->foo = true;

        if ( is_null($cache_object) ) return false;

        $response->import($cache);

        return true;

    }

    public static function dump(
        Request $request,
        Response $response,
        Route $route,
        Cache $cache

    ) {

        $cache = strtoupper($route->getParameter('cache'));

        $ttl = $route->getParameter('ttl');

        $name = (string) $request->method . (string) $request->uri;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        $method = $request->method->get();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        $status = $response->status->get();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        if (
            ( $cache == 'SERVER' || $cache == 'BOTH' ) &&
            in_array($method, self::$cachable_methods) &&
            in_array($status, self::$cachable_statuses)
        ){

            $cache->setNamespace('dispatcherservice')->set($name, $response->export(), $ttl);


        }

    }
    
}


1			<?php namespace Comodojo\Dispatcher\Components;
2
3			use \Comodojo\Dispatcher\Request\Model as Request;
4			use \Comodojo\Dispatcher\Router\Route;
5			use \Comodojo\Dispatcher\Response\Model as Response;
6			use \Comodojo\Cache\Cache;
7
8			/**
9			* @package Comodojo Dispatcher
10			* @author Marco Giovinazzi <[email protected]>
11			* @author Marco Castiello <[email protected]>
12			* @license GPL-3.0+
13			*
14			* LICENSE:
15			*
16			* This program is free software: you can redistribute it and/or modify
17			* it under the terms of the GNU Affero General Public License as
18			* published by the Free Software Foundation, either version 3 of the
19			* License, or (at your option) any later version.
20			*
21			* This program is distributed in the hope that it will be useful,
22			* but WITHOUT ANY WARRANTY; without even the implied warranty of
23			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24			* GNU Affero General Public License for more details.
25			*
26			* You should have received a copy of the GNU Affero General Public License
27			* along with this program. If not, see <http://www.gnu.org/licenses/>.
28			*/
29
30
31			class ServerCache {
32
33			// @NOTE: Server cache will not consider cacheable POST or PUT requests
34			// because of dispatcher internal structure: if post request is cached
35			// subsequent requests will never reach the service.
36			private static $cachable_methods = array('GET', 'HEAD');
37
38			private static $cachable_statuses = array(200, 203, 300, 301, 302, 404, 410);
39
40			public static function read(
41			Request $request,
42			Response $response,
43			Cache $cache
44			) {
45
46			$name = (string) $request->method . (string) $this->request->uri;
			0 ignored issues – show Documentation introduced 2016-08-09 21:17 UTC by Report Bug Copy Issue Report The property `method` does not exist on `object<Comodojo\Dispatcher\Request\Model>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Bug introduced 2016-08-09 21:17 UTC by Report Bug Copy Issue Report The property `request` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2016-08-09 21:17 UTC by Report Bug Copy Issue Report The variable `$this` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
47
48			$cache_object = $this->cache->setNamespace('dispatcherservice')->get($name);
			0 ignored issues – show Bug introduced 2016-08-09 21:17 UTC by Report Bug Copy Issue Report The property `cache` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
49
50			if ( is_null($cache_object) ) return false;
51
52			$response->import($cache);
53
54			return true;
55
56			}
57
58			public static function dump(
59			Request $request,
60			Response $response,
61			Route $route,
62			Cache $cache
			0 ignored issues – show Unused Code introduced 2016-08-09 21:17 UTC by Report Bug Copy Issue Report The parameter `$cache` 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...
63			) {
64
65			$cache = strtoupper($route->getParameter('cache'));
66
67			$ttl = $route->getParameter('ttl');
68
69			$name = (string) $request->method . (string) $request->uri;
			0 ignored issues – show Documentation introduced 2016-08-09 21:17 UTC by Report Bug Copy Issue Report The property `method` does not exist on `object<Comodojo\Dispatcher\Request\Model>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2016-08-09 21:17 UTC by Report Bug Copy Issue Report The property `uri` does not exist on `object<Comodojo\Dispatcher\Request\Model>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
70
71			$method = $request->method->get();
			0 ignored issues – show Documentation introduced 2016-08-09 21:17 UTC by Report Bug Copy Issue Report The property `method` does not exist on `object<Comodojo\Dispatcher\Request\Model>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
72
73			$status = $response->status->get();
			0 ignored issues – show Documentation introduced 2016-08-09 21:17 UTC by Report Bug Copy Issue Report The property `status` does not exist on `object<Comodojo\Dispatcher\Response\Model>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
74
75			if (
76			( $cache == 'SERVER' \|\| $cache == 'BOTH' ) &&
77			in_array($method, self::$cachable_methods) &&
78			in_array($status, self::$cachable_statuses)
79			){
80
81			$cache->setNamespace('dispatcherservice')->set($name, $response->export(), $ttl);
			0 ignored issues – show Bug introduced 2016-08-09 21:17 UTC by Report Bug Copy Issue Report The method `setNamespace` cannot be called on `$cache` (of type `string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
82
83			}
84
85			}
86
87			}
88

comodojo / dispatcher.framework

Push — 4.0 ( e97ee6...38d142 )

ServerCache::dump() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like