ApproveControl::setAuthorizationRequest() - Code Metrics - Inspection of "ApproveControl refactor" - lookyman/nette-oauth2-server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

by Lukáš

created 2016-09-23 10:40 UTC

ApproveControl::setAuthorizationRequest() A

↳ Parent: ApproveControl

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php
declare(strict_types=1);

namespace Lookyman\NetteOAuth2Server\UI;

use League\OAuth2\Server\AuthorizationServer;
use League\OAuth2\Server\Exception\OAuthServerException;
use League\OAuth2\Server\RequestTypes\AuthorizationRequest;
use Nette\Application\AbortException;
use Nette\Application\IResponse;
use Nette\Application\UI\Control;
use Nette\Http\IResponse as HttpResponse;
use Nextras\Application\UI\SecuredLinksControlTrait;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;

/**
 * @method void onAuthorizationComplete()
 * @method void onResponse(IResponse $response)
 */
class ApproveControl extends Control implements LoggerAwareInterface
{
	use LoggerAwareTrait;
	use Psr7Trait;
	use SecuredLinksControlTrait;

	/**
	 * @var callable[]
	 */
	public $onAuthorizationComplete;

	/**
	 * @var callable[]
	 */
	public $onResponse;

	/**
	 * @var AuthorizationRequest
	 */
	private $authorizationRequest;

	/**
	 * @var AuthorizationServer
	 */
	private $authorizationServer;

	/**
	 * @var string
	 */
	private $templateFile;

	/**
	 * @param AuthorizationServer $authorizationServer
	 * @param AuthorizationRequest $authorizationRequest
	 */
	public function __construct(AuthorizationServer $authorizationServer, AuthorizationRequest $authorizationRequest)
	{
		$this->authorizationServer = $authorizationServer;
		$this->authorizationRequest = $authorizationRequest;
		$this->templateFile = __DIR__ . '/templates/approve.latte';
	}

	public function render()
	{
		$this->template->setFile($this->templateFile);
<?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->authorizationRequest = $this->authorizationRequest;
<?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.");
        }
    }

}
	}

	/**
	 * @secured
	 */
	public function handleApprove()
	{
		$this->authorizationRequest->setAuthorizationApproved(true);
		$this->completeAuthorizationRequest();
	}

	/**
	 * @secured
	 */
	public function handleDeny()
	{
		$this->authorizationRequest->setAuthorizationApproved(false);
		$this->completeAuthorizationRequest();
	}

	private function completeAuthorizationRequest()
	{
		$this->onAuthorizationComplete();

		$response = $this->createResponse();
		try {
			$this->onResponse($this->authorizationServer->completeAuthorizationRequest($this->authorizationRequest, $response));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		} catch (AbortException $e) {
			throw $e;

		} catch (OAuthServerException $e) {
			$this->onResponse($e->generateHttpResponse($response));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		} catch (\Exception $e) {
			if ($this->logger) {
				$this->logger->error($e->getMessage(), ['exception' => $e]);
			}
			$body = $this->createStream();
			$body->write('Unknown error');
			$this->onResponse($response->withStatus(HttpResponse::S500_INTERNAL_SERVER_ERROR)->withBody($body));
		}
	}

	/**
	 * @param string $file
	 */
	public function setTemplateFile(string $file)
	{
		$this->templateFile = $file;
	}
}


