ClientStubGenerator::visitPortType() - Code Metrics - Inspection of "configuration pass" - goetas-webservices/soap-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 030796...0c67b5 )

by Asmir

created 2016-09-16 15:10 UTC

ClientStubGenerator::visitPortType() A

↳ Parent: ClientStubGenerator

Complexity

Conditions	4
Paths	5

Size

Total Lines	21
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	21
rs	9.0534
c	0
b	0
f	0
cc	4
eloc	14
nc	5
nop	2

<?php
namespace GoetasWebservices\SoapServices\SoapClient\StubGeneration;

use Doctrine\Common\Inflector\Inflector;
use GoetasWebservices\SoapServices\SoapClient\StubGeneration\Tag\MethodTag;
use GoetasWebservices\SoapServices\SoapClient\StubGeneration\Tag\ParamTag;
use GoetasWebservices\XML\WSDLReader\Wsdl\Message\Part;
use GoetasWebservices\XML\WSDLReader\Wsdl\PortType;
use GoetasWebservices\XML\WSDLReader\Wsdl\Service;
use GoetasWebservices\Xsd\XsdToPhp\Naming\NamingStrategy;
use GoetasWebservices\Xsd\XsdToPhp\Php\PhpConverter;
use Zend\Code\Generator\ClassGenerator;
use Zend\Code\Generator\DocBlockGenerator;

class ClientStubGenerator
{
    protected $reservedWords = [
        'int',
        'float',
        'bool',
        'string',
        'true',
        'false',
        'null',
        'resource',
        'object',
        'mixed',
        'numeric',
    ];

    private $baseNs = [
        'headers' => '\\SoapEnvelope\\Headers',
        'parts' => '\\SoapEnvelope\\Parts',
        'messages' => '\\SoapEnvelope\\Messages',
    ];
    /**
     * @var NamingStrategy
     */
    private $namingStrategy;
    /**
     * @var PhpConverter
     */
    private $phpConverter;
    /**
     * @var bool
     */
    private $unwrapReturn = false;

    public function __construct(PhpConverter $phpConverter, NamingStrategy $namingStrategy, $unwrapReturn = false, array $baseNs = array())
    {
        foreach ($baseNs as $k => $ns) {
            if (isset($this->baseNs[$k])) {
                $this->baseNs[$k] = $ns;
            }
        }
        $this->baseNs = $baseNs;
        $this->namingStrategy = $namingStrategy;
        $this->phpConverter = $phpConverter;
        $this->unwrapReturn = $unwrapReturn;
    }

    public function setUnwrap($mode = true)
    {
        $this->unwrapReturn = (bool)$mode;
    }

    /**
     * @param PortType[] $ports
     * @return ClassGenerator
     */
    public function generate(array $ports)
    {
        $classes = array();
        foreach ($ports as $port) {
            $class = new ClassGenerator();
            if ($this->visitPortType($class, $port) !== false) {
                $classes[] = $class;
            }
        }
        return $classes;
    }

    private function visitPortType(ClassGenerator $class, PortType $portType)
    {
        if (!count($portType->getOperations())) {
            return false;
        }
        $docBlock = new DocBlockGenerator("Class representing " . $portType->getName());
        $docBlock->setWordWrap(false);
        if ($portType->getDocumentation()) {
            $docBlock->setLongDescription($portType->getDocumentation());
        }

        $namespaces = $this->phpConverter->getNamespaces();
        $class->setNamespaceName($namespaces[$portType->getDefinition()->getTargetNamespace()] . "\\SoapStubs");
        $class->setName(Inflector::classify($portType->getName()));
        $class->setDocblock($docBlock);

        foreach ($portType->getOperations() as $operation) {
            $operationTag = $this->visitOperation($operation);
            $docBlock->setTag($operationTag);
        }
    }

    private function visitOperation(PortType\Operation $operation)
    {
        $types = $this->getOperationReturnTypes($operation);
        $operationTag = new MethodTag(
            Inflector::camelize($operation->getName()),
            $types,
            preg_replace("/[\n\r]+/", " ", $operation->getDocumentation())
        );
        $params = $this->getOperationParams($operation);
        $operationTag->setParams($params);
        return $operationTag;
    }

    private function getOperationParams(PortType\Operation $operation)
    {
        if (!$operation->getInput()) {
            return [];
        }

        $parts = $operation->getInput()->getMessage()->getParts();

        if (!$parts) {
            return [];
        }

        if (count($parts) > 1) {
            $params = [];
            foreach ($parts as $part) {
                $partName = $this->namingStrategy->getPropertyName($part);
                $class = $this->getClassFromPart($part);

                $typeName = $class->getPhpType();
                if ($t = $class->isSimpleType()){
                    $typeName = $t->getType()->getPhpType();
                }
                $params[] = $param = new ParamTag($partName, [$typeName]);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            }
        } else {
            $params = $this->extractSinglePartParameters(reset($parts));
        }

        return $params;
    }

