DebugSoapClient - Code Metrics - Inspection of "DebugSoapClient, comment fix" - radowoj/yaah - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a300cb...a5c74c )

by Radosław

created 2017-03-02 18:33 UTC

DebugSoapClient A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	5
lcom	1
cbo	1
dl	0
loc	44
ccs	0
cts	17
cp	0
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	__construct()	12	2
A	__destruct()	4	1
A	__call()	9	1
A	log()	4	1

<?php

namespace Radowoj\Yaah;

use SoapClient;

/**
 * When things go south on WebAPI Sandbox, it is good to be able to send XML of request/response to Allegro support.
 * This class helps with that. Just provide some path or php://stdout as $options['log_file'] and you're good to go.
 */
class DebugSoapClient extends SoapClient
{
    /**
     * Log file (or stream) to use for logging SOAP requests/responses
     * @var string
     */
    protected $logFile = null;

    public function __construct($wsdl, array $options = [])
    {
        if (!array_key_exists('log_file', $options)) {
            throw new Exception("Debug soap client requires a log file path provided as {$options['log_file']} to work");
        }

        $this->logFile = fopen($options['log_file'], "w+");


        $options['trace'] = 1;

        return parent::__construct($wsdl, $options);
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.
    }
}
    }


    public function __destruct()
    {
        fclose($this->logFile);
    }


    public function __call($functionName, $arguments)
    {
        $response = parent::__call($functionName, $arguments);

        $this->log("Request {$functionName}: \n{$this->__getLastRequest()}\n\n");
        $this->log("Response {$functionName}: \n{$this->__getLastResponse()}\n\n");

        return $response;
    }


    protected function log($message)
    {
        fwrite($this->logFile, $message);
    }
}


1			<?php
2
3			namespace Radowoj\Yaah;
4
5			use SoapClient;
6
7			/**
8			* When things go south on WebAPI Sandbox, it is good to be able to send XML of request/response to Allegro support.
9			* This class helps with that. Just provide some path or php://stdout as $options['log_file'] and you're good to go.
10			*/
11			class DebugSoapClient extends SoapClient
12			{
13			/**
14			* Log file (or stream) to use for logging SOAP requests/responses
15			* @var string
16			*/
17			protected $logFile = null;
18
19			public function __construct($wsdl, array $options = [])
20			{
21			if (!array_key_exists('log_file', $options)) {
22			throw new Exception("Debug soap client requires a log file path provided as {$options['log_file']} to work");
23			}
24
25			$this->logFile = fopen($options['log_file'], "w+");
			0 ignored issues – show Documentation Bug introduced 2017-03-02 18:36 UTC by Report Bug Copy Issue Report It seems like `fopen($options['log_file'], 'w+')` of type `resource` is incompatible with the declared type `string` of property `$logFile`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
26
27			$options['trace'] = 1;
28
29			return parent::__construct($wsdl, $options);
			0 ignored issues – show Bug introduced 2017-03-02 18:36 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `SoapClient` as the method `__construct()` does only exist in the following sub-classes of `SoapClient`: `Radowoj\Yaah\DebugSoapClient`. 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-03-02 18:36 UTC by Report Bug Copy Issue Report Constructors do not have meaningful return values, anything that is returned from here is discarded. Are you sure this is correct? Loading history...
30			}
31
32
33			public function __destruct()
34			{
35			fclose($this->logFile);
36			}
37
38
39			public function __call($functionName, $arguments)
40			{
41			$response = parent::__call($functionName, $arguments);
42
43			$this->log("Request {$functionName}: \n{$this->__getLastRequest()}\n\n");
44			$this->log("Response {$functionName}: \n{$this->__getLastResponse()}\n\n");
45
46			return $response;
47			}
48
49
50			protected function log($message)
51			{
52			fwrite($this->logFile, $message);
53			}
54			}
55

radowoj / yaah

Push — master ( a300cb...a5c74c )

DebugSoapClient A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like