Model::__construct() - Code Metrics - Inspection of "moving to foundation" - comodojo/dispatcher.framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 4.0 ( bcbbe3...4201d3 )

by Marco

created 2017-01-09 10:44 UTC

Model::__construct() A

↳ Parent: Model

Complexity

Conditions	1
Paths	1

Size

Total Lines	16
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	16
ccs	12
cts	12
cp	1
rs	9.4285
c	1
b	0
f	0
cc	1
eloc	11
nc	1
nop	2
crap	1

<?php namespace Comodojo\Dispatcher\Request;

use \Comodojo\Dispatcher\Components\AbstractModel;
use \Comodojo\Foundation\Timing\TimingTrait;
use \Comodojo\Foundation\Base\Configuration;
use \League\Uri\Schemes\Http as HttpUri;
use \Psr\Log\LoggerInterface;

/**
 * @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 Model extends AbstractModel {

    use TimingTrait;

    protected $mode = self::READONLY;

    public function __construct(Configuration $configuration, LoggerInterface $logger) {
// 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);
    }
}

        parent::__construct($configuration, $logger);

        $this->setTiming($_SERVER['REQUEST_TIME_FLOAT']);

        $this->setRaw('headers', new Headers());
        $this->setRaw('uri', HttpUri::createFromServer($_SERVER));
        $this->setRaw('post', new Post());
        $this->setRaw('query', new Query());
        $this->setRaw('useragent', new UserAgent());
        $this->setRaw('method', new Method());
        $this->setRaw('version', new Version());
        $this->setRaw('files', Files::load());

    }

    public function route() {

        return str_replace($this->configuration->get("base-uri"), "", $this->uri->getPath());
<?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.");
        }
    }

}

    }

}


1		<?php namespace Comodojo\Dispatcher\Request;
2
3		use \Comodojo\Dispatcher\Components\AbstractModel;
4		use \Comodojo\Foundation\Timing\TimingTrait;
5		use \Comodojo\Foundation\Base\Configuration;
6		use \League\Uri\Schemes\Http as HttpUri;
7		use \Psr\Log\LoggerInterface;
8
9		/**
10		* @package Comodojo Dispatcher
11		* @author Marco Giovinazzi <[email protected]>
12		* @author Marco Castiello <[email protected]>
13		* @license GPL-3.0+
14		*
15		* LICENSE:
16		*
17		* This program is free software: you can redistribute it and/or modify
18		* it under the terms of the GNU Affero General Public License as
19		* published by the Free Software Foundation, either version 3 of the
20		* License, or (at your option) any later version.
21		*
22		* This program is distributed in the hope that it will be useful,
23		* but WITHOUT ANY WARRANTY; without even the implied warranty of
24		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25		* GNU Affero General Public License for more details.
26		*
27		* You should have received a copy of the GNU Affero General Public License
28		* along with this program. If not, see <http://www.gnu.org/licenses/>.
29		*/
30
31		class Model extends AbstractModel {
32
33		use TimingTrait;
34
35		protected $mode = self::READONLY;
36
37	5	public function __construct(Configuration $configuration, LoggerInterface $logger) {
		0 ignored issues – show Coding Style introduced 2016-01-11 23:45 UTC by Report Bug Copy Issue Report `__construct` uses the super-global variable `$_SERVER` 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...
38
39	5	parent::__construct($configuration, $logger);
40
41	5	$this->setTiming($_SERVER['REQUEST_TIME_FLOAT']);
42
43	5	$this->setRaw('headers', new Headers());
44	5	$this->setRaw('uri', HttpUri::createFromServer($_SERVER));
45	5	$this->setRaw('post', new Post());
46	5	$this->setRaw('query', new Query());
47	5	$this->setRaw('useragent', new UserAgent());
48	5	$this->setRaw('method', new Method());
49	5	$this->setRaw('version', new Version());
50	5	$this->setRaw('files', Files::load());
51
52	5	}
53
54	1	public function route() {
55
56	1	return str_replace($this->configuration->get("base-uri"), "", $this->uri->getPath());
		0 ignored issues – show Documentation introduced 2016-08-16 22:22 UTC by Report Bug Copy Issue Report The property `configuration` 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-07-28 22:59 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...
57
58		}
59
60		}
61

comodojo / dispatcher.framework

Push — 4.0 ( bcbbe3...4201d3 )

Model::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like