BaseRepository::preFlush() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/raivie..." - raivieira/base-api-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d23403...374141 )

by Rai

created 2017-02-02 16:17 UTC

BaseRepository::preFlush() A

↳ Parent: BaseRepository

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	4
Ratio	100 %

Importance

Changes

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

<?php

namespace Bludata\Doctrine\ODM\MongoDB\Repositories;

use Bludata\Doctrine\Common\Interfaces\BaseEntityInterface;
use Bludata\Doctrine\Common\Interfaces\BaseRepositoryInterface;
use Bludata\Doctrine\ORM\Repositories\QueryWorker;
use Doctrine\ODM\MongoDB\DocumentRepository;
use Symfony\Component\Validator\ValidatorBuilder;

abstract class BaseRepository extends DocumentRepository implements BaseRepositoryInterface

{
    /**
     * Método executado nos eventos ORM\PrePersist e ORM\PreUpdate.
     */
    public function preSave(BaseEntityInterface $entity)
    {
        return $this;
    }

    /**
     * Método executado nos eventos ORM\PostPersist e ORM\PostUpdate.
     */
    public function postSave(BaseEntityInterface $entity)
    {
        return $this;
    }

    /**
     * Método executado no evento ORM\PreFlush.
     */
    public function preFlush(BaseEntityInterface $entity)
    {
        return $this;
    }

    abstract public function getMessageNotFound();


    public function validate(BaseEntityInterface $entity)
    {
        $validator = (new ValidatorBuilder())
                    ->enableAnnotationMapping()
                    ->getValidator();

        $violations = $validator->validate($entity);

        $errors = [];

        if (count($violations)) {
            foreach ($violations as $violation) {
                $errors[] = $violation->getMessage();
            }

            abort(400, json_encode($errors));
        }

        return true;
    }

    public function getClassMetadata()

    {
        return parent::getClassMetadata();
    }

    public function getEntityName()

