DocumentModel::findAll() - Code Metrics - Inspection of "add additional field to the file service" - libgraviton/graviton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#352)

by Samuel

created 2016-01-18 08:10 UTC

DocumentModel::findAll() B

↳ Parent: DocumentModel

Complexity

Conditions	6
Paths	32

Size

Total Lines	62
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	24
CRAP Score	7.7999

Metric	Value
dl	0
loc	62
ccs	24
cts	38
cp	0.6316
rs	8.6652
cc	6
eloc	35
nc	32
nop	1
crap	7.7999

How to fix Long Method

<?php
/**
 * Use doctrine odm as backend
 */

namespace Graviton\RestBundle\Model;

use Doctrine\ODM\MongoDB\DocumentRepository;
use Graviton\SchemaBundle\Model\SchemaModel;
use Symfony\Component\HttpFoundation\Request;
use Doctrine\ODM\MongoDB\Query\Builder;
use Graviton\Rql\Visitor\MongoOdm as Visitor;
use Xiag\Rql\Parser\Query;
use Graviton\ExceptionBundle\Exception\RecordOriginModifiedException;

/**
 * Use doctrine odm as backend
 *
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
class DocumentModel extends SchemaModel implements ModelInterface
{
    /**
     * @var string
     */
    protected $description;
    /**
     * @var string[]
     */
    protected $fieldTitles;
    /**
     * @var string[]
     */
    protected $fieldDescriptions;
    /**
     * @var string[]
     */
    protected $requiredFields = array();
    /**
     * @var DocumentRepository
     */
    private $repository;
    /**
     * @var Visitor
     */
    private $visitor;
    /**
     * @var array
     */
    protected $notModifiableOriginRecords;
    /**
     * @var  integer
     */
    private $paginationDefaultLimit;

    /**
     * @param Visitor $visitor                    rql query visitor
     * @param array   $notModifiableOriginRecords strings with not modifiable recordOrigin values
     * @param integer $paginationDefaultLimit     amount of data records to be returned when in pagination context.
     */
    public function __construct(Visitor $visitor, $notModifiableOriginRecords, $paginationDefaultLimit)
    {
        parent::__construct();
        $this->visitor = $visitor;
        $this->notModifiableOriginRecords = $notModifiableOriginRecords;
        $this->paginationDefaultLimit = (int) $paginationDefaultLimit;
    }

    /**
     * get repository instance
     *
     * @return DocumentRepository
     */
    public function getRepository()
    {
        return $this->repository;
    }

    /**
     * create new app model
     *
     * @param DocumentRepository $repository Repository of countries
     *
     * @return \Graviton\RestBundle\Model\DocumentModel
     */
    public function setRepository(DocumentRepository $repository)
    {
        $this->repository = $repository;

        return $this;
    }

    /**
     * {@inheritDoc}
     *
     * @param \Symfony\Component\HttpFoundation\Request $request Request object
     *
     * @return array
     */
    public function findAll(Request $request)
    {
        $pageNumber = $request->query->get('page', 1);
        $numberPerPage = (int) $request->query->get('perPage', $this->getDefaultLimit());
        $startAt = ($pageNumber - 1) * $numberPerPage;

        /** @var \Doctrine\ODM\MongoDB\Query\Builder $queryBuilder */
        $queryBuilder = $this->repository
            ->createQueryBuilder();

        // *** do we have an RQL expression, do we need to filter data?
        if ($request->attributes->get('hasRql', false)) {
            $queryBuilder = $this->doRqlQuery(
                $queryBuilder,
                $request->attributes->get('rqlQuery')
            );
        } else {
            // @todo [lapistano]: seems the offset is missing for this query.
            /** @var \Doctrine\ODM\MongoDB\Query\Builder $qb */
            $queryBuilder->find($this->repository->getDocumentName());
        }

        // define offset and limit
        if (!array_key_exists('skip', $queryBuilder->getQuery()->getQuery())) {
            $queryBuilder->skip($startAt);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        } else {
            $startAt = (int) $queryBuilder->getQuery()->getQuery()['skip'];
        }

        if (!array_key_exists('limit', $queryBuilder->getQuery()->getQuery())) {
            $queryBuilder->limit($numberPerPage);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        } else {
            $numberPerPage = (int) $queryBuilder->getQuery()->getQuery()['limit'];
        }

        /**
         * add a default sort on id if none was specified earlier
         *
         * not specifying something to sort on leads to very weird cases when fetching references
         */
        if (!array_key_exists('sort', $queryBuilder->getQuery()->getQuery())) {
            $queryBuilder->sort('_id');
        }

        // run query
        $query = $queryBuilder->getQuery();
        $records = array_values($query->execute()->toArray());

        $totalCount = $query->count();
        $numPages = (int) ceil($totalCount / $numberPerPage);
        $page = (int) ceil($startAt / $numberPerPage) + 1;
        if ($numPages > 1) {
            $request->attributes->set('paging', true);
            $request->attributes->set('page', $page);
            $request->attributes->set('numPages', $numPages);
            $request->attributes->set('startAt', $startAt);
            $request->attributes->set('perPage', $numberPerPage);
            $request->attributes->set('totalCount', $totalCount);
        }

        return $records;
    }

    /**
     * @param \Graviton\I18nBundle\Document\Translatable $entity entity to insert
     *
     * @return Object
     */
    public function insertRecord($entity)

    {
        $this->checkIfOriginRecord($entity);
        $manager = $this->repository->getDocumentManager();
        $manager->persist($entity);
        $manager->flush($entity);

        return $this->find($entity->getId());
    }

    /**
     * @param string $documentId id of entity to find
     *
     * @return Object
     */
    public function find($documentId)
    {
        return $this->repository->find($documentId);
    }

    /**
     * {@inheritDoc}
     *
     * @param string $documentId id of entity to update
     * @param Object $entity     new entity
     *
     * @return Object
     */
    public function updateRecord($documentId, $entity)

    {
        $manager = $this->repository->getDocumentManager();
        // In both cases the document attribute named originRecord must not be 'core'
        $this->checkIfOriginRecord($entity);
        $this->checkIfOriginRecord($this->find($documentId));
        $entity = $manager->merge($entity);
        $manager->flush();

        return $entity;
    }

    /**
     * {@inheritDoc}
     *
     * @param string $documentId id of entity to delete
     *
     * @return null|Object
     */
    public function deleteRecord($documentId)
    {
        $manager = $this->repository->getDocumentManager();
        $entity = $this->find($documentId);

        $return = $entity;
        if ($entity) {
            $this->checkIfOriginRecord($entity);
            $manager->remove($entity);
            $manager->flush();
            $return = null;
        }

        return $return;
    }

    /**
     * get classname of entity
     *
     * @return string
     */
    public function getEntityClass()
    {
        return $this->repository->getDocumentName();
    }

    /**
     * {@inheritDoc}
     *
     * Currently this is being used to build the route id used for redirecting
     * to newly made documents. It might benefit from having a different name
     * for those purposes.
     *
     * We might use a convention based mapping here:
     * Graviton\CoreBundle\Document\App -> mongodb://graviton_core
     * Graviton\CoreBundle\Entity\Table -> mysql://graviton_core
     *
     * @todo implement this in a more convention based manner
     *
     * @return string
     */
    public function getConnectionName()
    {
        $bundle = strtolower(substr(explode('\\', get_class($this))[1], 0, -6));

        return 'graviton.' . $bundle;
    }

    /**
     * Does the actual query using the RQL Bundle.
     *
     * @param Builder $queryBuilder Doctrine ODM QueryBuilder
     * @param Query   $query        query from parser
     *
     * @return array
     */
    protected function doRqlQuery($queryBuilder, Query $query)
    {
        $this->visitor->setBuilder($queryBuilder);

        return $this->visitor->visit($query);
    }

    /**
     * Checks the recordOrigin attribute of a record and will throw an exception if value is not allowed
     *
     * @param Object $record record
     *
     * @return void
     */
    protected function checkIfOriginRecord($record)
    {
        if ($record instanceof RecordOriginInterface
            && !$record->isRecordOriginModifiable()
        ) {
            $values = $this->notModifiableOriginRecords;
            $originValue = strtolower(trim($record->getRecordOrigin()));

            if (in_array($originValue, $values)) {
                $msg = sprintf("Must not be one of the following keywords: %s", implode(', ', $values));

                throw new RecordOriginModifiedException($msg);
            }
        }
    }

    /**
     * Determines the configured amount fo data records to be returned in pagination context.
     *
     * @return int
     */
    private function getDefaultLimit()
    {
        if (0 < $this->paginationDefaultLimit) {
            return $this->paginationDefaultLimit;
        }

        return 10;
    }
}


