Completed
Push — master ( a2b732...080f9b )
by Rai
10s
created

BaseEntity   B

Complexity

Total Complexity 39

Size/Duplication

Total Lines 220
Duplicated Lines 10.45 %

Coupling/Cohesion

Components 1
Dependencies 1

Importance

Changes 0
Metric Value
dl 23
loc 220
rs 8.2857
c 0
b 0
f 0
wmc 39
lcom 1
cbo 1

19 Methods

Rating   Name   Duplication   Size   Complexity  
A getCreatedAt() 0 4 1
A getUpdatedAt() 0 4 1
A getDeletedAt() 0 4 1
A setDeletedAt() 0 4 1
A getDiscr() 0 4 1
A getDiscrName() 0 4 1
A forcePersist() 0 6 1
A prePersist() 0 6 1
A preUpdate() 0 6 1
A getRepository() 0 4 1
A remove() 0 6 1
A save() 0 6 1
A flush() 0 6 2
A getId() 0 4 1
A getFillable() 0 4 1
getOnlyStore() 0 1 ?
A getOnlyUpdate() 0 4 1
B checkOnyExceptInArray() 16 16 8
C toArray() 7 51 14

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
3
namespace Bludata\Doctrine\ORM\Entities;
4
5
use Bludata\Doctrine\Common\Interfaces\BaseEntityInterface;
6
use Bludata\Doctrine\Common\Interfaces\EntityTimestampInterface;
7
use Bludata\Doctrine\Common\Traits\SetPropertiesEntityTrait;
8
use DateTime;
9
use Doctrine\Common\Collections\ArrayCollection;
10
use Doctrine\ORM\Mapping as ORM;
11
use Doctrine\ORM\PersistentCollection;
12
use EntityManager;
13
use Gedmo\Mapping\Annotation as Gedmo;
14
15
/**
16
 * @ORM\MappedSuperclass
17
 * @ORM\HasLifecycleCallbacks
18
 * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false)
19
 */
