BaseEntity::flush() - Code Metrics - Inspection of "corrigido erro de syntaxe" - raivieira/base-api-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 32bf59...edf3f2 )

by Jonathan André

created 2016-10-05 16:46 UTC

BaseEntity::flush() A

↳ Parent: BaseEntity

Complexity

Conditions	2
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	1
nop	1
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) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                        $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;
    }
}


Push — master ( 32bf59...edf3f2 )

BaseEntity::flush() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1		<?php
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()
		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...
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()
		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...
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()
		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...
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	View Code Duplication	if (
		0 ignored issues – show Duplication introduced 2016-10-05 16:49 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...
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	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...
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	View Code Duplication	if ($this->$key instanceof \DateTime) {
		0 ignored issues – show Duplication introduced 2016-10-05 16:49 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...
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		}
221		} elseif ($this->$key instanceof \MongoTimestamp) {
222		$array[$key] = $this->$key;
223		} elseif ($this->$key instanceof ArrayCollection \|\| $this->$key instanceof PersistentCollection) {
		0 ignored issues – show Bug introduced 2016-09-30 19:54 UTC by Report Bug Copy Issue Report The class `Doctrine\ODM\MongoDB\PersistentCollection` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. 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...
224		$ids = [];
225		foreach ($this->$key->getValues() as $item) {
226		$ids[] = $item->getId();
227		}
228		$array[$key] = $ids;
229		} else {
230		$array[$key] = $this->$key->getId();
231		}
232		} else {
233		$array[$key] = $this->$key;
234		}
235		}
236		}
237
238		return $array;
239		}
240		}
241

raivieira / base-api-php

Push — master ( 32bf59...edf3f2 )

BaseEntity::flush() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like