WebService::parseOutput() - Code Metrics - Inspection of "Fix parseOutput undefined property (closes #90)" - skaut/Skautis - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 3.x (#91)

by Jindřich

created 2020-02-14 14:03 UTC

WebService::parseOutput() C

↳ Parent: WebService

Complexity

Conditions	9
Paths	7

Size

Total Lines

104

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	9.5338

Importance

Changes

Metric	Value
cc	9
nc	7
nop	2
dl	0
loc	104
ccs	13
cts	16
cp	0.8125
crap	9.5338
rs	6.4444
c	0
b	0
f	0

How to fix Long Method

<?php
declare(strict_types = 1);

namespace Skaut\Skautis\Wsdl;

use Skaut\Skautis\EventDispatcher\EventDispatcherTrait;
use Skaut\Skautis\InvalidArgumentException;
use Skaut\Skautis\SkautisQuery;
use SoapClient;
use SoapFault;
use stdClass;

/**
 * @author Hána František <[email protected]>
 */
class WebService implements WebServiceInterface
{

    use EventDispatcherTrait;

    public const EVENT_SUCCESS = 'success';
    public const EVENT_FAILURE = 'failure';

    /**
     * základní údaje volané při každém požadavku
     * ID_Application, ID_Login
     *
     * @var array<string, mixed>
     */
    protected $init;

    /**
     * @var SoapClient
     */
    protected $soapClient;

    /**
     * @param array<string, mixed> $soapOpts Nastaveni SOAP requestu
     * @throws InvalidArgumentException pokud je odkaz na WSDL soubor prázdný
     */
    public function __construct(SoapClient $soapClient, array $soapOpts)
    {
        $this->init = $soapOpts;
        $this->soapClient = $soapClient;
    }

    /**
     * @inheritdoc
     */
    public function call(string $functionName, array $arguments = [])
    {
        return $this->soapCall($functionName, $arguments);
    }


    /**
     * @inheritdoc
     */
    public function __call(string $functionName, array $arguments)
    {
        return $this->call($functionName, $arguments);
    }

    /**
     * Metoda provadejici SOAP pozadavek na servery Skautisu
     *
     * @see http://php.net/manual/en/soapclient.soapcall.php
     *
     * @param string $functionName Nazev akce k provedeni na WebService
     * @param array<int|string, mixed> $arguments ([0]=args [1]=cover)
     * @param array<string, mixed> $options Nastaveni
     * @param array<int, string> $inputHeaders Hlavicky pouzite pri odesilani
     * @param array<int, string> $outputHeaders Hlavicky ktere prijdou s odpovedi
     * @return array<int|string, mixed>|stdClass|null

     */
    protected function soapCall(
      string $functionName,
      array $arguments,
      array $options = [],
      array $inputHeaders = [],
      array &$outputHeaders = []
    ) {
        $fname = ucfirst($functionName);
        $args = $this->prepareArgs($fname, $arguments);

        if ($this->hasListeners()) {
            $query = new SkautisQuery($fname, $args, debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS));
        }

        try {
            $soapResponse = $this->soapClient->__soapCall($fname, $args, $options, $inputHeaders, $outputHeaders);
$q = serialize($soapResponse);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            $soapResponse = $this->parseOutput($fname, $soapResponse);

            if (isset($query) && $this->hasListeners()) {
                $this->dispatch(self::EVENT_SUCCESS, $query->done($soapResponse));
            }
            return $soapResponse;
        } catch (SoapFault $e) {
            if (isset($query) && $this->hasListeners()) {
              $this->dispatch(self::EVENT_FAILURE, $query->done(null, $e));
            }

            throw $this->convertToSkautisException($e);
        }
    }

    /**
     * Z defaultnich parametru a parametru callu vytvori argumenty pro SoapClient::__soapCall
     *
     * @param string $functionName Jmeno funkce volane pres SOAP
     * @param array<int|string, mixed> $arguments Argumenty k mergnuti s defaultnimy
     *
     * @return array<int, mixed> Argumenty pro SoapClient::__soapCall

     */
    protected function prepareArgs(string $functionName, array $arguments): array
    {
        if (!isset($arguments[0]) || !is_array($arguments[0])) {
            $arguments[0] = [];
        }

        //k argumentum připoji vlastni informace o aplikaci a uzivateli
        $args = array_merge($this->init, $arguments[0]);

        if (!isset($arguments[1])) {
            $functionName = lcfirst($functionName);
            $args = [[$functionName . 'Input' => $args]];
            return $args;
        }

        //pokud je zadan druhy parametr tak lze prejmenovat obal dat
        $matches = explode('/', $arguments[1]);
        //pole se budou vytvaret zevnitr ven
        $matches = array_reverse($matches);

        $matches[] = 0; //zakladni obal 0=>...

        foreach ($matches as $value) {
            $args = [$value => $args];
        }

        return $args;
    }

    /**
     * Parsuje output ze SoapClient do jednotného formátu
     *
     * @param string $fname Jméno funkce volané přes SOAP
     * @param mixed $ret    Odpoveď ze SoapClient::__soapCall
     *
     * @return array<int|string, mixed>|\stdClass|null

     */
    protected function parseOutput(string $fname, $ret)
    {

        /*
            Pokud se jedna o request ktery ma vracet jednu hodnotu a ta existuje, skautis vraci primo objekt odpovedi
                Napriklad:
                <UnitDetailResponse xmlns="https://is.skaut.cz/">
                    <UnitDetailResult>
                        data jednoho objektu
                    </UnitDetailResult>
                </UnitDetailResponse>

            To SoapClient naparsuje jako:
                class stdClass#25 (1) {
                    public $UnitDetailResult =>
                        class stdClass#26 (48) {
                            data objectu
                        }
                }



            Pokud se jedna o request ktery ma vracet jednu hodnotu a ta neexistuje, skautis vraci jeden self-closing tag
            Napriklad:
                <UnitDetailResponse xmlns="https://is.skaut.cz/" />

            To SoapClient naparsuje jako:
                class stdClass#25 (0) {
                }

            Pokud se jedna o request ktery ma vracet vice hodnot, vraci *Result/*Output
            Napriklad:
                <UnitAllResponse xmlns="https://is.skaut.cz/">
                    <UnitAllResult>
                        <UnitAllOutput>
                            data jednoho objektu
                        </UnitAllOutput>
                        <UnitAllOutput>
                            data dalsiho objektu
                        </UnitAllOutput>
                    </UnitAllResult>
                </UnitAllResponse>

            To SoapClient naparsuje jako:
                class stdClass#25 (1) {
                    public $UnitAllResult =>
                        class stdClass#26 (1) {
                            public $UnitAllOutput =>
                                array(2) {
                                    stdClass - data jednoho objektu,
                                    stdClass - data dalsiho objektu,
                                }
                        }
                    }
                }

            Pokud se jedna o request ktery ma vracet vice hodnot, vraci klasickou dvojici tagu
            Napriklad:
                <UnitAllResponse xmlns="https://is.skaut.cz/">
                    <UnitAllResult />
                </UnitAllResponse>

            To SoapClient naparsuje jako:
                class stdClass#25 (1) {
                    public $UnitAllResult =>
                        class stdClass#26 (0) {
                        }
                }

        */

        if (!$ret) {
            throw new \RuntimeException("unexpected output");
        }

        // Pokud byl vracen prazdny objekt predstavujici neexistujici vec
        if ($ret instanceof stdClass && count((array) $ret) === 0) {
            return null;
        }

        // Pokud obsahuje *Result pak se  bud jedna o existujici jeden objekt, vice objektu nebo prazdny seznam objektu
        $result = $ret->{$fname . 'Result'} ?? null;
        if (!isset($result)) {
            throw new \RuntimeException("unexpected output");
        }

        $output = $result->{$fname . 'Output'} ?? null;
        // Pokud obsahuje *Result, ale zadny *Output pak se jedna o jeden
        if (!isset($output)) {
            // Vraci prazdny object
            if ($result instanceof stdClass && count((array) $result) === 0) {
                return [];
            }

            return $result;
        }

        // Vraci pouze jednu hodnotu misto pole?
        if ($output instanceof stdClass) {
            return [$output];
        }

        return $output; //vraci pole se stdClass
    }

    private function convertToSkautisException(SoapFault $e): WsdlException
    {
      if (preg_match('/Uživatel byl odhlášen/ui', $e->getMessage())) {
        return new AuthenticationException($e->getMessage(), $e->getCode(), $e);
      }

      if (preg_match('/Nemáte oprávnění/ui', $e->getMessage())) {
        return new PermissionException($e->getMessage(), $e->getCode(), $e);
      }

      return new WsdlException($e->getMessage(), $e->getCode(), $e);
    }
}


