StructArray::getStructMethodAnnotationBlock() - Code Metrics - Inspection of "issue #93 - update unit test case resource" - WsdlToPhp/PackageGenerator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/issue-93 ( aa5f82...43222b )

by Mikaël

created 2017-06-01 14:42 UTC

StructArray::getStructMethodAnnotationBlock() C

↳ Parent: StructArray

Complexity

Conditions	8
Paths	8

Size

Total Lines	30
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	28
CRAP Score	8

Importance

Changes

Metric	Value
dl	0
loc	30
ccs	28
cts	28
cp	1
rs	5.3846
c	0
b	0
f	0
cc	8
eloc	27
nc	8
nop	1
crap	8

<?php

namespace WsdlToPhp\PackageGenerator\File;

use WsdlToPhp\PackageGenerator\Model\AbstractModel;
use WsdlToPhp\PackageGenerator\Model\Struct as StructModel;
use WsdlToPhp\PhpGenerator\Element\PhpAnnotation;
use WsdlToPhp\PhpGenerator\Element\PhpAnnotationBlock;
use WsdlToPhp\PhpGenerator\Element\PhpMethod;
use WsdlToPhp\PackageGenerator\Container\PhpElement\Method as MethodContainer;

class StructArray extends Struct
{
    /**
     * @var string
     */
    const METHOD_GET_ATTRIBUTE_NAME = 'getAttributeName';
    /**
     * @var string
     */
    const METHOD_CURRENT = 'current';
    /**
     * @var string
     */
    const METHOD_ITEM = 'item';
    /**
     * @var string
     */
    const METHOD_FIRST = 'first';
    /**
     * @var string
     */
    const METHOD_LAST = 'last';
    /**
     * @var string
     */
    const METHOD_OFFSET_GET = 'offsetGet';
    /**
     * @var string
     */
    const METHOD_ADD = 'add';
    /**
     * @see \WsdlToPhp\PackageGenerator\File\Struct::addStructMethodsSetAndGet()
     */
    public function addStructMethodsSetAndGet(MethodContainer $methods)
    {
        parent::addStructMethodsSetAndGet($methods);
        $this->addArrayMethodCurrent($methods)
            ->addArrayMethodItem($methods)
            ->addArrayMethodFirst($methods)
            ->addArrayMethodLast($methods)
            ->addArrayMethodOffsetGet($methods)
            ->addArrayMethodAdd($methods)
            ->addArrayMethodGetAttributeName($methods);
        return $this;
    }
    /**
     * @param MethodContainer $methods
     * @return StructArray
     */
    protected function addArrayMethodCurrent(MethodContainer $methods)
    {
        return $this->addArrayMethodGenericMethod($methods, self::METHOD_CURRENT, $this->getArrayMethodBody(self::METHOD_CURRENT));
    }
    /**
     * @param MethodContainer $methods
     * @return StructArray
     */
    protected function addArrayMethodItem(MethodContainer $methods)
    {
        return $this->addArrayMethodGenericMethod($methods, self::METHOD_ITEM, $this->getArrayMethodBody(self::METHOD_ITEM, '$index'), array(
            'index',
        ));
    }
    /**
     * @param MethodContainer $methods
     * @return StructArray
     */
    protected function addArrayMethodFirst(MethodContainer $methods)
    {
        return $this->addArrayMethodGenericMethod($methods, self::METHOD_FIRST, $this->getArrayMethodBody(self::METHOD_FIRST));
    }
    /**
     * @param MethodContainer $methods
     * @return StructArray
     */
    protected function addArrayMethodLast(MethodContainer $methods)
    {
        return $this->addArrayMethodGenericMethod($methods, self::METHOD_LAST, $this->getArrayMethodBody(self::METHOD_LAST));
    }
    /**
     * @param MethodContainer $methods
     * @return StructArray
     */
    protected function addArrayMethodOffsetGet(MethodContainer $methods)
    {
        return $this->addArrayMethodGenericMethod($methods, self::METHOD_OFFSET_GET, $this->getArrayMethodBody(self::METHOD_OFFSET_GET, '$offset'), array(
            'offset',
        ));
    }
    /**
     * @param MethodContainer $methods
     * @return StructArray
     */
    protected function addArrayMethodGetAttributeName(MethodContainer $methods)
    {
        return $this->addArrayMethodGenericMethod($methods, self::METHOD_GET_ATTRIBUTE_NAME, sprintf('return \'%s\';', $this->getModel()
            ->getAttributes()
            ->offsetGet(0)
            ->getName()));
    }
    /**
     * @param MethodContainer $methods
     * @return StructArray
     */
    protected function addArrayMethodAdd(MethodContainer $methods)
    {
        if ($this->getRestrictionFromStructAttribute() instanceof StructModel) {
            $method = new PhpMethod(self::METHOD_ADD, array(
                'item',
            ));
            $this->addStructMethodSetBodyForRestriction($method, $this->getModel()->getAttributes()->offsetGet(0), 'item');
            $method->addChild('return parent::add($item);');
            $methods->add($method);
        }
        return $this;
    }
    /**
     * @param MethodContainer $methods
     * @param string $name
     * @param string $body
     * @param string[] $methodParameters
     * @return StructArray
     */
    protected function addArrayMethodGenericMethod(MethodContainer $methods, $name, $body, array $methodParameters = array())
    {
        $method = new PhpMethod($name, $methodParameters);
        $method->addChild($body);
        $methods->add($method);
        return $this;
    }
    /**
     * @return PhpAnnotationBlock
     */
    protected function getArrayMethodGetAttributeNameAnnotationBlock()
    {
        return new PhpAnnotationBlock(array(
            'Returns the attribute name',
            new PhpAnnotation(self::ANNOTATION_SEE, sprintf('%s::%s()', $this->getModel()->getExtends(true), self::METHOD_GET_ATTRIBUTE_NAME)),
            new PhpAnnotation(self::ANNOTATION_RETURN, sprintf('string %s', $this->getModel()->getAttributes()->offsetGet(0)->getName())),
        ));
    }
    /**
     * @return PhpAnnotationBlock
     */
    protected function getArrayMethodCurrentAnnotationBlock()
    {
        return $this->getArrayMethodGenericAnnotationBlock(self::METHOD_CURRENT, 'Returns the current element');
    }
    /**
     * @return PhpAnnotationBlock
     */
    protected function getArrayMethodFirstAnnotationBlock()
    {
        return $this->getArrayMethodGenericAnnotationBlock(self::METHOD_FIRST, 'Returns the first element');
    }
    /**
     * @return PhpAnnotationBlock
     */
    protected function getArrayMethodLastAnnotationBlock()
    {
        return $this->getArrayMethodGenericAnnotationBlock(self::METHOD_LAST, 'Returns the last element');
    }
    /**
     * @return PhpAnnotationBlock
     */
    protected function getArrayMethodItemAnnotationBlock()
    {
        return $this->getArrayMethodGenericAnnotationBlock(self::METHOD_ITEM, 'Returns the indexed element', 'int $index');
    }
    /**
     * @return PhpAnnotationBlock
     */
    protected function getArrayMethodOffsetGetAnnotationBlock()
    {
        return $this->getArrayMethodGenericAnnotationBlock(self::METHOD_OFFSET_GET, 'Returns the element at the offset', 'int $offset');
    }
    /**
     * @return PhpAnnotationBlock
     */
    protected function getArrayMethodAddAnnotationBlock()
    {
        return new PhpAnnotationBlock(array(
            'Add element to array',
            new PhpAnnotation(self::ANNOTATION_SEE, sprintf('%s::add()', $this->getModel()->getExtends(true))),
            new PhpAnnotation(self::ANNOTATION_THROWS, '\InvalidArgumentException'),
            new PhpAnnotation(self::ANNOTATION_USES, sprintf('%s::valueIsValid()', $this->getModelFromStructAttribute()->getPackagedName(true))),
            new PhpAnnotation(self::ANNOTATION_PARAM, sprintf('%s $item', $this->getStructAttributeType())),
            new PhpAnnotation(self::ANNOTATION_RETURN, sprintf('%s', $this->getModel()->getPackagedName(true))),
        ));
    }
    /**
     * @param string $name
     * @param string $description
     * @param string $param
     * @return PhpAnnotationBlock
     */
    protected function getArrayMethodGenericAnnotationBlock($name, $description, $param = null)
    {
        $annotationBlock = new PhpAnnotationBlock(array(
            $description,
            new PhpAnnotation(self::ANNOTATION_SEE, sprintf('%s::%s()', $this->getModel()->getExtends(true), $name)),
        ));
        if (!empty($param)) {
            $annotationBlock->addChild(new PhpAnnotation(self::ANNOTATION_PARAM, $param));
        }
        $annotationBlock->addChild(new PhpAnnotation(self::ANNOTATION_RETURN, $this->getStructAttributeTypeGetAnnotation(null, false)));
        return $annotationBlock;
    }
    /**
     * @param PhpMethod $method
     * @return PhpAnnotationBlock|null
     */
    protected function getStructMethodAnnotationBlock(PhpMethod $method)
    {
        switch ($method->getName()) {
            case self::METHOD_GET_ATTRIBUTE_NAME:
                $annotationBlock = $this->getArrayMethodGetAttributeNameAnnotationBlock();
                break;
            case self::METHOD_CURRENT:
                $annotationBlock = $this->getArrayMethodCurrentAnnotationBlock();
                break;
            case self::METHOD_FIRST:
                $annotationBlock = $this->getArrayMethodFirstAnnotationBlock();
                break;
            case self::METHOD_ITEM:
                $annotationBlock = $this->getArrayMethodItemAnnotationBlock();
                break;
            case self::METHOD_LAST:
                $annotationBlock = $this->getArrayMethodLastAnnotationBlock();
                break;
            case self::METHOD_OFFSET_GET:
                $annotationBlock = $this->getArrayMethodOffsetGetAnnotationBlock();
                break;
            case self::METHOD_ADD:
                $annotationBlock = $this->getArrayMethodAddAnnotationBlock();
                break;
            default:
                $annotationBlock = parent::getStructMethodAnnotationBlock($method);
                break;
        }
        return $annotationBlock;
    }
    /**
     * @param string $method
     * @param string $var
     * @return string
     */
    protected function getArrayMethodBody($method, $var = '')
    {
        return sprintf('return parent::%s(%s);', $method, $var);
    }
    /**
     * @see \WsdlToPhp\PackageGenerator\File\AbstractModelFile::setModel()
     * @throws \InvalidArgumentException
     * @param AbstractModel $model
     * @return StructArray
     */
    public function setModel(AbstractModel $model)
    {
        if ($model instanceof StructModel && !$model->isArray()) {
            throw new \InvalidArgumentException('The model is not a valid array struct (name must contain Array and the model must contain only one property', __LINE__);
        }
        return parent::setModel($model);
    }
}


