OutputSign::update() - Code Metrics - frqnck/apix - Measure and Improve Code Quality continuously with Scrutinizer

OutputSign::update() B
last analyzed 2017-05-17 20:31 UTC

↳ Parent: OutputSign

Complexity

Conditions	4
Paths	5

Size

Total Lines	36
Code Lines	24

Duplication

Lines	8
Ratio	22.22 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
dl	8
loc	36
ccs	0
cts	32
cp	0
rs	8.5806
c	0
b	0
f	0
cc	4
eloc	24
nc	5
nop	1
crap	20

<?php

/**
 *
 * This file is part of the Apix Project.
 *
 * (c) Franck Cassedanne <franck at ouarz.net>
 *
 * @license     http://opensource.org/licenses/BSD-3-Clause  New BSD License
 *
 */

namespace Apix\Plugin;

use Apix\Response;

class OutputSign extends PluginAbstract
{

    public static $hook = array('response', 'early');

    protected $options = array(
        'enable'    => true,        // wether to enable or not
        'name'      => 'signature', // the header name
        'prepend'   => false,       // wether to prepend the signature
        'extras'    => null,        // extras to inject, string or array
    );

    public function update(\SplSubject $response)
    {
        if (false === $this->options['enable']) {
            return false;
        }

        $request = $response->getRequest();
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.
    }
}
        $route = $response->getRoute();
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.
    }
}
        $http_code = $response->getHttpCode();
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.
    }
}

        $data = array(
            'resource'  => sprintf(
                            '%s %s',
                            $route->getMethod(),
                            $route->getName()
                        ),
            'status'    => sprintf(
                            '%d %s - %s',
                            $http_code,
                            Response::getStatusPrases($http_code),
                            Response::getStatusAdjective($http_code)
                        ),
            'client_ip' => $request->getIp(true)
        );

        if (null !== $this->options['extras']) {

            $data['extras'] = $this->options['extras'];
        }

        $name = $this->options['name'];
        if (true === $this->options['prepend']) {

            $response->results = array($name=>$data)+$response->results;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        } else {
            $response->results[$name] = $data;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        }
    }

}


1		<?php
2
3		/**
4		*
5		* This file is part of the Apix Project.
6		*
7		* (c) Franck Cassedanne <franck at ouarz.net>
8		*
9		* @license http://opensource.org/licenses/BSD-3-Clause New BSD License
10		*
11		*/
12
13		namespace Apix\Plugin;
14
15		use Apix\Response;
16
17		class OutputSign extends PluginAbstract
18		{
19
20		public static $hook = array('response', 'early');
21
22		protected $options = array(
23		'enable' => true, // wether to enable or not
24		'name' => 'signature', // the header name
25		'prepend' => false, // wether to prepend the signature
26		'extras' => null, // extras to inject, string or array
27		);
28
29		public function update(\SplSubject $response)
30		{
31		if (false === $this->options['enable']) {
32		return false;
33		}
34
35		$request = $response->getRequest();
		0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `SplSubject` as the method `getRequest()` does only exist in the following implementations of said interface: `Apix\Response`. 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...
36		$route = $response->getRoute();
		0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `SplSubject` as the method `getRoute()` does only exist in the following implementations of said interface: `Apix\Entity`, `Apix\Entity\EntityClass`, `Apix\Entity\EntityClosure`, `Apix\Main`, `Apix\Response`, `Apix\Server`. 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...
37		$http_code = $response->getHttpCode();
		0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `SplSubject` as the method `getHttpCode()` does only exist in the following implementations of said interface: `Apix\Response`. 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...
38
39		$data = array(
40		'resource' => sprintf(
41		'%s %s',
42		$route->getMethod(),
43		$route->getName()
44		),
45		'status' => sprintf(
46		'%d %s - %s',
47		$http_code,
48		Response::getStatusPrases($http_code),
49		Response::getStatusAdjective($http_code)
50		),
51		'client_ip' => $request->getIp(true)
52		);
53
54	View Code Duplication	if (null !== $this->options['extras']) {
		0 ignored issues – show Duplication introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
55		$data['extras'] = $this->options['extras'];
56		}
57
58		$name = $this->options['name'];
59	View Code Duplication	if (true === $this->options['prepend']) {
		0 ignored issues – show Duplication introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
60		$response->results = array($name=>$data)+$response->results;
		0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report Accessing `results` on the interface `SplSubject` 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...
61		} else {
62		$response->results[$name] = $data;
		0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report Accessing `results` on the interface `SplSubject` 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...
63		}
64		}
65
66		}
67

frqnck / apix

OutputSign::update() B last analyzed 2017-05-17 20:31 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

OutputSign::update() B
last analyzed 2017-05-17 20:31 UTC