1		<?php
2		declare(strict_types = 1);
3
4		namespace Skaut\Skautis\Wsdl;
5
6		use Skaut\Skautis\EventDispatcher\EventDispatcherTrait;
7		use Skaut\Skautis\InvalidArgumentException;
8		use Skaut\Skautis\SkautisQuery;
9		use SoapClient;
10		use SoapFault;
11		use stdClass;
12
13		/**
14		* @author Hána František <[email protected]>
15		*/
16		class WebService implements WebServiceInterface
17		{
18
19		use EventDispatcherTrait;
20
21		public const EVENT_SUCCESS = 'success';
22		public const EVENT_FAILURE = 'failure';
23
24		/**
25		* základní údaje volané při každém požadavku
26		* ID_Application, ID_Login
27		*
28		* @var array<string, mixed>
29		*/
30		protected $init;
31
32		/**
33		* @var SoapClient
34		*/
35		protected $soapClient;
36
37		/**
38		* @param array<string, mixed> $soapOpts Nastaveni SOAP requestu
39		* @throws InvalidArgumentException pokud je odkaz na WSDL soubor prázdný
40		*/
41	7	public function __construct(SoapClient $soapClient, array $soapOpts)
42		{
43	7	$this->init = $soapOpts;
44	7	$this->soapClient = $soapClient;
45	7	}
46
47		/**
48		* @inheritdoc
49		*/
50	6	public function call(string $functionName, array $arguments = [])
51		{
52	6	return $this->soapCall($functionName, $arguments);
53		}
54
55
56		/**
57		* @inheritdoc
58		*/
59	5	public function __call(string $functionName, array $arguments)
60		{
61	5	return $this->call($functionName, $arguments);
62		}
63
64		/**
65		* Metoda provadejici SOAP pozadavek na servery Skautisu
66		*
67		* @see http://php.net/manual/en/soapclient.soapcall.php
68		*
69		* @param string $functionName Nazev akce k provedeni na WebService
70		* @param array<int\|string, mixed> $arguments ([0]=args [1]=cover)
71		* @param array<string, mixed> $options Nastaveni
72		* @param array<int, string> $inputHeaders Hlavicky pouzite pri odesilani
73		* @param array<int, string> $outputHeaders Hlavicky ktere prijdou s odpovedi
74		* @return array<int\|string, mixed>\|stdClass\|null
		0 ignored issues – show Documentation introduced 2020-02-14 14:04 UTC by Report Bug Copy Issue Report The doc-type `array<int\|string,` could not be parsed: Expected ">" at position 7, but found "end of type". (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
75		*/
76	6	protected function soapCall(
77		string $functionName,
78		array $arguments,
79		array $options = [],
80		array $inputHeaders = [],
81		array &$outputHeaders = []
82		) {
83	6	$fname = ucfirst($functionName);
84	6	$args = $this->prepareArgs($fname, $arguments);
85
86	6	if ($this->hasListeners()) {
87	2	$query = new SkautisQuery($fname, $args, debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS));
88		}
89
90		try {
91	6	$soapResponse = $this->soapClient->__soapCall($fname, $args, $options, $inputHeaders, $outputHeaders);
92	4	$q = serialize($soapResponse);
		0 ignored issues – show Unused Code introduced 2020-02-14 14:04 UTC by Report Bug Copy Issue Report `$q` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
93	4	$soapResponse = $this->parseOutput($fname, $soapResponse);
94
95	4	if (isset($query) && $this->hasListeners()) {
96		$this->dispatch(self::EVENT_SUCCESS, $query->done($soapResponse));
97		}
98	4	return $soapResponse;
99	2	} catch (SoapFault $e) {
100	2	if (isset($query) && $this->hasListeners()) {
101	2	$this->dispatch(self::EVENT_FAILURE, $query->done(null, $e));
102		}
103
104	2	throw $this->convertToSkautisException($e);
105		}
106		}
107
108		/**
109		* Z defaultnich parametru a parametru callu vytvori argumenty pro SoapClient::__soapCall
110		*
111		* @param string $functionName Jmeno funkce volane pres SOAP
112		* @param array<int\|string, mixed> $arguments Argumenty k mergnuti s defaultnimy
113		*
114		* @return array<int, mixed> Argumenty pro SoapClient::__soapCall
		0 ignored issues – show Documentation introduced 2019-12-07 21:37 UTC by Report Bug Copy Issue Report The doc-type `array<int,` could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
115		*/
116	6	protected function prepareArgs(string $functionName, array $arguments): array
117		{
118	6	if (!isset($arguments[0]) \|\| !is_array($arguments[0])) {
119	2	$arguments[0] = [];
120		}
121
122		//k argumentum připoji vlastni informace o aplikaci a uzivateli
123	6	$args = array_merge($this->init, $arguments[0]);
124
125	6	if (!isset($arguments[1])) {
126	6	$functionName = lcfirst($functionName);
127	6	$args = [[$functionName . 'Input' => $args]];
128	6	return $args;
129		}
130
131		//pokud je zadan druhy parametr tak lze prejmenovat obal dat
132		$matches = explode('/', $arguments[1]);
133		//pole se budou vytvaret zevnitr ven
134		$matches = array_reverse($matches);
135
136		$matches[] = 0; //zakladni obal 0=>...
137
138		foreach ($matches as $value) {
139		$args = [$value => $args];
140		}
141
142		return $args;
143		}
144
145		/**
146		* Parsuje output ze SoapClient do jednotného formátu
147		*
148		* @param string $fname Jméno funkce volané přes SOAP
149		* @param mixed $ret Odpoveď ze SoapClient::__soapCall
150		*
151		* @return array<int\|string, mixed>\|\stdClass\|null
		0 ignored issues – show Documentation introduced 2020-02-14 14:04 UTC by Report Bug Copy Issue Report The doc-type `array<int\|string,` could not be parsed: Expected ">" at position 7, but found "end of type". (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
152		*/
153	4	protected function parseOutput(string $fname, $ret)
154		{
155
156		/*
157		Pokud se jedna o request ktery ma vracet jednu hodnotu a ta existuje, skautis vraci primo objekt odpovedi
158		Napriklad:
159		<UnitDetailResponse xmlns="https://is.skaut.cz/">
160		<UnitDetailResult>
161		data jednoho objektu
162		</UnitDetailResult>
163		</UnitDetailResponse>
164
165		To SoapClient naparsuje jako:
166		class stdClass#25 (1) {
167		public $UnitDetailResult =>
168		class stdClass#26 (48) {
169		data objectu
170		}
171		}
172
173
174
175		Pokud se jedna o request ktery ma vracet jednu hodnotu a ta neexistuje, skautis vraci jeden self-closing tag
176		Napriklad:
177		<UnitDetailResponse xmlns="https://is.skaut.cz/" />
178
179		To SoapClient naparsuje jako:
180		class stdClass#25 (0) {
181		}
182
183		Pokud se jedna o request ktery ma vracet vice hodnot, vraci Result/Output
184		Napriklad:
185		<UnitAllResponse xmlns="https://is.skaut.cz/">
186		<UnitAllResult>
187		<UnitAllOutput>
188		data jednoho objektu
189		</UnitAllOutput>
190		<UnitAllOutput>
191		data dalsiho objektu
192		</UnitAllOutput>
193		</UnitAllResult>
194		</UnitAllResponse>
195
196		To SoapClient naparsuje jako:
197		class stdClass#25 (1) {
198		public $UnitAllResult =>
199		class stdClass#26 (1) {
200		public $UnitAllOutput =>
201		array(2) {
202		stdClass - data jednoho objektu,
203		stdClass - data dalsiho objektu,
204		}
205		}
206		}
207		}
208
209		Pokud se jedna o request ktery ma vracet vice hodnot, vraci klasickou dvojici tagu
210		Napriklad:
211		<UnitAllResponse xmlns="https://is.skaut.cz/">
212		<UnitAllResult />
213		</UnitAllResponse>
214
215		To SoapClient naparsuje jako:
216		class stdClass#25 (1) {
217		public $UnitAllResult =>
218		class stdClass#26 (0) {
219		}
220		}
221
222		*/
223
224	4	if (!$ret) {
225		throw new \RuntimeException("unexpected output");
226		}
227
228		// Pokud byl vracen prazdny objekt predstavujici neexistujici vec
229	4	if ($ret instanceof stdClass && count((array) $ret) === 0) {
230	1	return null;
231		}
232
233		// Pokud obsahuje *Result pak se bud jedna o existujici jeden objekt, vice objektu nebo prazdny seznam objektu
234	3	$result = $ret->{$fname . 'Result'} ?? null;
235	3	if (!isset($result)) {
236		throw new \RuntimeException("unexpected output");
237		}
238
239	3	$output = $result->{$fname . 'Output'} ?? null;
240		// Pokud obsahuje Result, ale zadny Output pak se jedna o jeden
241	3	if (!isset($output)) {
242		// Vraci prazdny object
243	2	if ($result instanceof stdClass && count((array) $result) === 0) {
244	1	return [];
245		}
246
247	1	return $result;
248		}
249
250		// Vraci pouze jednu hodnotu misto pole?
251	1	if ($output instanceof stdClass) {
252		return [$output];
253		}
254
255	1	return $output; //vraci pole se stdClass
256		}
257
258	2	private function convertToSkautisException(SoapFault $e): WsdlException
259		{
260	2	if (preg_match('/Uživatel byl odhlášen/ui', $e->getMessage())) {
261		return new AuthenticationException($e->getMessage(), $e->getCode(), $e);
262		}
263
264	2	if (preg_match('/Nemáte oprávnění/ui', $e->getMessage())) {
265		return new PermissionException($e->getMessage(), $e->getCode(), $e);
266		}
267
268	2	return new WsdlException($e->getMessage(), $e->getCode(), $e);
269		}
270		}
271

skaut / Skautis

GitHub Access Token became invalid

Pull Request — 3.x (#91)

WebService::parseOutput() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like