BaseEntity::prePersist() - Code Metrics - Inspection of "corrigido tratamento do toArray() para campos tipo..." - raivieira/base-api-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 535c5b...32bf59 )

by Jonathan André

created 2016-10-05 16:40 UTC

BaseEntity::prePersist() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	0
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php


namespace Bludata\Doctrine\ODM\MongoDB\Entities;

use Bludata\Doctrine\Common\Interfaces\BaseEntityInterface;
use Bludata\Doctrine\Common\Interfaces\EntityManagerInterface;
use Bludata\Doctrine\Common\Interfaces\EntityTimestampInterface;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
use Doctrine\ODM\MongoDB\PersistentCollection;

/**
 * @ODM\MappedSuperclass
 * @ODM\HasLifecycleCallbacks
 */
abstract class BaseEntity implements BaseEntityInterface, EntityTimestampInterface

{
    /**
     * @ODM\Id
     */
    protected $id;

    /**
     * @var \DateTime
     *
     * @ODM\Field(type="timestamp", name="createdAt")
     */
    protected $createdAt;

    /**
     * @var \DateTime
     *
     * @ODM\Field(type="timestamp", name="updatedAt")
     */
    protected $updatedAt;

    /**
     * @ODM\Field(type="timestamp", nullable=true, name="deletedAt")
     */
    protected $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;
    }

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

        return $this;
    }

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

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

    public function getRepository()
    {
        return app(EntityManagerInterface::class)->getRepository(get_class($this));

    }

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

        return $this;
    }

    public function remove()
    {
        $this->getRepository()->remove($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();
    }

    public function setPropertiesEntity(array $data)
    {
        foreach ($data as $key => $value) {
            $set = true;

            if (
                ((!isset($data['id']) || !is_numeric($data['id'])) && !in_array($key, $this->getOnlyStore()))

                ||
                (isset($data['id']) && is_numeric($data['id']) && !in_array($key, $this->getOnlyUpdate()))

            ) {
                $set = false;
            }

            $method = 'set'.ucfirst($key);

            if (method_exists($this, $method) && $set) {
                $this->$method($value);
            }
        }

        return $this;
    }

    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) {
            if ($this->checkOnyExceptInArray($key, $options)) {
                if (is_object($this->$key)) {
                    if ($this->$key instanceof \DateTime) {
                        $metaDataKey = $classMetadata->hasField($key) ? $classMetadata->getFieldMapping($key) : null;


                        if ($this->$key) {
                            $dateFormat = 'Y-m-d H:i:s';

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

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

                                    default:
                                        break;
                                }
                            }
                            $array[$key] = $this->$key->format($dateFormat);
                    } elseif ($this->$key instanceof \MongoTimestamp) {
                        $array[$key] = $this->$key;
                    } 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 {
                    $array[$key] = $this->$key;
                }
            }
        }

        return $array;
    }
}



