ShowsErrorResponse - Code Metrics - acacha/forge-publish - Measure and Improve Code Quality continuously with Scrutinizer

ShowsErrorResponse A
last analyzed 2018-03-14 17:57 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	19
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

Metric	Value
dl	0
loc	19
rs	10
c	0
b	0
f	0
wmc	2
lcom	1
cbo	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	showErrorAndDie()	0	11	2

<?php

namespace Acacha\ForgePublish\Commands\Traits;

/**
 * Trait ShowsErrorResponse
 *
 * @package Acacha\ForgePublish\Commands
 */
trait ShowsErrorResponse
{
    /**
     * Show error and die.
     *
     * @param \Exception $e
     */
    protected function showErrorAndDie(\Exception $e)
    {
        $this->error('And error occurs connecting to the api url: ' . $this->url);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        if ($e->getResponse()) {
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            $this->error('Status code: ' . $e->getResponse()->getStatusCode() . ' | Reason : ' . $e->getResponse()->getReasonPhrase());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
        } else {
            $this->error('Exception occurs. Message: ' . $e->getMessage());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        die();

    }
}


ShowsErrorResponse A
last analyzed 2018-03-14 17:57 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

Available Fixes

Available Fixes

1			<?php
2
3			namespace Acacha\ForgePublish\Commands\Traits;
4
5			/**
6			* Trait ShowsErrorResponse
7			*
8			* @package Acacha\ForgePublish\Commands
9			*/
10			trait ShowsErrorResponse
11			{
12			/**
13			* Show error and die.
14			*
15			* @param \Exception $e
16			*/
17			protected function showErrorAndDie(\Exception $e)
18			{
19			$this->error('And error occurs connecting to the api url: ' . $this->url);
			0 ignored issues – show Bug introduced 2017-11-29 07:30 UTC by Report Bug Copy Issue Report The property `url` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2017-11-29 07:30 UTC by Report Bug Copy Issue Report It seems like `error()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
20			if ($e->getResponse()) {
			0 ignored issues – show Bug introduced 2017-11-29 07:30 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Exception` as the method `getResponse()` does only exist in the following sub-classes of `Exception`: `GuzzleHttp\Exception\BadResponseException`, `GuzzleHttp\Exception\ClientException`, `GuzzleHttp\Exception\ConnectException`, `GuzzleHttp\Exception\RequestException`, `GuzzleHttp\Exception\ServerException`, `GuzzleHttp\Exception\TooManyRedirectsException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
21			$this->error('Status code: ' . $e->getResponse()->getStatusCode() . ' \| Reason : ' . $e->getResponse()->getReasonPhrase());
			0 ignored issues – show Bug introduced 2017-11-29 07:30 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Exception` as the method `getResponse()` does only exist in the following sub-classes of `Exception`: `GuzzleHttp\Exception\BadResponseException`, `GuzzleHttp\Exception\ClientException`, `GuzzleHttp\Exception\ConnectException`, `GuzzleHttp\Exception\RequestException`, `GuzzleHttp\Exception\ServerException`, `GuzzleHttp\Exception\TooManyRedirectsException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history... Bug introduced 2017-11-29 07:30 UTC by Report Bug Copy Issue Report It seems like `error()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
22			} else {
23			$this->error('Exception occurs. Message: ' . $e->getMessage());
			0 ignored issues – show Bug introduced 2017-11-29 07:30 UTC by Report Bug Copy Issue Report It seems like `error()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
24			}
25
26			die();
			0 ignored issues – show Coding Style Compatibility introduced 2017-11-29 07:30 UTC by Report Bug Copy Issue Report The method `showErrorAndDie()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
27			}
28			}
29

acacha / forge-publish

ShowsErrorResponse A last analyzed 2018-03-14 17:57 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

ShowsErrorResponse A
last analyzed 2018-03-14 17:57 UTC