ParserVarSeq::getEntity()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 3
ccs 2
cts 2
cp 1
crap 1
rs 10
1
<?php
2
/**
3
 * This file is part of graze/unicontroller-client.
4
 *
5
 * Copyright (c) 2016 Nature Delivered Ltd. <https://www.graze.com>
6
 *
7
 * For the full copyright and license information, please view the LICENSE
8
 * file that was distributed with this source code.
9
 *
10
 * @license https://github.com/graze/unicontroller-client/blob/master/LICENSE.md
11
 * @link https://github.com/graze/unicontroller-client
12
 */
13
namespace Graze\UnicontrollerClient\Parser\Parser;
14
15
use Graze\UnicontrollerClient\Parser\Parser\AbstractParser;
16
use Graze\UnicontrollerClient\Parser\Parser\ParserInterface;
17
use Graze\UnicontrollerClient\Entity\Entity\EntityVarSeq;
18
19
class ParserVarSeq extends AbstractParser implements ParserInterface
20
{
21
    /**
22
     * @return []
0 ignored issues
show
Documentation Bug introduced by
The doc comment [] at position 0 could not be parsed: Unknown type name '[' at position 0 in [].
Loading history...
23
     */
24 2
    protected function getProperties()
25
    {
26
        return [
27 2
            'name',
28 2
            'prompt',
29 2
            'length',
30 2
            'interval',
31 2
            'inputType',
32 2
            'outputType',
33 2
            'minValue',
34 2
            'maxValue',
35 2
            'rollOver',
36 2
            'fixedStart',
37 2
            'startValue',
38 2
            'paddingType',
39 2
            'repeatCount',
40
            'resumeCount'
41 2
        ];
42
    }
43
44
    /**
45
     * @return EntityVarSeq
46
     */
47 2
    protected function getEntity()
48
    {
49 2
        return new EntityVarSeq();
0 ignored issues
show
Bug Best Practice introduced by
The expression return new Graze\Unicont...y\Entity\EntityVarSeq() returns the type Graze\UnicontrollerClien...ity\Entity\EntityVarSeq which is incompatible with the return type mandated by Graze\UnicontrollerClien...ractParser::getEntity() of Graze\UnicontrollerClien...\Entity\EntityInterface.

In the issue above, the returned value is violating the contract defined by the mentioned interface.

Let's take a look at an example:

interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
Loading history...
50
    }
51
}
52