    private function getOperationReturnTypes(PortType\Operation $operation)
    {
        if (!$operation->getOutput() || !$operation->getOutput()->getMessage()->getParts()) {

            return ['void'];
        }
        $parts = $operation->getOutput()->getMessage()->getParts();

        if (count($parts) > 1) {
            return ['array'];
        }
        /**
         * @var $part \GoetasWebservices\XML\WSDLReader\Wsdl\Message\Part
         */
        $part = reset($parts);

        $class = $this->getClassFromPart($part);
        if ($this->unwrapReturn) {
            foreach ($class->getProperties() as $property) {
                $propertyClass = $property->getType();
                if ($t = $propertyClass->isSimpleType()){
                    return [$t->getType()->getPhpType()];
                }
                return [$propertyClass->getPhpType()];
            }
        }

        if ($t = $class->isSimpleType()){
            return [$t->getType()->getPhpType()];
        }
        return [$class->getPhpType()];
    }

    private function getClassFromPart(Part $part){
        if ($part->getType()) {
            return $this->phpConverter->visitType($part->getType());
        } else {
            return $this->phpConverter->visitElementDef($part->getElement());

        }
    }

    /**
     * @param $part
     * @return array
     */
    private function extractSinglePartParameters(Part $part)
    {
        $params = [];
        $class =  $this->getClassFromPart($part);

        foreach ($class->getProperties() as $property) {
            $t = $property->getType()->getPhpType();
            $params[] = $param = new ParamTag($property->getName(), [$t]);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        }
        return $params;
    }
}