20
abstract class BaseEntity implements BaseEntityInterface, EntityTimestampInterface
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 80 characters; contains 82 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
21
{
22
    use SetPropertiesEntityTrait;
23
24
    /**
25
     * @ORM\Id
26
     * @ORM\Column(type="integer", name="id")
27
     * @ORM\GeneratedValue
28
     */
29
    protected $id;
30
31
    /**
32
     * @var \DateTime
33
     *
34
     * @Gedmo\Timestampable(on="create")
35
     * @ORM\Column(type="datetime", name="createdAt")
36
     */
37
    private $createdAt;
38
39
    /**
40
     * @var \DateTime
41
     *
42
     * @Gedmo\Timestampable(on="update")
43
     * @ORM\Column(type="datetime", name="updatedAt")
44
     */
45
    private $updatedAt;
46
47
    /**
48
     * @ORM\Column(type="datetime", nullable=true, name="deletedAt")
49
     */
50
    private $deletedAt;
51
52
    public function getCreatedAt()
53
    {
54
        return $this->createdAt;
55
    }
56
57
    public function getUpdatedAt()
58
    {
59
        return $this->updatedAt;
60
    }
61
62
    public function getDeletedAt()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
63
    {
64
        return $this->deletedAt;
65
    }
66
67
    public function setDeletedAt($deletedAt)
68
    {
69
        $this->deletedAt = $deletedAt;
70
    }
71
72
    public function getDiscr()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
73
    {
74
        return $this->getRepository()->getClassMetadata()->discriminatorValue;
75
    }
76
77
    public function getDiscrName()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
78
    {
79
        return $this->getRepository()->getClassMetadata()->discriminatorColumn['name'];
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 80 characters; contains 87 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
80
    }
81
82
    /**
83
     * Altera o campo updatedAt para forçar o persist da entity.
84
     */
85
    public function forcePersist()
86
    {
87
        $this->updatedAt = new DateTime();
88
89
        return $this;
90
    }
91
92
    /**
93
     * @ORM\PrePersist
94
     */
95
    public function prePersist()
96
    {
97
        $this->getRepository()
98
             ->preSave($this)
99
             ->validate($this);
100
    }
101
102
    /**
103
     * @ORM\PreUpdate
104
     */
105
    public function preUpdate()
106
    {
107
        $this->getRepository()
108
             ->preSave($this)
109
             ->validate($this);
110
    }
111
112
    public function getRepository()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
113
    {
114
        return EntityManager::getRepository(get_class($this));
115
    }
116
117
    public function remove()
118
    {
119
        $this->getRepository()->remove($this);
120
121
        return $this;
122
    }
123
124
    public function save($flush = false)
125
    {
126
        $this->getRepository()->save($this);
127
128
        return $this;
129
    }
130
131
    public function flush($all = true)
132
    {
133
        $this->getRepository()->flush($all ? null : $this);
134
135
        return $this;
136
    }
137
138
    public function getId()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
139
    {
140
        return $this->id;
141
    }
142
143
    protected function getFillable()
144
    {
145
        return ['id', 'createdAt', 'updatedAt', 'deletedAt'];
146
    }
147
148
    /**
149
     * Retona um array com o nome das propriedade que o cliente pode setar para realizar o store
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 80 characters; contains 96 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
150
     * É usado principalmente em $this->setPropertiesEntity e nos Controllers.
151
     * Este método não evita que uma propriedade seja alterada caso tenha seu método set().
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 80 characters; contains 91 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
152
     *
153
     * @return array
154
     */
155
    abstract public function getOnlyStore();
156
157
    /**
158
     * Retona um array com o nome das propriedade que o cliente pode setar para realizar o update.
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 80 characters; contains 98 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
159
     * Por padrão retorna os mesmos valores de $this->getOnlyStore().
160
     * Este método pode ser sobrescrito nas classes filhas.
161
     * É usado principalmente em $this->setPropertiesEntity e nos Controllers.
162
     * Este método não evita que uma propriedade seja alterada caso tenha seu método set().
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 80 characters; contains 91 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
163
     *
164
     * @return array
165
     */
166
    public function getOnlyUpdate()
167
    {
168
        return $this->getOnlyStore();
169
    }
170
171 View Code Duplication
    final protected function checkOnyExceptInArray($key, array $options = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
172
    {
173
        if (
174
            $options
175
            &&
176
            (
177
                (isset($options['only']) && is_array($options['only']) && !in_array($key, $options['only']))
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 80 characters; contains 108 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
178
                ||
179
                (isset($options['except']) && is_array($options['except']) && in_array($key, $options['except']))
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 80 characters; contains 113 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
180
            )
181
        ) {
182
            return false;
183
        }
184
185
        return true;
186
    }
187
188
    public function toArray(array $options = null)
189
    {
190
        $classMetadata = $this->getRepository()->getClassMetadata();
191
        $array = [];
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 9 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
192
193
        foreach ($this->getFillable() as $key) {
194
            $metaDataKey = $classMetadata->hasField($key) ? $classMetadata->getFieldMapping($key) : null;
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 80 characters; contains 105 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
195
196
            if ($this->checkOnyExceptInArray($key, $options)) {
197
                if (is_object($this->$key)) {
198
                    if ($this->$key instanceof DateTime) {
199
                        if ($this->$key) {
200
                            $dateFormat = 'Y-m-d';
201
202
                            if ($metaDataKey) {
203
                                switch ($metaDataKey['type']) {
204
                                    case 'datetime':
205
                                        $dateFormat = 'Y-m-d H:i:s';
206
                                        break;
207
208
                                    case 'time':
209
                                        $dateFormat = 'H:i:s';
210
                                        break;
211
212
                                    default:
213
                                        break;
214
                                }
215
                            }
216
                            $array[$key] = $this->$key->format($dateFormat);
217
                        }
218 View Code Duplication
                    } elseif ($this->$key instanceof ArrayCollection || $this->$key instanceof PersistentCollection) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
Coding Style introduced by
This line exceeds maximum limit of 80 characters; contains 118 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
219
                        $ids = [];
220
                        foreach ($this->$key->getValues() as $item) {
221
                            $ids[] = $item->getId();
222
                        }
223
                        $array[$key] = $ids;
224
                    } else {
225
                        $array[$key] = $this->$key->getId();
226
                    }
227
                } else {
228
                    if ($metaDataKey['type'] == 'decimal') {
229
                        $array[$key] = (float) $this->$key;
230
                    } else {
231
                        $array[$key] = $this->$key;
232
                    }
233
                }
234
            }
235
        }
236
237
        return $array;
238
    }
239
}
240