1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-10-05 16:43 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 42 and the first side effect is on line 16. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3			namespace Bludata\Doctrine\ODM\MongoDB\Entities;
4
5			use Bludata\Doctrine\Common\Interfaces\BaseEntityInterface;
6			use Bludata\Doctrine\Common\Interfaces\EntityManagerInterface;
7			use Bludata\Doctrine\Common\Interfaces\EntityTimestampInterface;
8			use Doctrine\Common\Collections\ArrayCollection;
9			use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
10			use Doctrine\ODM\MongoDB\PersistentCollection;
11
12			/**
13			* @ODM\MappedSuperclass
14			* @ODM\HasLifecycleCallbacks
15			*/
16			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...
17			{
18			/**
19			* @ODM\Id
20			*/
21			protected $id;
22
23			/**
24			* @var \DateTime
25			*
26			* @ODM\Field(type="timestamp", name="createdAt")
27			*/
28			protected $createdAt;
29
30			/**
31			* @var \DateTime
32			*
33			* @ODM\Field(type="timestamp", name="updatedAt")
34			*/
35			protected $updatedAt;
36
37			/**
38			* @ODM\Field(type="timestamp", nullable=true, name="deletedAt")
39			*/
40			protected $deletedAt;
41
42			public function getCreatedAt()
43			{
44			return $this->createdAt;
45			}
46
47			public function getUpdatedAt()
48			{
49			return $this->updatedAt;
50			}
51
52			public function getDeletedAt()
53			{
54			return $this->deletedAt;
55			}
56
57			public function setDeletedAt($deletedAt)
58			{
59			$this->deletedAt = $deletedAt;
60			}
61
62			/**
63			* Altera o campo updatedAt para forçar o persist da entity.
64			*/
65			public function forcePersist()
66			{
67			$this->updatedAt = new \DateTime();
68
69			return $this;
70			}
71
72			/**
73			* @ODM\PrePersist
74			*/
75			public function prePersist()
76			{
77			$this->getRepository()
78			->preSave($this)
79			->validate($this);
80			}
81
82			/**
83			* @ODM\PreUpdate
84			*/
85			public function preUpdate()
86			{
87			$this->getRepository()
88			->preSave($this)
89			->validate($this);
90			}
91
92			public function getRepository()
93			{
94			return app(EntityManagerInterface::class)->getRepository(get_class($this));
			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 83 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...
95			}
96
97			public function save($flush = false)
98			{
99			$this->getRepository()->save($this);
100
101			return $this;
102			}
103
104			public function remove()
105			{
106			$this->getRepository()->remove($this);
107
108			return $this;
109			}
110
111			public function flush($all = true)
112			{
113			$this->getRepository()->flush($all ? null : $this);
114
115			return $this;
116			}
117
118			public function getId()
119			{
120			return $this->id;
121			}
122
123			protected function getFillable()
124			{
125			return ['id', 'createdAt', 'updatedAt', 'deletedAt'];
126			}
127
128			/**
129			* 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...
130			* É usado principalmente em $this->setPropertiesEntity e nos Controllers.
131			* 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...
132			*
133			* @return array
134			*/
135			abstract public function getOnlyStore();
136
137			/**
138			* 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...
139			* Por padrão retorna os mesmos valores de $this->getOnlyStore().
140			* Este método pode ser sobrescrito nas classes filhas.
141			* É usado principalmente em $this->setPropertiesEntity e nos Controllers.
142			* 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...
143			*
144			* @return array
145			*/
146			public function getOnlyUpdate()
147			{
148			return $this->getOnlyStore();
149			}
150
151			public function setPropertiesEntity(array $data)
152			{
153			foreach ($data as $key => $value) {
154			$set = true;
155
156			if (
157			((!isset($data['id']) \|\| !is_numeric($data['id'])) && !in_array($key, $this->getOnlyStore()))
			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 109 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...
158			\|\|
159			(isset($data['id']) && is_numeric($data['id']) && !in_array($key, $this->getOnlyUpdate()))
			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 106 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...
160			) {
161			$set = false;
162			}
163
164			$method = 'set'.ucfirst($key);
165
166			if (method_exists($this, $method) && $set) {
167			$this->$method($value);
168			}
169			}
170
171			return $this;
172			}
173
174			final protected function checkOnyExceptInArray($key, array $options = null)
175			{
176			if (
177			$options
178			&&
179			(
180			(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...
181			\|\|
182			(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...
183			)
184			) {
185			return false;
186			}
187
188			return true;
189			}
190
191			public function toArray(array $options = null)
192			{
193			$classMetadata = $this->getRepository()->getClassMetadata();
194			$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...
195
196			foreach ($this->getFillable() as $key) {
197			if ($this->checkOnyExceptInArray($key, $options)) {
198			if (is_object($this->$key)) {
199			if ($this->$key instanceof \DateTime) {
200			$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 117 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...
201
202			if ($this->$key) {
203			$dateFormat = 'Y-m-d H:i:s';
204
205			if ($metaDataKey) {
206			switch ($metaDataKey['type']) {
207			case 'date':
208			$dateFormat = 'Y-m-d';
209			break;
210
211			case 'time':
212			$dateFormat = 'H:i:s';
213			break;
214
215			default:
216			break;
217			}
218			}
219			$array[$key] = $this->$key->format($dateFormat);
220			} elseif ($this->$key instanceof \MongoTimestamp) {
221			$array[$key] = $this->$key;
222			} elseif ($this->$key instanceof ArrayCollection \|\| $this->$key instanceof PersistentCollection) {
			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 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...
223			$ids = [];
224			foreach ($this->$key->getValues() as $item) {
225			$ids[] = $item->getId();
226			}
227			$array[$key] = $ids;
228			} else {
229			$array[$key] = $this->$key->getId();
230			}
231			} else {
232			$array[$key] = $this->$key;
233			}
234			}
235			}
236
237			return $array;
238			}
239			}
240
			0 ignored issues – show Bug introduced 2016-10-05 16:43 UTC by Report Bug Copy Issue Report This code did not parse for me. Apparently, there is an error somewhere around this line: Syntax error, unexpected EOF, expecting T_FUNCTION Loading history...

raivieira / base-api-php

Push — master ( 535c5b...32bf59 )

BaseEntity::prePersist() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like