BaseEntity::getOnlyUpdate() - Code Metrics - Inspection of "suporte aos eventos postPersist e postUpdate" - raivieira/base-api-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 14edcf...67a112 )

by Rai

created 2017-02-01 18:23 UTC

BaseEntity::getOnlyUpdate() A

↳ Parent: BaseEntity

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Bludata\Doctrine\ORM\Entities;

use Bludata\Doctrine\Common\Interfaces\BaseEntityInterface;
use Bludata\Doctrine\Common\Interfaces\EntityTimestampInterface;
use Bludata\Doctrine\Common\Traits\SetPropertiesEntityTrait;
use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Doctrine\ORM\PersistentCollection;
use EntityManager;
use Gedmo\Mapping\Annotation as Gedmo;

/**
 * @ORM\MappedSuperclass
 * @ORM\HasLifecycleCallbacks
 * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false)
 */
abstract class BaseEntity implements BaseEntityInterface, EntityTimestampInterface

{
    use SetPropertiesEntityTrait;

    /**
     * @ORM\Id
     * @ORM\Column(type="integer", name="id")
     * @ORM\GeneratedValue
     */
    protected $id;

    /**
     * @var \DateTime
     *
     * @Gedmo\Timestampable(on="create")
     * @ORM\Column(type="datetime", name="createdAt")
     */
    private $createdAt;

    /**
     * @var \DateTime
     *
     * @Gedmo\Timestampable(on="update")
     * @ORM\Column(type="datetime", name="updatedAt")
     */
    private $updatedAt;

    /**
     * @ORM\Column(type="datetime", nullable=true, name="deletedAt")
     */
    private $deletedAt;

    public function getCreatedAt()
    {
        return $this->createdAt;
    }

    public function getUpdatedAt()
    {
        return $this->updatedAt;
    }

    public function getDeletedAt()

    {
        return $this->deletedAt;
    }

    public function setDeletedAt($deletedAt)
    {
        $this->deletedAt = $deletedAt;
    }

    public function getDiscr()

    {
        return $this->getRepository()->getClassMetadata()->discriminatorValue;
    }

    public function getDiscrName()

    {
        return $this->getRepository()->getClassMetadata()->discriminatorColumn['name'];

    }

    /**
     * Altera o campo updatedAt para forçar o persist da entity.
     */
    public function forcePersist()
    {
        $this->updatedAt = new DateTime();

        return $this;
    }

    /**
     * @ORM\PrePersist
     */
    public function prePersist()
    {
        $this->getRepository()
             ->preSave($this)
             ->validate($this);
    }

    /**
     * @ORM\PostPersist
     */
    public function postPersist()
    {
        $this->getRepository()
             ->postSave($this);
    }

    /**
     * @ORM\PreUpdate
     */
    public function preUpdate()
    {
        $this->getRepository()
             ->preSave($this)
             ->validate($this);
    }

    /**
     * @ORM\PostUpdate
     */
    public function postUpdate()
    {
        $this->getRepository()
             ->postSave($this);
    }

    public function getRepository()

    {
        return EntityManager::getRepository(get_class($this));
    }

    public function remove()
    {
        $this->getRepository()->remove($this);

        return $this;
    }

    public function save($flush = false)
    {
        $this->getRepository()->save($this);

        return $this;
    }

    public function flush($all = true)
    {
        $this->getRepository()->flush($all ? null : $this);

        return $this;
    }

    public function getId()

    {
        return $this->id;
    }

    protected function getFillable()
    {
        return ['id', 'createdAt', 'updatedAt', 'deletedAt'];
    }

    /**
     * Retona um array com o nome das propriedade que o cliente pode setar para realizar o store

     * É usado principalmente em $this->setPropertiesEntity e nos Controllers.
     * Este método não evita que uma propriedade seja alterada caso tenha seu método set().

     *
     * @return array
     */
    abstract public function getOnlyStore();

    /**
     * Retona um array com o nome das propriedade que o cliente pode setar para realizar o update.

     * Por padrão retorna os mesmos valores de $this->getOnlyStore().
     * Este método pode ser sobrescrito nas classes filhas.
     * É usado principalmente em $this->setPropertiesEntity e nos Controllers.
     * Este método não evita que uma propriedade seja alterada caso tenha seu método set().

     *
     * @return array
     */
    public function getOnlyUpdate()
    {
        return $this->getOnlyStore();
    }

    final protected function checkOnyExceptInArray($key, array $options = null)

    {
        if (
            $options
            &&
            (
                (isset($options['only']) && is_array($options['only']) && !in_array($key, $options['only']))

                ||
                (isset($options['except']) && is_array($options['except']) && in_array($key, $options['except']))

            )
        ) {
            return false;
        }

        return true;
    }