1		<?php
2
3		namespace WsdlToPhp\PackageGenerator\File;
4
5		use WsdlToPhp\PackageGenerator\Model\AbstractModel;
6		use WsdlToPhp\PackageGenerator\Model\Struct as StructModel;
7		use WsdlToPhp\PhpGenerator\Element\PhpAnnotation;
8		use WsdlToPhp\PhpGenerator\Element\PhpAnnotationBlock;
9		use WsdlToPhp\PhpGenerator\Element\PhpMethod;
10		use WsdlToPhp\PackageGenerator\Container\PhpElement\Method as MethodContainer;
11
12		class StructArray extends Struct
13		{
14		/**
15		* @var string
16		*/
17		const METHOD_GET_ATTRIBUTE_NAME = 'getAttributeName';
18		/**
19		* @var string
20		*/
21		const METHOD_CURRENT = 'current';
22		/**
23		* @var string
24		*/
25		const METHOD_ITEM = 'item';
26		/**
27		* @var string
28		*/
29		const METHOD_FIRST = 'first';
30		/**
31		* @var string
32		*/
33		const METHOD_LAST = 'last';
34		/**
35		* @var string
36		*/
37		const METHOD_OFFSET_GET = 'offsetGet';
38		/**
39		* @var string
40		*/
41		const METHOD_ADD = 'add';
42		/**
43		* @see \WsdlToPhp\PackageGenerator\File\Struct::addStructMethodsSetAndGet()
44		*/
45	48	public function addStructMethodsSetAndGet(MethodContainer $methods)
46		{
47	48	parent::addStructMethodsSetAndGet($methods);
48	48	$this->addArrayMethodCurrent($methods)
49	48	->addArrayMethodItem($methods)
50	48	->addArrayMethodFirst($methods)
51	48	->addArrayMethodLast($methods)
52	48	->addArrayMethodOffsetGet($methods)
53	48	->addArrayMethodAdd($methods)
54	48	->addArrayMethodGetAttributeName($methods);
55	48	return $this;
56		}
57		/**
58		* @param MethodContainer $methods
59		* @return StructArray
60		*/
61	48	protected function addArrayMethodCurrent(MethodContainer $methods)
62		{
63	48	return $this->addArrayMethodGenericMethod($methods, self::METHOD_CURRENT, $this->getArrayMethodBody(self::METHOD_CURRENT));
64		}
65		/**
66		* @param MethodContainer $methods
67		* @return StructArray
68		*/
69	48	protected function addArrayMethodItem(MethodContainer $methods)
70		{
71	48	return $this->addArrayMethodGenericMethod($methods, self::METHOD_ITEM, $this->getArrayMethodBody(self::METHOD_ITEM, '$index'), array(
72	48	'index',
73	32	));
74		}
75		/**
76		* @param MethodContainer $methods
77		* @return StructArray
78		*/
79	48	protected function addArrayMethodFirst(MethodContainer $methods)
80		{
81	48	return $this->addArrayMethodGenericMethod($methods, self::METHOD_FIRST, $this->getArrayMethodBody(self::METHOD_FIRST));
82		}
83		/**
84		* @param MethodContainer $methods
85		* @return StructArray
86		*/
87	48	protected function addArrayMethodLast(MethodContainer $methods)
88		{
89	48	return $this->addArrayMethodGenericMethod($methods, self::METHOD_LAST, $this->getArrayMethodBody(self::METHOD_LAST));
90		}
91		/**
92		* @param MethodContainer $methods
93		* @return StructArray
94		*/
95	48	protected function addArrayMethodOffsetGet(MethodContainer $methods)
96		{
97	48	return $this->addArrayMethodGenericMethod($methods, self::METHOD_OFFSET_GET, $this->getArrayMethodBody(self::METHOD_OFFSET_GET, '$offset'), array(
98	48	'offset',
99	32	));
100		}
101		/**
102		* @param MethodContainer $methods
103		* @return StructArray
104		*/
105	48	protected function addArrayMethodGetAttributeName(MethodContainer $methods)
106		{
107	48	return $this->addArrayMethodGenericMethod($methods, self::METHOD_GET_ATTRIBUTE_NAME, sprintf('return \'%s\';', $this->getModel()
108	48	->getAttributes()
109	48	->offsetGet(0)
110	48	->getName()));
111		}
112		/**
113		* @param MethodContainer $methods
114		* @return StructArray
115		*/
116	48	protected function addArrayMethodAdd(MethodContainer $methods)
117		{
118	48	if ($this->getRestrictionFromStructAttribute() instanceof StructModel) {
119	24	$method = new PhpMethod(self::METHOD_ADD, array(
120	24	'item',
121	16	));
122	24	$this->addStructMethodSetBodyForRestriction($method, $this->getModel()->getAttributes()->offsetGet(0), 'item');
123	24	$method->addChild('return parent::add($item);');
124	24	$methods->add($method);
125	16	}
126	48	return $this;
127		}
128		/**
129		* @param MethodContainer $methods
130		* @param string $name
131		* @param string $body
132		* @param string[] $methodParameters
133		* @return StructArray
134		*/
135	48	protected function addArrayMethodGenericMethod(MethodContainer $methods, $name, $body, array $methodParameters = array())
136		{
137	48	$method = new PhpMethod($name, $methodParameters);
138	48	$method->addChild($body);
139	48	$methods->add($method);
140	48	return $this;
141		}
142		/**
143		* @return PhpAnnotationBlock
144		*/
145	48	protected function getArrayMethodGetAttributeNameAnnotationBlock()
146		{
147	48	return new PhpAnnotationBlock(array(
148	48	'Returns the attribute name',
149	48	new PhpAnnotation(self::ANNOTATION_SEE, sprintf('%s::%s()', $this->getModel()->getExtends(true), self::METHOD_GET_ATTRIBUTE_NAME)),
150	48	new PhpAnnotation(self::ANNOTATION_RETURN, sprintf('string %s', $this->getModel()->getAttributes()->offsetGet(0)->getName())),
151	32	));
152		}
153		/**
154		* @return PhpAnnotationBlock
155		*/
156	48	protected function getArrayMethodCurrentAnnotationBlock()
157		{
158	48	return $this->getArrayMethodGenericAnnotationBlock(self::METHOD_CURRENT, 'Returns the current element');
159		}
160		/**
161		* @return PhpAnnotationBlock
162		*/
163	48	protected function getArrayMethodFirstAnnotationBlock()
164		{
165	48	return $this->getArrayMethodGenericAnnotationBlock(self::METHOD_FIRST, 'Returns the first element');
166		}
167		/**
168		* @return PhpAnnotationBlock
169		*/
170	48	protected function getArrayMethodLastAnnotationBlock()
171		{
172	48	return $this->getArrayMethodGenericAnnotationBlock(self::METHOD_LAST, 'Returns the last element');
173		}
174		/**
175		* @return PhpAnnotationBlock
176		*/
177	48	protected function getArrayMethodItemAnnotationBlock()
178		{
179	48	return $this->getArrayMethodGenericAnnotationBlock(self::METHOD_ITEM, 'Returns the indexed element', 'int $index');
180		}
181		/**
182		* @return PhpAnnotationBlock
183		*/
184	48	protected function getArrayMethodOffsetGetAnnotationBlock()
185		{
186	48	return $this->getArrayMethodGenericAnnotationBlock(self::METHOD_OFFSET_GET, 'Returns the element at the offset', 'int $offset');
187		}
188		/**
189		* @return PhpAnnotationBlock
190		*/
191	24	protected function getArrayMethodAddAnnotationBlock()
192		{
193	24	return new PhpAnnotationBlock(array(
194	24	'Add element to array',
195	24	new PhpAnnotation(self::ANNOTATION_SEE, sprintf('%s::add()', $this->getModel()->getExtends(true))),
196	24	new PhpAnnotation(self::ANNOTATION_THROWS, '\InvalidArgumentException'),
197	24	new PhpAnnotation(self::ANNOTATION_USES, sprintf('%s::valueIsValid()', $this->getModelFromStructAttribute()->getPackagedName(true))),
198	24	new PhpAnnotation(self::ANNOTATION_PARAM, sprintf('%s $item', $this->getStructAttributeType())),
199	24	new PhpAnnotation(self::ANNOTATION_RETURN, sprintf('%s', $this->getModel()->getPackagedName(true))),
200	16	));
201		}
202		/**
203		* @param string $name
204		* @param string $description
205		* @param string $param
206		* @return PhpAnnotationBlock
207		*/
208	48	protected function getArrayMethodGenericAnnotationBlock($name, $description, $param = null)
209		{
210	48	$annotationBlock = new PhpAnnotationBlock(array(
211	48	$description,
212	48	new PhpAnnotation(self::ANNOTATION_SEE, sprintf('%s::%s()', $this->getModel()->getExtends(true), $name)),
213	32	));
214	48	if (!empty($param)) {
215	48	$annotationBlock->addChild(new PhpAnnotation(self::ANNOTATION_PARAM, $param));
216	32	}
217	48	$annotationBlock->addChild(new PhpAnnotation(self::ANNOTATION_RETURN, $this->getStructAttributeTypeGetAnnotation(null, false)));
218	48	return $annotationBlock;
219		}
220		/**
221		* @param PhpMethod $method
222		* @return PhpAnnotationBlock\|null
223		*/
224	48	protected function getStructMethodAnnotationBlock(PhpMethod $method)
225		{
226	48	switch ($method->getName()) {
227	48	case self::METHOD_GET_ATTRIBUTE_NAME:
228	48	$annotationBlock = $this->getArrayMethodGetAttributeNameAnnotationBlock();
229	48	break;
230	48	case self::METHOD_CURRENT:
231	48	$annotationBlock = $this->getArrayMethodCurrentAnnotationBlock();
232	48	break;
233	48	case self::METHOD_FIRST:
234	48	$annotationBlock = $this->getArrayMethodFirstAnnotationBlock();
235	48	break;
236	48	case self::METHOD_ITEM:
237	48	$annotationBlock = $this->getArrayMethodItemAnnotationBlock();
238	48	break;
239	48	case self::METHOD_LAST:
240	48	$annotationBlock = $this->getArrayMethodLastAnnotationBlock();
241	48	break;
242	48	case self::METHOD_OFFSET_GET:
243	48	$annotationBlock = $this->getArrayMethodOffsetGetAnnotationBlock();
244	48	break;
245	48	case self::METHOD_ADD:
246	24	$annotationBlock = $this->getArrayMethodAddAnnotationBlock();
247	24	break;
248	32	default:
249	48	$annotationBlock = parent::getStructMethodAnnotationBlock($method);
250	48	break;
251	32	}
252	48	return $annotationBlock;
253		}
254		/**
255		* @param string $method
256		* @param string $var
257		* @return string
258		*/
259	48	protected function getArrayMethodBody($method, $var = '')
260		{
261	48	return sprintf('return parent::%s(%s);', $method, $var);
262		}
263		/**
264		* @see \WsdlToPhp\PackageGenerator\File\AbstractModelFile::setModel()
265		* @throws \InvalidArgumentException
266		* @param AbstractModel $model
267		* @return StructArray
268		*/
269	66	public function setModel(AbstractModel $model)
270		{
271	66	if ($model instanceof StructModel && !$model->isArray()) {
272	12	throw new \InvalidArgumentException('The model is not a valid array struct (name must contain Array and the model must contain only one property', __LINE__);
273		}
274	54	return parent::setModel($model);
275		}
276		}
277

WsdlToPhp / PackageGenerator

Push — feature/issue-93 ( aa5f82...43222b )

StructArray::getStructMethodAnnotationBlock() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like