    {
        return parent::getDocumentName();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    public function createEntity()
    {
        return app($this->getEntityName());
    }

    public function createQueryWorker()
    {
        return new QueryWorker($this);
    }

    public function query()

    {
        return $this->createQueryBuilder('t');
    }

    /**
     * @return QueryWorker
     */
    public function findAll()
    {
        return $this->createQueryWorker();
    }

    public function findOneBy(array $filters, $abort = true)

    {
        $entity = parent::findOneBy($filters);

        if (!$entity && $abort) {
            abort(404, $this->getMessageNotFound());
        }

        return $entity;
    }

    public function find($id, $abort = true)

    {
        return is_object($id) ? $id : $this->findOneBy(['id' => $id], $abort);
    }

    /**
     * Inserir ou atualizar um registro.
     *
     * @param null | string | int | array
     *
     * @throws InvalidArgumentException Se $input não for null | string | int | array é lançada a exceção

     */
    public function findOrCreate($input)
    {
        if (is_null($input)) {
            return $input;
        }

        if (is_string($input)) {
            if ($decoded = json_decode($input, true)) {
                $input = $decoded;

            }
        }

        if (is_array($input)) {
            if (array_key_exists('id', $input) && $input['id']) {
                $object = $this->find($input['id']);
            } else {
                $object = $this->createEntity();
            }

            $object->setPropertiesEntity($input);

            return $object;
        }

        return $this->find($input);
    }

    /**
     * Marcar um registro como deletado.
     *
     * @param object | int $target
     *
     * @throws Symfony\Component\HttpKernel\Exception\NotFoundHttpException Se $target não for encontrado

     *
     * @return Bludata\Entities\BaseEntityInterface
     */
    public function remove($target)
    {
        $entity = $this->find($target);

        $this->em()->remove($entity);

        return $entity;
    }

    /**
     * @param Bludata\Entities\BaseEntityInterface $entity

     *
     * @return Bludata\Repositories\QueryWorker
     */
    public function save(BaseEntityInterface $entity)
    {
        $this->em()->persist($entity);

        return $this;
    }

    /**
     * @param Bludata\Entities\BaseEntityInterface $entity

     *
     * @return Bludata\Repositories\QueryWorker
     */
    public function flush(BaseEntityInterface $entity = null)
    {
        $this->em()->flush($entity);

        return $this;
    }

    public function em()

    {
        return parent::getDocumentManager();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }
}


1		<?php
2
3		namespace Bludata\Doctrine\ODM\MongoDB\Repositories;
4
5		use Bludata\Doctrine\Common\Interfaces\BaseEntityInterface;
6		use Bludata\Doctrine\Common\Interfaces\BaseRepositoryInterface;
7		use Bludata\Doctrine\ORM\Repositories\QueryWorker;
8		use Doctrine\ODM\MongoDB\DocumentRepository;
9		use Symfony\Component\Validator\ValidatorBuilder;
10
11	View Code Duplication	abstract class BaseRepository extends DocumentRepository implements BaseRepositoryInterface
		0 ignored issues – show Duplication introduced 2016-09-06 13:00 UTC by Report Bug Copy Issue Report This class 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... 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...
12		{
13		/**
14		* Método executado nos eventos ORM\PrePersist e ORM\PreUpdate.
15		*/
16		public function preSave(BaseEntityInterface $entity)
17		{
18		return $this;
19		}
20
21		/**
22		* Método executado nos eventos ORM\PostPersist e ORM\PostUpdate.
23		*/
24		public function postSave(BaseEntityInterface $entity)
25		{
26		return $this;
27		}
28
29		/**
30		* Método executado no evento ORM\PreFlush.
31		*/
32		public function preFlush(BaseEntityInterface $entity)
33		{
34		return $this;
35		}
36
37		abstract public function getMessageNotFound();
		0 ignored issues – show Documentation introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
38
39		public function validate(BaseEntityInterface $entity)
40		{
41		$validator = (new ValidatorBuilder())
42		->enableAnnotationMapping()
43		->getValidator();
44
45		$violations = $validator->validate($entity);
46
47		$errors = [];
48
49		if (count($violations)) {
50		foreach ($violations as $violation) {
51		$errors[] = $violation->getMessage();
52		}
53
54		abort(400, json_encode($errors));
55		}
56
57		return true;
58		}
59
60		public function getClassMetadata()
		0 ignored issues – show Documentation introduced 2016-09-13 13:25 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...
61		{
62		return parent::getClassMetadata();
63		}
64
65		public function getEntityName()
		0 ignored issues – show Documentation introduced 2016-09-13 13:25 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...
66		{
67		return parent::getDocumentName();
		0 ignored issues – show Comprehensibility Bug introduced 2016-09-06 13:00 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`getDocumentName()` instead of `getEntityName()`). Are you sure this is correct? If so, you might want to change this to `$this->getDocumentName()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
68		}
69
70		public function createEntity()
71		{
72		return app($this->getEntityName());
73		}
74
75		public function createQueryWorker()
76		{
77		return new QueryWorker($this);
78		}
79
80		public function query()
		0 ignored issues – show Documentation introduced 2016-09-13 13:25 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...
81		{
82		return $this->createQueryBuilder('t');
83		}
84
85		/**
86		* @return QueryWorker
87		*/
88		public function findAll()
89		{
90		return $this->createQueryWorker();
91		}
92
93		public function findOneBy(array $filters, $abort = true)
		0 ignored issues – show Documentation introduced 2016-09-13 13:25 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...
94		{
95		$entity = parent::findOneBy($filters);
96
97		if (!$entity && $abort) {
98		abort(404, $this->getMessageNotFound());
99		}
100
101		return $entity;
102		}
103
104		public function find($id, $abort = true)
		0 ignored issues – show Documentation introduced 2016-09-13 13:25 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...
105		{
106		return is_object($id) ? $id : $this->findOneBy(['id' => $id], $abort);
107		}
108
109		/**
110		* Inserir ou atualizar um registro.
111		*
112		* @param null \| string \| int \| array
113		*
114		* @throws InvalidArgumentException Se $input não for null \| string \| int \| array é lançada a exceção
		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...
115		*/
116		public function findOrCreate($input)
117		{
118		if (is_null($input)) {
119		return $input;
120		}
121
122		if (is_string($input)) {
123		if ($decoded = json_decode($input, true)) {
124		$input = $decoded;
		0 ignored issues – show Coding Style introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$input`. This often makes code more readable. Loading history...
125		}
126		}
127
128		if (is_array($input)) {
129		if (array_key_exists('id', $input) && $input['id']) {
130		$object = $this->find($input['id']);
131		} else {
132		$object = $this->createEntity();
133		}
134
135		$object->setPropertiesEntity($input);
136
137		return $object;
138		}
139
140		return $this->find($input);
141		}
142
143		/**
144		* Marcar um registro como deletado.
145		*
146		* @param object \| int $target
147		*
148		* @throws Symfony\Component\HttpKernel\Exception\NotFoundHttpException Se $target não for encontrado
		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...
149		*
150		* @return Bludata\Entities\BaseEntityInterface
151		*/
152		public function remove($target)
153		{
154		$entity = $this->find($target);
155
156		$this->em()->remove($entity);
157
158		return $entity;
159		}
160
161		/**
162		* @param Bludata\Entities\BaseEntityInterface $entity
		0 ignored issues – show Documentation introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report Should the type for parameter `$entity` not be `BaseEntityInterface`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
163		*
164		* @return Bludata\Repositories\QueryWorker
165		*/
166		public function save(BaseEntityInterface $entity)
167		{
168		$this->em()->persist($entity);
169
170		return $this;
171		}
172
173		/**
174		* @param Bludata\Entities\BaseEntityInterface $entity
		0 ignored issues – show Documentation introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report Should the type for parameter `$entity` not be `null\|BaseEntityInterface`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
175		*
176		* @return Bludata\Repositories\QueryWorker
177		*/
178		public function flush(BaseEntityInterface $entity = null)
179		{
180		$this->em()->flush($entity);
181
182		return $this;
183		}
184
185		public function em()
		0 ignored issues – show Documentation introduced 2016-09-13 13:25 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... Coding Style introduced 2016-09-06 13:58 UTC by Report Bug Copy Issue Report This method's name is shorter than the configured minimum length of `3` characters. Even though PHP does not care about the name of your methods, it is generally a good practice to choose method names which can be easily understood by other human readers. Loading history...
186		{
187		return parent::getDocumentManager();
		0 ignored issues – show Comprehensibility Bug introduced 2016-09-06 13:00 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`getDocumentManager()` instead of `em()`). Are you sure this is correct? If so, you might want to change this to `$this->getDocumentManager()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
188		}
189		}
190

raivieira / base-api-php

Push — master ( d23403...374141 )

BaseRepository::preFlush() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like