    public function toArray(array $options = null)
    {
        $classMetadata = $this->getRepository()->getClassMetadata();
        $array = [];
$a = "a";
$ab = "ab";
$abc = "abc";

        foreach ($this->getFillable() as $key) {
            $metaDataKey = $classMetadata->hasField($key) ? $classMetadata->getFieldMapping($key) : null;


            if ($this->checkOnyExceptInArray($key, $options)) {
                if (is_object($this->$key)) {
                    if ($this->$key instanceof DateTime) {
                        if ($this->$key) {
                            $dateFormat = 'Y-m-d';

                            if ($metaDataKey) {
                                switch ($metaDataKey['type']) {
                                    case 'datetime':
                                        $dateFormat = 'Y-m-d H:i:s';
                                        break;

                                    case 'time':
                                        $dateFormat = 'H:i:s';
                                        break;

                                    default:
                                        break;
                                }
                            }
                            $array[$key] = $this->$key->format($dateFormat);
                        }
                    } elseif ($this->$key instanceof ArrayCollection || $this->$key instanceof PersistentCollection) {

                        $ids = [];
                        foreach ($this->$key->getValues() as $item) {
                            $ids[] = $item->getId();
                        }
                        $array[$key] = $ids;
                    } else {
                        $array[$key] = $this->$key->getId();
                    }
                } else {
                    if ($metaDataKey['type'] == 'decimal') {
                        $array[$key] = (float) $this->$key;
                    } else {
                        $array[$key] = $this->$key;
                    }
                }
            }
        }

        return $array;
    }
}


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 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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 2016-11-30 17:59 UTC by Report Bug Copy Issue Report 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 2016-11-30 17:59 UTC by Report Bug Copy Issue Report 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 2016-11-30 17:59 UTC by Report Bug Copy Issue Report 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\PostPersist
104		*/
105		public function postPersist()
106		{
107		$this->getRepository()
108		->postSave($this);
109		}
110
111		/**
112		* @ORM\PreUpdate
113		*/
114		public function preUpdate()
115		{
116		$this->getRepository()
117		->preSave($this)
118		->validate($this);
119		}
120
121		/**
122		* @ORM\PostUpdate
123		*/
124		public function postUpdate()
125		{
126		$this->getRepository()
127		->postSave($this);
128		}
129
130		public function getRepository()
		0 ignored issues – show Documentation introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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...
131		{
132		return EntityManager::getRepository(get_class($this));
133		}
134
135		public function remove()
136		{
137		$this->getRepository()->remove($this);
138
139		return $this;
140		}
141
142		public function save($flush = false)
143		{
144		$this->getRepository()->save($this);
145
146		return $this;
147		}
148
149		public function flush($all = true)
150		{
151		$this->getRepository()->flush($all ? null : $this);
152
153		return $this;
154		}
155
156		public function getId()
		0 ignored issues – show Documentation introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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...
157		{
158		return $this->id;
159		}
160
161		protected function getFillable()
162		{
163		return ['id', 'createdAt', 'updatedAt', 'deletedAt'];
164		}
165
166		/**
167		* Retona um array com o nome das propriedade que o cliente pode setar para realizar o store
		0 ignored issues – show Coding Style introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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...
168		* É usado principalmente em $this->setPropertiesEntity e nos Controllers.
169		* Este método não evita que uma propriedade seja alterada caso tenha seu método set().
		0 ignored issues – show Coding Style introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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...
170		*
171		* @return array
172		*/
173		abstract public function getOnlyStore();
174
175		/**
176		* Retona um array com o nome das propriedade que o cliente pode setar para realizar o update.
		0 ignored issues – show Coding Style introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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...
177		* Por padrão retorna os mesmos valores de $this->getOnlyStore().
178		* Este método pode ser sobrescrito nas classes filhas.
179		* É usado principalmente em $this->setPropertiesEntity e nos Controllers.
180		* Este método não evita que uma propriedade seja alterada caso tenha seu método set().
		0 ignored issues – show Coding Style introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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...
181		*
182		* @return array
183		*/
184		public function getOnlyUpdate()
185		{
186		return $this->getOnlyStore();
187		}
188
189	View Code Duplication	final protected function checkOnyExceptInArray($key, array $options = null)
		0 ignored issues – show Duplication introduced 2016-10-05 16:49 UTC by Report Bug Copy Issue Report 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...
190		{
191		if (
192		$options
193		&&
194		(
195		(isset($options['only']) && is_array($options['only']) && !in_array($key, $options['only']))
		0 ignored issues – show Coding Style introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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...
196		\|\|
197		(isset($options['except']) && is_array($options['except']) && in_array($key, $options['except']))
		0 ignored issues – show Coding Style introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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...
198		)
199		) {
200		return false;
201		}
202
203		return true;
204		}
205
206		public function toArray(array $options = null)
207		{
208		$classMetadata = $this->getRepository()->getClassMetadata();
209		$array = [];
		0 ignored issues – show Coding Style introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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...
210
211		foreach ($this->getFillable() as $key) {
212		$metaDataKey = $classMetadata->hasField($key) ? $classMetadata->getFieldMapping($key) : null;
		0 ignored issues – show Coding Style introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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...
213
214		if ($this->checkOnyExceptInArray($key, $options)) {
215		if (is_object($this->$key)) {
216		if ($this->$key instanceof DateTime) {
217		if ($this->$key) {
218		$dateFormat = 'Y-m-d';
219
220		if ($metaDataKey) {
221		switch ($metaDataKey['type']) {
222		case 'datetime':
223		$dateFormat = 'Y-m-d H:i:s';
224		break;
225
226		case 'time':
227		$dateFormat = 'H:i:s';
228		break;
229
230		default:
231		break;
232		}
233		}
234		$array[$key] = $this->$key->format($dateFormat);
235		}
236	View Code Duplication	} elseif ($this->$key instanceof ArrayCollection \|\| $this->$key instanceof PersistentCollection) {
		0 ignored issues – show Duplication introduced 2016-12-14 12:26 UTC by Report Bug Copy Issue Report 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 2016-09-06 13:58 UTC by Report Bug Copy Issue Report 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...
237		$ids = [];
238		foreach ($this->$key->getValues() as $item) {
239		$ids[] = $item->getId();
240		}
241		$array[$key] = $ids;
242		} else {
243		$array[$key] = $this->$key->getId();
244		}
245		} else {
246		if ($metaDataKey['type'] == 'decimal') {
247		$array[$key] = (float) $this->$key;
248		} else {
249		$array[$key] = $this->$key;
250		}
251		}
252		}
253		}
254
255		return $array;
256		}
257		}
258

raivieira / base-api-php

Push — master ( 14edcf...67a112 )

BaseEntity::getOnlyUpdate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like