Completed
Push — master ( d2fe44...3a429f )
by Mikaël
520:28 queued 470:35
created

Struct::setStruct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 1
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 5
ccs 1
cts 1
cp 1
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 3
nc 1
nop 1
crap 1
1
<?php
2
3
namespace WsdlToPhp\PackageGenerator\Model;
4
5
use WsdlToPhp\PackageGenerator\Generator\Utils;
6
use WsdlToPhp\PackageGenerator\Container\Model\StructValue as StructValueContainer;
7
use WsdlToPhp\PackageGenerator\Container\Model\StructAttribute as StructAttributeContainer;
8
use WsdlToPhp\PackageGenerator\Generator\Generator;
9
use WsdlToPhp\PackageGenerator\ConfigurationReader\StructReservedMethod;
10
use WsdlToPhp\PackageGenerator\ConfigurationReader\StructArrayReservedMethod;
11
12
/**
13
 * Class Struct stands for an available struct described in the WSDL
14
 */
15
class Struct extends AbstractModel
16
{
17
    /**
18
     * @var string
19
     */
20
    const DOC_SUB_PACKAGE_STRUCTS = 'Structs';
21
    /**
22
     * @var string
23
     */
24
    const DOC_SUB_PACKAGE_ENUMERATIONS = 'Enumerations';
25
    /**
26
     * @var string
27
     */
28
    const DOC_SUB_PACKAGE_ARRAYS = 'Arrays';
29
    /**
30
     * Attributes of the struct
31
     * @var StructAttributeContainer
32
     */
33
    private $attributes;
34
    /**
35
     * Is the struct a restriction with defined values  ?
36
     * @var bool
37
     */
38
    private $isRestriction = false;
39
    /**
40
     * If the struct is a restriction with values, then store values
41
     * @var StructValueContainer
42
     */
43
    private $values;
44
    /**
45
     * If the struct is a union with types, then store types
46
     * @var string[]
47
     */
48
    private $types;
49
    /**
50
     * Define if the urrent struct is a concrete struct or just a virtual struct to store meta informations
51
     * @var bool
52
     */
53
    private $isStruct = false;
54
    /**
55
     * Main constructor
56
     * @see AbstractModel::__construct()
57
     * @uses Struct::setStruct()
58 536
     * @param Generator $generator
59
     * @param string $name the original name
60 536
     * @param bool $isStruct defines if it's a real sruct or not
61 536
     * @param bool $isRestriction defines if it's an enumeration or not
62 536
     */
63
    public function __construct(Generator $generator, $name, $isStruct = true, $isRestriction = false)
64
    {
65
        parent::__construct($generator, $name);
66
        $this->setStruct($isStruct)->setRestriction($isRestriction)->setAttributes(new StructAttributeContainer($generator))->setValues(new StructValueContainer($generator));
67
    }
68
    /**
69 256
     * Returns the contextual part of the class name for the package
70
     * @see AbstractModel::getContextualPart()
71 256
     * @uses Struct::isRestriction()
72 256
     * @return string
73 88
     */
74 238
    public function getContextualPart()
75 48
    {
76 24
        $part = $this->getGenerator()->getOptionStructsFolder();
77 256
        if ($this->isRestriction()) {
78
            $part = $this->getGenerator()->getOptionEnumsFolder();
79
        } elseif ($this->isArray()) {
80
            $part = $this->getGenerator()->getOptionArraysFolder();
81
        }
82
        return $part;
83
    }
84
    /**
85
     * Returns the sub package name which the model belongs to
86 140
     * Must be overridden by sub classes
87
     * @see AbstractModel::getDocSubPackages()
88 140
     * @uses Struct::isRestriction()
89 140
     * @return array
90 52
     */
91 124
    public function getDocSubPackages()
92 28
    {
93 14
        $package = self::DOC_SUB_PACKAGE_STRUCTS;
94
        if ($this->isRestriction()) {
95 140
            $package = self::DOC_SUB_PACKAGE_ENUMERATIONS;
96 70
        } elseif ($this->isArray()) {
97
            $package = self::DOC_SUB_PACKAGE_ARRAYS;
98
        }
99
        return array(
100
            $package,
101
        );
102
    }
103
    /**
104 284
     * Returns true if the current struct is a collection of values (like an array)
105
     * @uses AbstractModel::getName()
106 284
     * @uses Struct::countOwnAttributes()
107
     * @return bool
108
     */
109
    public function isArray()
110
    {
111
        return ((($this->isStruct() && $this->countOwnAttributes() === 1) || (!$this->isStruct() && $this->countOwnAttributes() <= 1)) && stripos($this->getName(), 'array') !== false);
112
    }
113
    /**
114
     * Returns the attributes of the struct and potentially from the parent class
115
     * @uses AbstractModel::getInheritance()
116
     * @uses Struct::isStruct()
117 296
     * @uses Struct::getAttributes()
118
     * @param bool $includeInheritanceAttributes include the attributes of parent class, default parent attributes are not included. If true, then the array is an associative array containing and index "attribute" for the StructAttribute object and an index "model" for the Struct object.
119 296
     * @param bool $requiredFirst places the required attributes first, then the not required in order to have the _contrust method with the required attribute at first
120 296
     * @return StructAttributeContainer
121 148
     */
122 104
    public function getAttributes($includeInheritanceAttributes = false, $requiredFirst = false)
123
    {
124 296
        if ($includeInheritanceAttributes === false && $requiredFirst === false) {
125
            $attributes = $this->attributes;
126
        } else {
127
            $attributes = $this->getAllAttributes($includeInheritanceAttributes, $requiredFirst);
128
        }
129
        return $attributes;
130
    }
131 104
    /**
132
     * @param bool $includeInheritanceAttributes
133 104
     * @param bool $requiredFirst
134 104
     * @return StructAttributeContainer
135 4
     */
136 2
    protected function getAllAttributes($includeInheritanceAttributes, $requiredFirst)
137 104
    {
138 104
        $allAttributes = new StructAttributeContainer($this->getGenerator());
139 52
        if ($includeInheritanceAttributes === true) {
140 104
            $this->addInheritanceAttributes($allAttributes);
141 104
        }
142 52
        foreach ($this->attributes as $attribute) {
143
            $allAttributes->add($attribute);
144
        }
145 104
        if ($requiredFirst === true) {
146
            $attributes = $this->putRequiredFirst($allAttributes);
147
        } else {
148
            $attributes = $allAttributes;
149
        }
150 4
        return $attributes;
151
    }
152 4
    /**
153
     * @param StructAttributeContainer $attributes
154
     */
155
    protected function addInheritanceAttributes(StructAttributeContainer $attributes)
156
    {
157
        if ($this->getInheritance() != '' && ($model = $this->getInheritanceStruct()) instanceof Struct) {
158
            while ($model instanceof Struct && $model->isStruct()) {
159
                foreach ($model->getAttributes() as $attribute) {
160 4
                    $attributes->add($attribute);
161
                }
162
                $model = $model->getInheritanceStruct();
163
            }
164
        }
165 104
    }
166
    /**
167 104
     * @param StructAttributeContainer $allAttributes
168 104
     * @return StructAttributeContainer
169 104
     */
170 104
    protected function putRequiredFirst(StructAttributeContainer $allAttributes)
171 104
    {
172 28
        $attributes = new StructAttributeContainer($this->getGenerator());
173 14
        $requiredAttributes = new StructAttributeContainer($this->getGenerator());
174 100
        $notRequiredAttributes = new StructAttributeContainer($this->getGenerator());
175
        foreach ($allAttributes as $attribute) {
176 52
            if ($attribute->isRequired()) {
177 104
                $requiredAttributes->add($attribute);
178 28
            } else {
179 52
                $notRequiredAttributes->add($attribute);
180 104
            }
181 96
        }
182 52
        foreach ($requiredAttributes as $attribute) {
183 104
            $attributes->add($attribute);
184 104
        }
185
        foreach ($notRequiredAttributes as $attribute) {
186
            $attributes->add($attribute);
187
        }
188
        unset($requiredAttributes, $notRequiredAttributes);
189
        return $attributes;
190
    }
191 284
    /**
192
     * Returns the number of own attributes
193 284
     * @uses Struct::getAttributes()
194
     * @return int
195
     */
196
    public function countOwnAttributes()
197
    {
198
        return $this->getAttributes(false, false)->count();
199
    }
200 536
    /**
201
     * Sets the attributes of the struct
202 536
     * @param StructAttributeContainer $structAttributeContainer
203 536
     * @return Struct
204
     */
205
    public function setAttributes(StructAttributeContainer $structAttributeContainer)
206
    {
207
        $this->attributes = $structAttributeContainer;
208
        return $this;
209
    }
210
    /**
211
     * Adds attribute based on its original name
212 480
     * @throws \InvalidArgumentException
213
     * @param string $attributeName the attribute name
214 480
     * @param string $attributeType the attribute type
215 8
     * @return Struct
216
     */
217 472
    public function addAttribute($attributeName, $attributeType)
218 468
    {
219 468
        if (empty($attributeName) || empty($attributeType)) {
220 234
            throw new \InvalidArgumentException(sprintf('Attribute name "%s" and/or attribute type "%s" is invalid for Struct "%s"', $attributeName, $attributeType, $this->getName()), __LINE__);
221 472
        }
222
        if ($this->attributes->getStructAttributeByName($attributeName) === null) {
223
            $structAttribute = new StructAttribute($this->getGenerator(), $attributeName, $attributeType, $this);
224
            $this->attributes->add($structAttribute);
225
        }
226
        return $this;
227
    }
228
    /**
229 336
     * Returns the attribute by its name, otherwise null
230
     * @uses Struct::getAttributes()
231 336
     * @param string $attributeName the original attribute name
232
     * @return StructAttribute|null
233
     */
234
    public function getAttribute($attributeName)
235
    {
236
        return $this->attributes->getStructAttributeByName($attributeName);
237 288
    }
238
    /**
239 288
     * Returns the attribute by its cleaned name, otherwise null
240
     * @uses Struct::getAttributes()
241
     * @param string $attributeCleanName the cleaned attribute name
242
     * @return StructAttribute|null
243
     */
244
    public function getAttributeByCleanName($attributeCleanName)
245
    {
246 536
        return $this->attributes->getStructAttributeByCleanName($attributeCleanName);
247
    }
248 536
    /**
249 536
     * Returns the isRestriction value
250
     * @return bool
251
     */
252
    public function isRestriction()
253
    {
254
        return $this->isRestriction;
255 312
    }
256
    /**
257 312
     * Sets the isRestriction value
258
     * @param bool $isRestriction
259
     * @return Struct
260
     */
261
    public function setRestriction($isRestriction = true)
262
    {
263
        $this->isRestriction = $isRestriction;
264 536
        return $this;
265
    }
266 536
    /**
267 536
     * Returns the isStruct value
268
     * @return bool
269
     */
270
    public function isStruct()
271
    {
272
        return $this->isStruct;
273 300
    }
274
    /**
275 300
     * Sets the isStruct value
276
     * @param bool $isStruct
277
     * @return Struct
278
     */
279
    public function setStruct($isStruct = true)
280
    {
281
        $this->isStruct = $isStruct;
282 536
        return $this;
283
    }
284 536
    /**
285 536
     * Returns the values for an enumeration
286
     * @return StructValueContainer
287
     */
288
    public function getValues()
289
    {
290
        return $this->values;
291
    }
292
    /**
293
     * Sets the values for an enumeration
294 304
     * @param StructValueContainer $structValueContainer
295
     * @return Struct
296 304
     */
297 300
    protected function setValues(StructValueContainer $structValueContainer)
298 300
    {
299 300
        $this->values = $structValueContainer;
300 150
        return $this;
301 304
    }
302
    /**
303
     * Adds value to values array
304
     * @uses Struct::getValue()
305
     * @uses Struct::getValues()
306
     * @param mixed $value the original value
307
     * @return Struct
308
     */
309
    public function addValue($value)
310 304
    {
311
        if ($this->getValue($value) === null) {
312 304
            $this->values->add(new StructValue($this->getGenerator(), $value, $this->getValues()->count(), $this));
313
            $this->setRestriction(true);
314
            $this->setStruct(true);
315
        }
316
        return $this;
317
    }
318
    /**
319 132
     * Gets the value object for the given value
320
     * @uses Struct::getValues()
321 132
     * @uses AbstractModel::getName()
322 132
     * @param string $value Value name
323 28
     * @return StructValue|null
324 122
     */
325 84
    public function getValue($value)
326 42
    {
327 132
        return $this->values->getStructValueByName($value);
328
    }
329
    /**
330
     * Allows to define from which class the curent model extends
331
     * @param bool $short
332 168
     * @return string
333
     */
334 168
    public function getExtends($short = false)
335
    {
336
        $extends = '';
337
        if ($this->isArray()) {
338
            $extends = $this->getGenerator()->getOptionStructArrayClass();
339 96
        } elseif (!$this->isRestriction()) {
340
            $extends = $this->getGenerator()->getOptionStructClass();
341 96
        }
342 96
        return $short ? Utils::removeNamespace($extends) : $extends;
343 44
    }
344 44
    /**
345 36
     * @return Struct|null
346 36
     */
347 16
    public function getInheritanceStruct()
348 8
    {
349 36
        return $this->getGenerator()->getStruct(str_replace('[]', '', $this->getInheritance()));
350 18
    }
351 22
    /**
352 96
     * @return string
353
     */
354
    public function getTopInheritance()
355
    {
356
        $inheritance = $this->getInheritance();
357
        if (!empty($inheritance)) {
358 160
            $struct = $this->getInheritanceStruct();
359
            while ($struct instanceof Struct) {
360 160
                $structInheritance = $struct->getInheritance();
361 160
                if (!empty($structInheritance)) {
362
                    $inheritance = $structInheritance;
363
                }
364
                $struct = $struct->getInheritanceStruct();
365
            }
366
        }
367 116
        return $inheritance;
368
    }
369 116
    /**
370 116
     * @see \WsdlToPhp\PackageGenerator\Model\AbstractModel::getMeta()
371 32
     * @return string[]
372 16
     */
373 116
    public function getMeta()
374
    {
375
        $inheritanceStruct = $this->getInheritanceStruct();
376
        return array_merge_recursive(parent::getMeta(), ($inheritanceStruct && !$inheritanceStruct->isStruct()) ? $inheritanceStruct->getMeta() : array());
377
    }
378
    /**
379
     * @param $filename
380
     * @return StructReservedMethod|StructArrayReservedMethod
381
     */
382
    public function getReservedMethodsInstance($filename = null)
383
    {
384
        $instance = StructReservedMethod::instance($filename);
385
        if ($this->isArray()) {
386
            $instance = StructArrayReservedMethod::instance($filename);
387
        }
388
        return $instance;
389
    }
390
    /**
391
     * @return string[]
392
     */
393
    public function getTypes()
394
    {
395
        return $this->types;
396
    }
397
    /**
398
     * @return boolean
399
     */
400
    public function isUnion()
401
    {
402
        return count($this->types) > 0;
403
    }
404
    /**
405
     * @param string[] $types
406
     * @return Struct
407
     */
408
    public function setTypes($types)
409
    {
410
        $this->types = $types;
411
        return $this;
412
    }
413
}
414