GuzzleExceptionFormatter - Code Metrics - glooby/debug-bundle - Measure and Improve Code Quality continuously with Scrutinizer

GuzzleExceptionFormatter A
last analyzed 2016-11-22 18:15 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

Metric	Value
wmc	7
lcom	0
cbo	3
dl	0
loc	40
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	format()	0	6	1
B	buildSections()	0	21	6

<?php

namespace Glooby\Debug\Formatter\Guzzle;

use Glooby\Debug\Exception\FormatterException;
use Glooby\Debug\Formatter\ExceptionFormatter;
use Glooby\Debug\Formatter\FormatterInterface;
use GuzzleHttp\Exception\TransferException;
use GuzzleHttp\Message\RequestInterface;
use GuzzleHttp\Message\ResponseInterface;

/**
 * @author Emil Kilhage
 */
class GuzzleExceptionFormatter implements  FormatterInterface

{
    /**
     * @param TransferException $exception
     * @return string
     * @throws FormatterException
     */
    public function format($exception)
    {
        $sections = $this->buildSections($exception);

        return implode("\n\n", $sections);
    }

    /**
     * @param TransferException $exception
     * @return array
     */
    private function buildSections($exception)
    {
        $sections = [];

        if ($exception instanceof \Exception) {
            $formatter = new ExceptionFormatter();
            $sections['Exception'] = $formatter->format($exception);
        }

        if (method_exists($exception, 'getRequest') && $exception->getRequest() instanceof RequestInterface) {
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.
    }
}
            $formatter = new RequestFormatter();
            $sections['Request'] = $formatter->format($exception->getRequest());
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.
    }
}
        }

        if (method_exists($exception, 'getResponse') && $exception->getResponse() instanceof ResponseInterface) {
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.
    }
}
            $formatter = new ResponseFormatter();
            $sections['Response'] = $formatter->format($exception->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.
    }
}
        }

        return $sections;
    }
}


GuzzleExceptionFormatter A
last analyzed 2016-11-22 18:15 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			namespace Glooby\Debug\Formatter\Guzzle;
4
5			use Glooby\Debug\Exception\FormatterException;
6			use Glooby\Debug\Formatter\ExceptionFormatter;
7			use Glooby\Debug\Formatter\FormatterInterface;
8			use GuzzleHttp\Exception\TransferException;
9			use GuzzleHttp\Message\RequestInterface;
10			use GuzzleHttp\Message\ResponseInterface;
11
12			/**
13			* @author Emil Kilhage
14			*/
15			class GuzzleExceptionFormatter implements FormatterInterface
			0 ignored issues – show Coding Style introduced 2016-03-28 23:11 UTC by Report Bug Copy Issue Report Expected 1 space before "FormatterInterface"; 2 found Loading history...
16			{
17			/**
18			* @param TransferException $exception
19			* @return string
20			* @throws FormatterException
21			*/
22			public function format($exception)
23			{
24			$sections = $this->buildSections($exception);
25
26			return implode("\n\n", $sections);
27			}
28
29			/**
30			* @param TransferException $exception
31			* @return array
32			*/
33			private function buildSections($exception)
34			{
35			$sections = [];
36
37			if ($exception instanceof \Exception) {
38			$formatter = new ExceptionFormatter();
39			$sections['Exception'] = $formatter->format($exception);
40			}
41
42			if (method_exists($exception, 'getRequest') && $exception->getRequest() instanceof RequestInterface) {
			0 ignored issues – show Bug introduced 2016-07-06 17:00 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `GuzzleHttp\Exception\TransferException` as the method `getRequest()` does only exist in the following sub-classes of `GuzzleHttp\Exception\TransferException`: `GuzzleHttp\Exception\BadResponseException`, `GuzzleHttp\Exception\ClientException`, `GuzzleHttp\Exception\ConnectException`, `GuzzleHttp\Exception\CouldNotRewindStreamException`, `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...
43			$formatter = new RequestFormatter();
44			$sections['Request'] = $formatter->format($exception->getRequest());
			0 ignored issues – show Bug introduced 2016-07-06 17:00 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `GuzzleHttp\Exception\TransferException` as the method `getRequest()` does only exist in the following sub-classes of `GuzzleHttp\Exception\TransferException`: `GuzzleHttp\Exception\BadResponseException`, `GuzzleHttp\Exception\ClientException`, `GuzzleHttp\Exception\ConnectException`, `GuzzleHttp\Exception\CouldNotRewindStreamException`, `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...
45			}
46
47			if (method_exists($exception, 'getResponse') && $exception->getResponse() instanceof ResponseInterface) {
			0 ignored issues – show Bug introduced 2016-07-06 17:00 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `GuzzleHttp\Exception\TransferException` as the method `getResponse()` does only exist in the following sub-classes of `GuzzleHttp\Exception\TransferException`: `GuzzleHttp\Exception\BadResponseException`, `GuzzleHttp\Exception\ClientException`, `GuzzleHttp\Exception\ConnectException`, `GuzzleHttp\Exception\CouldNotRewindStreamException`, `GuzzleHttp\Exception\ParseException`, `GuzzleHttp\Exception\RequestException`, `GuzzleHttp\Exception\ServerException`, `GuzzleHttp\Exception\TooManyRedirectsException`, `GuzzleHttp\Exception\XmlParseException`. 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...
48			$formatter = new ResponseFormatter();
49			$sections['Response'] = $formatter->format($exception->getResponse());
			0 ignored issues – show Bug introduced 2016-07-06 17:00 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `GuzzleHttp\Exception\TransferException` as the method `getResponse()` does only exist in the following sub-classes of `GuzzleHttp\Exception\TransferException`: `GuzzleHttp\Exception\BadResponseException`, `GuzzleHttp\Exception\ClientException`, `GuzzleHttp\Exception\ConnectException`, `GuzzleHttp\Exception\CouldNotRewindStreamException`, `GuzzleHttp\Exception\ParseException`, `GuzzleHttp\Exception\RequestException`, `GuzzleHttp\Exception\ServerException`, `GuzzleHttp\Exception\TooManyRedirectsException`, `GuzzleHttp\Exception\XmlParseException`. 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...
50			}
51
52			return $sections;
53			}
54			}
55

glooby / debug-bundle

GuzzleExceptionFormatter A last analyzed 2016-11-22 18:15 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

GuzzleExceptionFormatter A
last analyzed 2016-11-22 18:15 UTC