Graph::graph() - Code Metrics - Inspection of "Update deps" - PowerKiKi/mqueue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ca1336...ce2897 )

by Adrien

created 2016-08-08 10:12 UTC

Graph::graph() B

↳ Parent: Graph

Complexity

Conditions	2
Paths	2

Size

Total Lines	34
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	2.0023

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
cc	2
eloc	14
c	3
b	1
f	0
nc	2
nop	1
dl	0
loc	34
ccs	11
cts	12
cp	0.9167
crap	2.0023
rs	8.8571

<?php

namespace mQueue\View\Helper;

use mQueue\Model\User;
use Zend_View_Helper_Abstract;

class Graph extends Zend_View_Helper_Abstract
{
    /**
     * Returns a graph for everybody or single user
     * @param \mQueue\Model\User $user

     * @return string
     */
    public function graph(\mQueue\Model\User $user = null)

    {
        $params = ['controller' => 'status', 'action' => 'graph'];
        if ($user) {
            $params['user'] = $user->id;
<?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.");
        }
    }

}
        }
        $url = $this->view->serverUrl() . $this->view->url($params, 'default');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        $js = <<<STRING

        $(document).ready(function() {
            var refreshGraph = function() {
                var percentage = $('#graph_percent').is(':checked') ? '?percent=1' : '';
                $.get('$url' + percentage, function (chart) {
                    chart = $.parseJSON(chart);
                    $('#chart_container').highcharts(chart);
                });
            };

            $('#graph_percent').change(refreshGraph);
            refreshGraph();

        });
STRING;

        $html = '<div id="chart_container"  style="min-height: 400px"></div>
                <input type="checkbox" name="graph_percent" id="graph_percent" value="1">
                <label for="graph_percent">Show graph as stacked percentage</label>';

        $this->view->headScript()
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                ->appendFile('/js/min/highcharts.js')
                ->appendScript($js);

        return $html;
    }
}


Push — master ( ca1336...ce2897 )

Graph::graph() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		namespace mQueue\View\Helper;
4
5		use mQueue\Model\User;
6		use Zend_View_Helper_Abstract;
7
8		class Graph extends Zend_View_Helper_Abstract
9		{
10		/**
11		* Returns a graph for everybody or single user
12		* @param \mQueue\Model\User $user
		0 ignored issues – show Documentation introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report Should the type for parameter `$user` not be `null\|User`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
13		* @return string
14		*/
15	1	public function graph(\mQueue\Model\User $user = null)
		0 ignored issues – show Coding Style Best Practice introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report Please use `__construct()` instead of a PHP4-style constructor that is named after the class. Loading history...
16		{
17	1	$params = ['controller' => 'status', 'action' => 'graph'];
18	1	if ($user) {
19		$params['user'] = $user->id;
		0 ignored issues – show Documentation introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<mQueue\Model\User>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
20		}
21	1	$url = $this->view->serverUrl() . $this->view->url($params, 'default');
		2 ignored issues – show Bug introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend_View_Interface` as the method `serverUrl()` does only exist in the following implementations of said interface: `Zend_View`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string / public function getDisplayName(); } Loading history... Bug introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend_View_Interface` as the method `url()` does only exist in the following implementations of said interface: `Zend_View`. Let’s take a look at an example: interface User { /* @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
22
23		$js = <<<STRING
		0 ignored issues – show Comprehensibility introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report Avoid variables with short names like $js. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
24		$(document).ready(function() {
25		var refreshGraph = function() {
26		var percentage = $('#graph_percent').is(':checked') ? '?percent=1' : '';
27	1	$.get('$url' + percentage, function (chart) {
28		chart = $.parseJSON(chart);
29		$('#chart_container').highcharts(chart);
30		});
31		};
32
33		$('#graph_percent').change(refreshGraph);
34		refreshGraph();
35
36	1	});
37		STRING;
38
39		$html = '<div id="chart_container" style="min-height: 400px"></div>
40		<input type="checkbox" name="graph_percent" id="graph_percent" value="1">
41	1	<label for="graph_percent">Show graph as stacked percentage</label>';
42
43	1	$this->view->headScript()
		1 ignored issue – show Bug introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend_View_Interface` as the method `headScript()` does only exist in the following implementations of said interface: `Zend_View`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
44	1	->appendFile('/js/min/highcharts.js')
45	1	->appendScript($js);
46
47	1	return $html;
48		}
49		}
50

PowerKiKi / mqueue

Push — master ( ca1336...ce2897 )

Graph::graph() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like