SoapServer - Code Metrics - carlosafonso/soapi - Measure and Improve Code Quality continuously with Scrutinizer

SoapServer A
last analyzed 2017-09-01 23:18 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	4
lcom	1
cbo	2
dl	0
loc	72
ccs	0
cts	17
cp	0
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	__construct()	8	1
B	handle()	28	2
A	outputResponse()	7	1

<?php

namespace Afonso\Soapi;

use League\Pipeline\Pipeline;
use SoapServer as NativeSoapServer;

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

    /**
     * Creates and returns a new SoapServer 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();
    }

    /**
     * Handles a SOAP request.
     *
     * This function delegates on PHP's native SoapServer handle(), but
     * processes the input XML through the inbound and outbound pipelines. This
     * allows for arbitrary manipulation of requests and responses, such as
     * encryption or logging.
     *
     * Just as the parent class, this function will fetch the input from the
     * POST data if none is passed as an argument. Likewise, it will return
     * nothing and output the response instead.
     *
     * @see     http://php.net/manual/en/soapserver.handle.php
     * @param   string|null $soapRequest
     */
    public function handle($soapRequest = null)
    {
        if (! $soapRequest) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $soapRequest = file_get_contents('php://input');
        }

        /*
         * Run the request XML through the inbound pipeline.
         */
        $soapRequest = $this->inboundPipeline->process($soapRequest);

        /*
         * Execute the request.
         */
        ob_start();
        parent::handle($soapRequest);
        $soapResponse = ob_get_clean();

        /*
         * Then run the response through the outbound pipeline.
         */
        $soapResponse = $this->outboundPipeline->process($soapResponse);

        /*
         * Output the response and we're done.
         */
        $this->outputResponse($soapResponse);
    }

    protected function outputResponse($soapResponse)
    {
        echo $soapResponse;
        header('Content-Type: text/xml; charset=utf8');
        header('Content-Length: ' . strlen($soapResponse));
        exit(0);

    }
}


1			<?php
2
3			namespace Afonso\Soapi;
4
5			use League\Pipeline\Pipeline;
6			use SoapServer as NativeSoapServer;
7
8			/**
9			* A enhanced, drop-in replacement for PHP's native SoapServer class.
10			*
11			* This server includes input and output pipelines to aribtrarily modify
12			* requests and responses.
13			*/
14			class SoapServer extends NativeSoapServer
15			{
16			use ProcessesWithPipelines;
17
18			/**
19			* Creates and returns a new SoapServer 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 `SoapServer` as the method `__construct()` does only exist in the following sub-classes of `SoapServer`: `Afonso\Soapi\SoapServer`. 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			* Handles a SOAP request.
36			*
37			* This function delegates on PHP's native SoapServer handle(), but
38			* processes the input XML through the inbound and outbound pipelines. This
39			* allows for arbitrary manipulation of requests and responses, such as
40			* encryption or logging.
41			*
42			* Just as the parent class, this function will fetch the input from the
43			* POST data if none is passed as an argument. Likewise, it will return
44			* nothing and output the response instead.
45			*
46			* @see http://php.net/manual/en/soapserver.handle.php
47			* @param string\|null $soapRequest
48			*/
49			public function handle($soapRequest = null)
50			{
51			if (! $soapRequest) {
			0 ignored issues – show Bug Best Practice introduced 2016-02-07 13:30 UTC by Report Bug Copy Issue Report The expression `$soapRequest` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
52			$soapRequest = file_get_contents('php://input');
53			}
54
55			/*
56			* Run the request XML through the inbound pipeline.
57			*/
58			$soapRequest = $this->inboundPipeline->process($soapRequest);
59
60			/*
61			* Execute the request.
62			*/
63			ob_start();
64			parent::handle($soapRequest);
65			$soapResponse = ob_get_clean();
66
67			/*
68			* Then run the response through the outbound pipeline.
69			*/
70			$soapResponse = $this->outboundPipeline->process($soapResponse);
71
72			/*
73			* Output the response and we're done.
74			*/
75			$this->outputResponse($soapResponse);
76			}
77
78			protected function outputResponse($soapResponse)
79			{
80			echo $soapResponse;
81			header('Content-Type: text/xml; charset=utf8');
82			header('Content-Length: ' . strlen($soapResponse));
83			exit(0);
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-07 13:30 UTC by Report Bug Copy Issue Report The method `outputResponse()` 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...
84			}
85			}
86

carlosafonso / soapi

SoapServer A last analyzed 2017-09-01 23:18 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like

SoapServer A
last analyzed 2017-09-01 23:18 UTC