ParserVarDatabase::getProperties()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 25
Code Lines 23

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 22
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 23
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 25
ccs 22
cts 22
cp 1
crap 1
rs 9.552
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\EntityVarDatabase;
18
19
class ParserVarDatabase 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 1
    protected function getProperties()
25
    {
26
        return [
27 1
            'name',
28 1
            'dataSource',
29 1
            'refFileName',
30 1
            'table',
31 1
            'keyField',
32 1
            'dataField',
33 1
            'prompt',
34 1
            'displayLength',
35 1
            'trimTrailingSpaces',
36 1
            'printAll',
37 1
            'fixedKey',
38 1
            'singleData',
39 1
            'usePrompt',
40 1
            'keyData',
41 1
            'fixedKeyData',
42 1
            'codePage',
43 1
            'numberOfDecimals',
44 1
            'runSequence',
45 1
            'actionWhenDone',
46 1
            'rawBaseData',
47 1
            'databaseType',
48
            'cPadding'
49 1
        ];
50
    }
51
52
    /**
53
     * @return EntityVarDatabase
54
     */
55 1
    protected function getEntity()
56
    {
57 1
        return new EntityVarDatabase();
0 ignored issues
show
Bug Best Practice introduced by
The expression return new Graze\Unicont...ity\EntityVarDatabase() returns the type Graze\UnicontrollerClien...ntity\EntityVarDatabase 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...
58
    }
59
}
60