Pull Request — develop (#352)

DocumentModel::findAll() B

Complexity

Size

Duplication

Code Coverage

How to fix Long Method

Long Method

Available Fixes

Available Fixes

1			<?php
2			/**
3			* Use doctrine odm as backend
4			*/
5
6			namespace Graviton\RestBundle\Model;
7
8			use Doctrine\ODM\MongoDB\DocumentRepository;
9			use Graviton\SchemaBundle\Model\SchemaModel;
10			use Symfony\Component\HttpFoundation\Request;
11			use Doctrine\ODM\MongoDB\Query\Builder;
12			use Graviton\Rql\Visitor\MongoOdm as Visitor;
13			use Xiag\Rql\Parser\Query;
14			use Graviton\ExceptionBundle\Exception\RecordOriginModifiedException;
15
16			/**
17			* Use doctrine odm as backend
18			*
19			* @author List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
20			* @license http://opensource.org/licenses/gpl-license.php GNU Public License
21			* @link http://swisscom.ch
22			*/
23			class DocumentModel extends SchemaModel implements ModelInterface
24			{
25			/**
26			* @var string
27			*/
28			protected $description;
29			/**
30			* @var string[]
31			*/
32			protected $fieldTitles;
33			/**
34			* @var string[]
35			*/
36			protected $fieldDescriptions;
37			/**
38			* @var string[]
39			*/
40			protected $requiredFields = array();
41			/**
42			* @var DocumentRepository
43			*/
44			private $repository;
45			/**
46			* @var Visitor
47			*/
48			private $visitor;
49			/**
50			* @var array
51			*/
52			protected $notModifiableOriginRecords;
53			/**
54			* @var integer
55			*/
56			private $paginationDefaultLimit;
57
58			/**
59			* @param Visitor $visitor rql query visitor
60			* @param array $notModifiableOriginRecords strings with not modifiable recordOrigin values
61			* @param integer $paginationDefaultLimit amount of data records to be returned when in pagination context.
62			*/
63	2		public function __construct(Visitor $visitor, $notModifiableOriginRecords, $paginationDefaultLimit)
64			{
65	2		parent::__construct();
66	2		$this->visitor = $visitor;
67	2		$this->notModifiableOriginRecords = $notModifiableOriginRecords;
68	2		$this->paginationDefaultLimit = (int) $paginationDefaultLimit;
69	2		}
70
71			/**
72			* get repository instance
73			*
74			* @return DocumentRepository
75			*/
76			public function getRepository()
77			{
78			return $this->repository;
79			}
80
81			/**
82			* create new app model
83			*
84			* @param DocumentRepository $repository Repository of countries
85			*
86			* @return \Graviton\RestBundle\Model\DocumentModel
87			*/
88	2		public function setRepository(DocumentRepository $repository)
89			{
90	2		$this->repository = $repository;
91
92	2		return $this;
93			}
94
95			/**
96			* {@inheritDoc}
97			*
98			* @param \Symfony\Component\HttpFoundation\Request $request Request object
99			*
100			* @return array
101			*/
102	1		public function findAll(Request $request)
103			{
104	1		$pageNumber = $request->query->get('page', 1);
105	1		$numberPerPage = (int) $request->query->get('perPage', $this->getDefaultLimit());
106	1		$startAt = ($pageNumber - 1) * $numberPerPage;
107
108			/** @var \Doctrine\ODM\MongoDB\Query\Builder $queryBuilder */
109	1		$queryBuilder = $this->repository
110	1		->createQueryBuilder();
111
112			// *** do we have an RQL expression, do we need to filter data?
113	1		if ($request->attributes->get('hasRql', false)) {
114			$queryBuilder = $this->doRqlQuery(
115			$queryBuilder,
116			$request->attributes->get('rqlQuery')
117			);
118			} else {
119			// @todo [lapistano]: seems the offset is missing for this query.
120			/** @var \Doctrine\ODM\MongoDB\Query\Builder $qb */
121	1		$queryBuilder->find($this->repository->getDocumentName());
122			}
123
124			// define offset and limit
125	1		if (!array_key_exists('skip', $queryBuilder->getQuery()->getQuery())) {
126	1		$queryBuilder->skip($startAt);
			0 ignored issues – show Bug introduced 2015-11-23 08:02 UTC by Report Bug Copy Issue Report The method `skip` does only exist in `Doctrine\ODM\MongoDB\Query\Builder`, but not in `Doctrine\ODM\MongoDB\Query\Expr`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
127	1		} else {
128			$startAt = (int) $queryBuilder->getQuery()->getQuery()['skip'];
129			}
130
131	1		if (!array_key_exists('limit', $queryBuilder->getQuery()->getQuery())) {
132	1		$queryBuilder->limit($numberPerPage);
			0 ignored issues – show Bug introduced 2015-11-23 08:02 UTC by Report Bug Copy Issue Report The method `limit` does only exist in `Doctrine\ODM\MongoDB\Query\Builder`, but not in `Doctrine\ODM\MongoDB\Query\Expr`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
133	1		} else {
134			$numberPerPage = (int) $queryBuilder->getQuery()->getQuery()['limit'];
135			}
136
137			/**
138			* add a default sort on id if none was specified earlier
139			*
140			* not specifying something to sort on leads to very weird cases when fetching references
141			*/
142	1		if (!array_key_exists('sort', $queryBuilder->getQuery()->getQuery())) {
143	1		$queryBuilder->sort('_id');
144	1		}
145
146			// run query
147	1		$query = $queryBuilder->getQuery();
148	1		$records = array_values($query->execute()->toArray());
149
150	1		$totalCount = $query->count();
151	1		$numPages = (int) ceil($totalCount / $numberPerPage);
152	1		$page = (int) ceil($startAt / $numberPerPage) + 1;
153	1		if ($numPages > 1) {
154			$request->attributes->set('paging', true);
155			$request->attributes->set('page', $page);
156			$request->attributes->set('numPages', $numPages);
157			$request->attributes->set('startAt', $startAt);
158			$request->attributes->set('perPage', $numberPerPage);
159			$request->attributes->set('totalCount', $totalCount);
160			}
161
162	1		return $records;
163			}
164
165			/**
166			* @param \Graviton\I18nBundle\Document\Translatable $entity entity to insert
167			*
168			* @return Object
169			*/
170		View Code Duplication	public function insertRecord($entity)
			0 ignored issues – show Duplication introduced 2015-11-23 08:02 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...
171			{
172			$this->checkIfOriginRecord($entity);
173			$manager = $this->repository->getDocumentManager();
174			$manager->persist($entity);
175			$manager->flush($entity);
176
177			return $this->find($entity->getId());
178			}
179
180			/**
181			* @param string $documentId id of entity to find
182			*
183			* @return Object
184			*/
185	1		public function find($documentId)
186			{
187	1		return $this->repository->find($documentId);
188			}
189
190			/**
191			* {@inheritDoc}
192			*
193			* @param string $documentId id of entity to update
194			* @param Object $entity new entity
195			*
196			* @return Object
197			*/
198	1	View Code Duplication	public function updateRecord($documentId, $entity)
			0 ignored issues – show Duplication introduced 2015-11-23 08:02 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...
199			{
200	1		$manager = $this->repository->getDocumentManager();
201			// In both cases the document attribute named originRecord must not be 'core'
202	1		$this->checkIfOriginRecord($entity);
203	1		$this->checkIfOriginRecord($this->find($documentId));
204	1		$entity = $manager->merge($entity);
205	1		$manager->flush();
206
207	1		return $entity;
208			}
209
210			/**
211			* {@inheritDoc}
212			*
213			* @param string $documentId id of entity to delete
214			*
215			* @return null\|Object
216			*/
217	1		public function deleteRecord($documentId)
218			{
219	1		$manager = $this->repository->getDocumentManager();
220	1		$entity = $this->find($documentId);
221
222	1		$return = $entity;
223	1		if ($entity) {
224	1		$this->checkIfOriginRecord($entity);
225	1		$manager->remove($entity);
226	1		$manager->flush();
227	1		$return = null;
228	1		}
229
230	1		return $return;
231			}
232
233			/**
234			* get classname of entity
235			*
236			* @return string
237			*/
238	1		public function getEntityClass()
239			{
240	1		return $this->repository->getDocumentName();
241			}
242
243			/**
244			* {@inheritDoc}
245			*
246			* Currently this is being used to build the route id used for redirecting
247			* to newly made documents. It might benefit from having a different name
248			* for those purposes.
249			*
250			* We might use a convention based mapping here:
251			* Graviton\CoreBundle\Document\App -> mongodb://graviton_core
252			* Graviton\CoreBundle\Entity\Table -> mysql://graviton_core
253			*
254			* @todo implement this in a more convention based manner
255			*
256			* @return string
257			*/
258			public function getConnectionName()
259			{
260			$bundle = strtolower(substr(explode('\\', get_class($this))[1], 0, -6));
261
262			return 'graviton.' . $bundle;
263			}
264
265			/**
266			* Does the actual query using the RQL Bundle.
267			*
268			* @param Builder $queryBuilder Doctrine ODM QueryBuilder
269			* @param Query $query query from parser
270			*
271			* @return array
272			*/
273			protected function doRqlQuery($queryBuilder, Query $query)
274			{
275			$this->visitor->setBuilder($queryBuilder);
276
277			return $this->visitor->visit($query);
278			}
279
280			/**
281			* Checks the recordOrigin attribute of a record and will throw an exception if value is not allowed
282			*
283			* @param Object $record record
284			*
285			* @return void
286			*/
287	7		protected function checkIfOriginRecord($record)
288			{
289			if ($record instanceof RecordOriginInterface
290	7		&& !$record->isRecordOriginModifiable()
291	7		) {
292	3		$values = $this->notModifiableOriginRecords;
293	3		$originValue = strtolower(trim($record->getRecordOrigin()));
294
295	3		if (in_array($originValue, $values)) {
296	1		$msg = sprintf("Must not be one of the following keywords: %s", implode(', ', $values));
297
298	1		throw new RecordOriginModifiedException($msg);
299			}
300	2		}
301	6		}
302
303			/**
304			* Determines the configured amount fo data records to be returned in pagination context.
305			*
306			* @return int
307			*/
308	1		private function getDefaultLimit()
309			{
310	1		if (0 < $this->paginationDefaultLimit) {
311	1		return $this->paginationDefaultLimit;
312	1		}
313
314			return 10;
315			}
316			}
317

libgraviton / graviton

Pull Request — develop (#352)

DocumentModel::findAll() B

Complexity

Size

Duplication

Code Coverage

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like