1			<?php
2			namespace GoetasWebservices\SoapServices\SoapClient\StubGeneration;
3
4			use Doctrine\Common\Inflector\Inflector;
5			use GoetasWebservices\SoapServices\SoapClient\StubGeneration\Tag\MethodTag;
6			use GoetasWebservices\SoapServices\SoapClient\StubGeneration\Tag\ParamTag;
7			use GoetasWebservices\XML\WSDLReader\Wsdl\Message\Part;
8			use GoetasWebservices\XML\WSDLReader\Wsdl\PortType;
9			use GoetasWebservices\XML\WSDLReader\Wsdl\Service;
10			use GoetasWebservices\Xsd\XsdToPhp\Naming\NamingStrategy;
11			use GoetasWebservices\Xsd\XsdToPhp\Php\PhpConverter;
12			use Zend\Code\Generator\ClassGenerator;
13			use Zend\Code\Generator\DocBlockGenerator;
14
15			class ClientStubGenerator
16			{
17			protected $reservedWords = [
18			'int',
19			'float',
20			'bool',
21			'string',
22			'true',
23			'false',
24			'null',
25			'resource',
26			'object',
27			'mixed',
28			'numeric',
29			];
30
31			private $baseNs = [
32			'headers' => '\\SoapEnvelope\\Headers',
33			'parts' => '\\SoapEnvelope\\Parts',
34			'messages' => '\\SoapEnvelope\\Messages',
35			];
36			/**
37			* @var NamingStrategy
38			*/
39			private $namingStrategy;
40			/**
41			* @var PhpConverter
42			*/
43			private $phpConverter;
44			/**
45			* @var bool
46			*/
47			private $unwrapReturn = false;
48
49			public function __construct(PhpConverter $phpConverter, NamingStrategy $namingStrategy, $unwrapReturn = false, array $baseNs = array())
50			{
51			foreach ($baseNs as $k => $ns) {
52			if (isset($this->baseNs[$k])) {
53			$this->baseNs[$k] = $ns;
54			}
55			}
56			$this->baseNs = $baseNs;
57			$this->namingStrategy = $namingStrategy;
58			$this->phpConverter = $phpConverter;
59			$this->unwrapReturn = $unwrapReturn;
60			}
61
62			public function setUnwrap($mode = true)
63			{
64			$this->unwrapReturn = (bool)$mode;
65			}
66
67			/**
68			* @param PortType[] $ports
69			* @return ClassGenerator
70			*/
71			public function generate(array $ports)
72			{
73			$classes = array();
74			foreach ($ports as $port) {
75			$class = new ClassGenerator();
76			if ($this->visitPortType($class, $port) !== false) {
77			$classes[] = $class;
78			}
79			}
80			return $classes;
81			}
82
83			private function visitPortType(ClassGenerator $class, PortType $portType)
84			{
85			if (!count($portType->getOperations())) {
86			return false;
87			}
88			$docBlock = new DocBlockGenerator("Class representing " . $portType->getName());
89			$docBlock->setWordWrap(false);
90			if ($portType->getDocumentation()) {
91			$docBlock->setLongDescription($portType->getDocumentation());
92			}
93
94			$namespaces = $this->phpConverter->getNamespaces();
95			$class->setNamespaceName($namespaces[$portType->getDefinition()->getTargetNamespace()] . "\\SoapStubs");
96			$class->setName(Inflector::classify($portType->getName()));
97			$class->setDocblock($docBlock);
98
99			foreach ($portType->getOperations() as $operation) {
100			$operationTag = $this->visitOperation($operation);
101			$docBlock->setTag($operationTag);
102			}
103			}
104
105			private function visitOperation(PortType\Operation $operation)
106			{
107			$types = $this->getOperationReturnTypes($operation);
108			$operationTag = new MethodTag(
109			Inflector::camelize($operation->getName()),
110			$types,
111			preg_replace("/[\n\r]+/", " ", $operation->getDocumentation())
112			);
113			$params = $this->getOperationParams($operation);
114			$operationTag->setParams($params);
115			return $operationTag;
116			}
117
118			private function getOperationParams(PortType\Operation $operation)
119			{
120			if (!$operation->getInput()) {
121			return [];
122			}
123
124			$parts = $operation->getInput()->getMessage()->getParts();
			0 ignored issues – show Bug introduced 2016-09-16 15:40 UTC by Report Bug Copy Issue Report The method `getParts` cannot be called on `$operation->getInput()->getMessage()` (of type `string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
125			if (!$parts) {
126			return [];
127			}
128
129			if (count($parts) > 1) {
130			$params = [];
131			foreach ($parts as $part) {
132			$partName = $this->namingStrategy->getPropertyName($part);
133			$class = $this->getClassFromPart($part);
134
135			$typeName = $class->getPhpType();
136			if ($t = $class->isSimpleType()){
137			$typeName = $t->getType()->getPhpType();
138			}
139			$params[] = $param = new ParamTag($partName, [$typeName]);
			0 ignored issues – show Unused Code introduced 2016-09-16 15:40 UTC by Report Bug Copy Issue Report `$param` 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...
140			}
141			} else {
142			$params = $this->extractSinglePartParameters(reset($parts));
143			}
144
145			return $params;
146			}
147
148			private function getOperationReturnTypes(PortType\Operation $operation)
149			{
150			if (!$operation->getOutput() \|\| !$operation->getOutput()->getMessage()->getParts()) {
			0 ignored issues – show Bug introduced 2016-09-16 15:40 UTC by Report Bug Copy Issue Report The method `getParts` cannot be called on `$operation->getOutput()->getMessage()` (of type `string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
151			return ['void'];
152			}
153			$parts = $operation->getOutput()->getMessage()->getParts();
			0 ignored issues – show Bug introduced 2016-09-16 15:40 UTC by Report Bug Copy Issue Report The method `getParts` cannot be called on `$operation->getOutput()->getMessage()` (of type `string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
154			if (count($parts) > 1) {
155			return ['array'];
156			}
157			/**
158			* @var $part \GoetasWebservices\XML\WSDLReader\Wsdl\Message\Part
159			*/
160			$part = reset($parts);
161
162			$class = $this->getClassFromPart($part);
163			if ($this->unwrapReturn) {
164			foreach ($class->getProperties() as $property) {
165			$propertyClass = $property->getType();
166			if ($t = $propertyClass->isSimpleType()){
167			return [$t->getType()->getPhpType()];
168			}
169			return [$propertyClass->getPhpType()];
170			}
171			}
172
173			if ($t = $class->isSimpleType()){
174			return [$t->getType()->getPhpType()];
175			}
176			return [$class->getPhpType()];
177			}
178
179			private function getClassFromPart(Part $part){
180			if ($part->getType()) {
181			return $this->phpConverter->visitType($part->getType());
182			} else {
183			return $this->phpConverter->visitElementDef($part->getElement());
			0 ignored issues – show Compatibility introduced 2016-09-16 15:40 UTC by Report Bug Copy Issue Report `$part->getElement()` of type `object<GoetasWebservices...ma\Element\ElementItem>` is not a sub-type of `object<GoetasWebservices...ema\Element\ElementDef>`. It seems like you assume a concrete implementation of the interface `GoetasWebservices\XML\XS...ema\Element\ElementItem` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
184			}
185			}
186
187			/**
188			* @param $part
189			* @return array
190			*/
191			private function extractSinglePartParameters(Part $part)
192			{
193			$params = [];
194			$class = $this->getClassFromPart($part);
195
196			foreach ($class->getProperties() as $property) {
197			$t = $property->getType()->getPhpType();
198			$params[] = $param = new ParamTag($property->getName(), [$t]);
			0 ignored issues – show Unused Code introduced 2016-09-16 15:40 UTC by Report Bug Copy Issue Report `$param` 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...
199			}
200			return $params;
201			}
202			}
203

goetas-webservices / soap-client

Push — master ( 030796...0c67b5 )

ClientStubGenerator::visitPortType() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like