1			<?php
2			declare(strict_types=1);
3
4			namespace Lookyman\NetteOAuth2Server\UI;
5
6			use League\OAuth2\Server\AuthorizationServer;
7			use League\OAuth2\Server\Exception\OAuthServerException;
8			use League\OAuth2\Server\RequestTypes\AuthorizationRequest;
9			use Nette\Application\AbortException;
10			use Nette\Application\IResponse;
11			use Nette\Application\UI\Control;
12			use Nette\Http\IResponse as HttpResponse;
13			use Nextras\Application\UI\SecuredLinksControlTrait;
14			use Psr\Log\LoggerAwareInterface;
15			use Psr\Log\LoggerAwareTrait;
16
17			/**
18			* @method void onAuthorizationComplete()
19			* @method void onResponse(IResponse $response)
20			*/
21			class ApproveControl extends Control implements LoggerAwareInterface
22			{
23			use LoggerAwareTrait;
24			use Psr7Trait;
25			use SecuredLinksControlTrait;
26
27			/**
28			* @var callable[]
29			*/
30			public $onAuthorizationComplete;
31
32			/**
33			* @var callable[]
34			*/
35			public $onResponse;
36
37			/**
38			* @var AuthorizationRequest
39			*/
40			private $authorizationRequest;
41
42			/**
43			* @var AuthorizationServer
44			*/
45			private $authorizationServer;
46
47			/**
48			* @var string
49			*/
50			private $templateFile;
51
52			/**
53			* @param AuthorizationServer $authorizationServer
54			* @param AuthorizationRequest $authorizationRequest
55			*/
56			public function __construct(AuthorizationServer $authorizationServer, AuthorizationRequest $authorizationRequest)
57			{
58			$this->authorizationServer = $authorizationServer;
59			$this->authorizationRequest = $authorizationRequest;
60			$this->templateFile = __DIR__ . '/templates/approve.latte';
61			}
62
63			public function render()
64			{
65			$this->template->setFile($this->templateFile);
			0 ignored issues – show Documentation introduced 2016-07-26 12:56 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...
66			$this->template->authorizationRequest = $this->authorizationRequest;
			0 ignored issues – show Documentation introduced 2016-07-26 12:56 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 2016-07-26 12:56 UTC by Report Bug Copy Issue Report Accessing `authorizationRequest` 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...
67			$this->template->render();
			0 ignored issues – show Documentation introduced 2016-07-26 12:56 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...
68			}
69
70			/**
71			* @secured
72			*/
73			public function handleApprove()
74			{
75			$this->authorizationRequest->setAuthorizationApproved(true);
76			$this->completeAuthorizationRequest();
77			}
78
79			/**
80			* @secured
81			*/
82			public function handleDeny()
83			{
84			$this->authorizationRequest->setAuthorizationApproved(false);
85			$this->completeAuthorizationRequest();
86			}
87
88			private function completeAuthorizationRequest()
89			{
90			$this->onAuthorizationComplete();
91
92			$response = $this->createResponse();
93			try {
94			$this->onResponse($this->authorizationServer->completeAuthorizationRequest($this->authorizationRequest, $response));
			0 ignored issues – show Documentation introduced 2016-09-21 11:43 UTC by Report Bug Copy Issue Report `$this->authorizationServ...tionRequest, $response)` is of type `object<Psr\Http\Message\ResponseInterface>`, but the function expects a `object<Nette\Application\IResponse>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
95
96			} catch (AbortException $e) {
97			throw $e;
98
99			} catch (OAuthServerException $e) {
100			$this->onResponse($e->generateHttpResponse($response));
			0 ignored issues – show Documentation introduced 2016-09-21 11:43 UTC by Report Bug Copy Issue Report `$e->generateHttpResponse($response)` is of type `object<Psr\Http\Message\ResponseInterface>`, but the function expects a `object<Nette\Application\IResponse>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
101
102			} catch (\Exception $e) {
103			if ($this->logger) {
104			$this->logger->error($e->getMessage(), ['exception' => $e]);
105			}
106			$body = $this->createStream();
107			$body->write('Unknown error');
108			$this->onResponse($response->withStatus(HttpResponse::S500_INTERNAL_SERVER_ERROR)->withBody($body));
109			}
110			}
111
112			/**
113			* @param string $file
114			*/
115			public function setTemplateFile(string $file)
116			{
117			$this->templateFile = $file;
118			}
119			}
120

lookyman / nette-oauth2-server

GitHub Access Token became invalid

Pull Request — master (#6)

ApproveControl::setAuthorizationRequest() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like