SoapClient::__construct() - Code Metrics - carlosafonso/soapi - Measure and Improve Code Quality continuously with Scrutinizer

SoapClient::__construct() A
last analyzed 2017-09-01 23:18 UTC

↳ Parent: SoapClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	0
cts	4
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	2
crap	2

<?php

namespace Afonso\Soapi;

use League\Pipeline\Pipeline;
use SoapClient as NativeSoapClient;

/**
 * A enhanced, drop-in replacement for PHP's native SoapClient class.
 *
 * This client includes input and output pipelines to aribtrarily modify
 * requests and responses.
 */
class SoapClient extends NativeSoapClient
{
    use ProcessesWithPipelines;

    /**
     * Creates and returns a new SoapClient with empty inbound and outbound
     * pipelines.
     *
     * @param   string|null $wsdl
     * @param   array       $options
     */
    public function __construct($wsdl, array $options = array())
    {
        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.
    }
}

        // initialize in and outbound pipelines
        $this->inboundPipeline = new Pipeline();
        $this->outboundPipeline = new Pipeline();
    }

    /**
     * Performs a SOAP request.
     *
     * This function delegates on PHP's native SoapClient __doRequest(), but
     * processes the payload through the oubtound and inbound pipelines. This
     * allows for arbitrary manipulation of requests and responses, such as
     * encryption or logging.
     *
     * @see     http://php.net/manual/en/soapclient.dorequest.php
     * @param   string  $soapRequest
     * @param   string  $location
     * @param   string  $action
     * @param   int     $version
     * @param   int     $oneWay
     */
    public function __doRequest($soapRequest, $location, $action, $version, $oneWay = 0)
    {
        /*
         * Run the request XML through the outbound pipeline.
         */
        $soapRequest = $this->outboundPipeline->process($soapRequest);

        /*
         * Do the actual request.
         */
        $soapResponse = parent::__doRequest($soapRequest, $location, $action, $version, $oneWay);

        /*
         * Then run the response through the inbound pipeline.
         */
        $soapResponse = $this->inboundPipeline->process($soapResponse);
        return $soapResponse;
    }
}


1			<?php
2
3			namespace Afonso\Soapi;
4
5			use League\Pipeline\Pipeline;
6			use SoapClient as NativeSoapClient;
7
8			/**
9			* A enhanced, drop-in replacement for PHP's native SoapClient class.
10			*
11			* This client includes input and output pipelines to aribtrarily modify
12			* requests and responses.
13			*/
14			class SoapClient extends NativeSoapClient
15			{
16			use ProcessesWithPipelines;
17
18			/**
19			* Creates and returns a new SoapClient with empty inbound and outbound
20			* pipelines.
21			*
22			* @param string\|null $wsdl
23			* @param array $options
24			*/
25			public function __construct($wsdl, array $options = array())
26			{
27			parent::__construct($wsdl, $options);
			0 ignored issues – show Bug introduced 2016-02-07 13:30 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`: `Afonso\Soapi\SoapClient`. 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...
28
29			// initialize in and outbound pipelines
30			$this->inboundPipeline = new Pipeline();
31			$this->outboundPipeline = new Pipeline();
32			}
33
34			/**
35			* Performs a SOAP request.
36			*
37			* This function delegates on PHP's native SoapClient __doRequest(), but
38			* processes the payload through the oubtound and inbound pipelines. This
39			* allows for arbitrary manipulation of requests and responses, such as
40			* encryption or logging.
41			*
42			* @see http://php.net/manual/en/soapclient.dorequest.php
43			* @param string $soapRequest
44			* @param string $location
45			* @param string $action
46			* @param int $version
47			* @param int $oneWay
48			*/
49			public function __doRequest($soapRequest, $location, $action, $version, $oneWay = 0)
50			{
51			/*
52			* Run the request XML through the outbound pipeline.
53			*/
54			$soapRequest = $this->outboundPipeline->process($soapRequest);
55
56			/*
57			* Do the actual request.
58			*/
59			$soapResponse = parent::__doRequest($soapRequest, $location, $action, $version, $oneWay);
60
61			/*
62			* Then run the response through the inbound pipeline.
63			*/
64			$soapResponse = $this->inboundPipeline->process($soapResponse);
65			return $soapResponse;
66			}
67			}
68

carlosafonso / soapi

SoapClient::__construct() A last analyzed 2017-09-01 23:18 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

SoapClient::__construct() A
last analyzed 2017-09-01 23:18 UTC