ApiListingControl::__construct() - Code Metrics - Inspection of "Added endpoint listing component" - tomaj/nette-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bc4ddd...54781a )

by Tomas

created 2015-12-25 20:27 UTC

ApiListingControl::__construct() A

↳ Parent: ApiListingControl

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	5
rs	9.4286
cc	1
eloc	3
nc	1
nop	3

<?php

namespace Tomaj\NetteApi\Component;

use Nette\Application\UI\Control;
use Nette\ComponentModel\IContainer;
use Tomaj\NetteApi\ApiDecider;
use Closure;
use Exception;

class ApiListingControl extends Control
{
    /**
     * @var ApiDecider
     */
    private $apiDecider;

    private $clickCallback;

    public function __construct(IContainer $parent, $name, ApiDecider $apiDecider)
    {
        parent::__construct(null, $name);
        $this->apiDecider = $apiDecider;
    }


    public function onClick(Closure $callback)
    {
        $this->clickCallback = $callback;
    }

    public function render()
    {
        $handlers = $this->apiDecider->getHandlers();
        $this->template->handlers = $this->sortHandlers($handlers);
<?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.");
        }
    }

}
        $this->template->setFile(__DIR__ . '/api_listing.latte');
<?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.");
        }
    }

}
        $this->template->render();
<?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.");
        }
    }

}
    }

    public function handleSelect($method, $version, $package, $apiAction)
    {
        if (!$this->clickCallback) {
            throw new Exception('You have to set onClick callback to component!');
        }

        $this->clickCallback->__invoke($method, $version, $package, $apiAction);
    }

    private function sortHandlers($handlers)
    {
        $versionHandlers = [];
        foreach ($handlers as $handler) {
            $endPoint = $handler['endpoint'];
            if (!isset($versionHandlers[$endPoint->getVersion()])) {
                $versionHandlers[$endPoint->getVersion()] = [];
            }
            $versionHandlers[$endPoint->getVersion()][] = $handler;
        }
        return $versionHandlers;
    }
}

1			<?php
2
3			namespace Tomaj\NetteApi\Component;
4
5			use Nette\Application\UI\Control;
6			use Nette\ComponentModel\IContainer;
7			use Tomaj\NetteApi\ApiDecider;
8			use Closure;
9			use Exception;
10
11			class ApiListingControl extends Control
12			{
13			/**
14			* @var ApiDecider
15			*/
16			private $apiDecider;
17
18			private $clickCallback;
19
20			public function __construct(IContainer $parent, $name, ApiDecider $apiDecider)
21			{
22			parent::__construct(null, $name);
23			$this->apiDecider = $apiDecider;
24			}
25
26
27			public function onClick(Closure $callback)
28			{
29			$this->clickCallback = $callback;
30			}
31
32			public function render()
33			{
34			$handlers = $this->apiDecider->getHandlers();
35			$this->template->handlers = $this->sortHandlers($handlers);
			0 ignored issues – show Documentation introduced 2015-12-25 20:34 UTC by Report Bug Copy Issue Report The property `$template` is declared private in `Nette\Application\UI\Control`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. 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... Bug introduced 2015-12-25 20:34 UTC by Report Bug Copy Issue Report Accessing `handlers` on the interface `Nette\Application\UI\ITemplate` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
36			$this->template->setFile(__DIR__ . '/api_listing.latte');
			0 ignored issues – show Documentation introduced 2015-12-25 20:34 UTC by Report Bug Copy Issue Report The property `$template` is declared private in `Nette\Application\UI\Control`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. 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...
37			$this->template->render();
			0 ignored issues – show Documentation introduced 2015-12-25 20:34 UTC by Report Bug Copy Issue Report The property `$template` is declared private in `Nette\Application\UI\Control`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. 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...
38			}
39
40			public function handleSelect($method, $version, $package, $apiAction)
41			{
42			if (!$this->clickCallback) {
43			throw new Exception('You have to set onClick callback to component!');
44			}
45
46			$this->clickCallback->__invoke($method, $version, $package, $apiAction);
47			}
48
49			private function sortHandlers($handlers)
50			{
51			$versionHandlers = [];
52			foreach ($handlers as $handler) {
53			$endPoint = $handler['endpoint'];
54			if (!isset($versionHandlers[$endPoint->getVersion()])) {
55			$versionHandlers[$endPoint->getVersion()] = [];
56			}
57			$versionHandlers[$endPoint->getVersion()][] = $handler;
58			}
59			return $versionHandlers;
60			}
61			}

tomaj / nette-api

Push — master ( bc4ddd...54781a )

ApiListingControl::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like