DocumentModel::updateRecord() - Code Metrics - Inspection of "EVO-4951 - Massively improve PUT/POST/PATCH perfor..." - libgraviton/graviton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#430)

by Narcotic

created 2016-06-14 10:16 UTC

DocumentModel::updateRecord() B

↳ Parent: DocumentModel

Complexity

Conditions	2
Paths	2

Size

Total Lines	24
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
c	3
b	1
f	0
dl	0
loc	24
ccs	0
cts	11
cp	0
rs	8.9713
cc	2
eloc	8
nc	2
nop	3
crap	6

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

namespace Graviton\RestBundle\Model;

use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\DocumentRepository;
use Graviton\RestBundle\Service\RqlTranslator;
use Graviton\Rql\Node\SearchNode;
use Graviton\SchemaBundle\Model\SchemaModel;
use Graviton\SecurityBundle\Entities\SecurityUser;
use Symfony\Component\HttpFoundation\Request;
use Doctrine\ODM\MongoDB\Query\Builder;
use Graviton\Rql\Visitor\MongoOdm as Visitor;
use Xiag\Rql\Parser\Node\Query\LogicOperator\AndNode;
use Xiag\Rql\Parser\Node\Query\LogicOperator\OrNode;
use Xiag\Rql\Parser\Node\Query\ScalarOperator\LikeNode;
use Xiag\Rql\Parser\Query;
use Graviton\ExceptionBundle\Exception\RecordOriginModifiedException;
use Xiag\Rql\Parser\Exception\SyntaxErrorException as RqlSyntaxErrorException;
use Graviton\SchemaBundle\Document\Schema as SchemaDocument;

/**
 * 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 string[]
     */
    protected $searchableFields = array();
    /**
     * @var DocumentRepository
     */
    private $repository;
    /**
     * @var Visitor
     */
    private $visitor;
    /**
     * @var array
     */
    protected $notModifiableOriginRecords;
    /**
     * @var  integer
     */
    private $paginationDefaultLimit;

    /**
     * @var boolean
     */
    protected $filterByAuthUser;

    /**
     * @var string
     */
    protected $filterByAuthField;

    /**
     * @var RqlTranslator
     */
    protected $translator;

    /**
     * @var DocumentManager
     */
    protected $manager;

    /**
     * @param Visitor       $visitor                    rql query visitor
     * @param RqlTranslator $translator                 Translator for query modification
     * @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,
        RqlTranslator $translator,
        $notModifiableOriginRecords,
        $paginationDefaultLimit
    ) {
        parent::__construct();
        $this->visitor = $visitor;
        $this->translator = $translator;
        $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;
        $this->manager = $repository->getDocumentManager();

        return $this;
    }

    /**
     * {@inheritDoc}
     *
     * @param Request        $request The request object
     * @param SecurityUser   $user    SecurityUser Object

     * @param SchemaDocument $schema  Schema model used for search fields extraction

     *
     * @return array
     */
    public function findAll(Request $request, SecurityUser $user = null, SchemaDocument $schema = null)
    {
        $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();

        if ($this->filterByAuthUser && $user && $user->hasRole(SecurityUser::ROLE_USER)) {
            $queryBuilder->field($this->filterByAuthField)->equals($user->getUser()->getId());
        }


        $searchableFields = $this->getSearchableFields();
        if (!is_null($schema)) {
            $searchableFields = $schema->getSearchable();
        }

        // *** do we have an RQL expression, do we need to filter data?
        if ($request->attributes->get('hasRql', false)) {
            $queryBuilder = $this->doRqlQuery(
                $queryBuilder,
                $this->translator->translateSearchQuery(
                    $request->attributes->get('rqlQuery'),
                    $searchableFields
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                )
            );
        } 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'];
        }

        // Limit can not be negative nor null.
        if ($numberPerPage < 1) {
            throw new RqlSyntaxErrorException('negative or null limit in rql');
        }

        /**
         * 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 object $entity       entity to insert
     * @param bool   $returnEntity true to return entity
     * @param bool   $doFlush      if we should flush or not after insert
     *
     * @return Object|null
     */
    public function insertRecord($entity, $returnEntity = true, $doFlush = true)
    {
        $this->checkIfOriginRecord($entity);
        $this->manager->persist($entity);

        if ($doFlush) {
            $this->manager->flush($entity);
        }
        if ($returnEntity) {
            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
     * @param bool   $returnEntity true to return entity
     *
     * @return Object

     */
    public function updateRecord($documentId, $entity, $returnEntity = true)
    {
        // In both cases the document attribute named originRecord must not be 'core'
        $this->checkIfOriginRecord($entity);
        $this->checkIfOriginRecord($this->selectSingleFields($documentId, ['recordOrigin']));

        /*
         * @TODO @hairmare i remember this fixed something important - why do we do it? can't we just delete the old
         * document and insert the new one? we always have the entire object(?) i guess would be faster
         * and we surely wouldn't have any array update problems as in the past..
         */
        /*
        $manager = $this->repository->getDocumentManager();
        $entity = $manager->merge($entity);
        $manager->flush();
        */

        $this->deleteById($documentId);
        $this->manager->persist($entity);
        $this->manager->flush($entity);

        if ($returnEntity) {
            return $entity;
        }
    }

    /**
     * {@inheritDoc}
     *
     * @param string|object $id id of entity to delete or entity instance
     *
     * @return null|Object
     */
    public function deleteRecord($id)
    {
        if (is_object($id)) {
            $entity = $id;
        } else {
            $entity = $this->find($id);
        }

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

        return $return;
    }

    /**
     * Triggers a flush on the DocumentManager
     *
     * @param null $document optional document
     *
     * @return void
     */
    public function flush($document = null)
    {
        $this->manager->flush($document);
    }

    /**
     * A low level delete without any checks
     *
     * @param mixed $id record id
     *
     * @return void
     */
    private function deleteById($id)
    {
        $builder = $this->repository->createQueryBuilder();
        $builder
            ->remove()
            ->field('id')->equals($id)
            ->getQuery()
            ->execute();
    }

    /**
     * Checks in a performant way if a certain record id exists in the database
     *
     * @param mixed $id record id
     *
     * @return bool true if it exists, false otherwise
     */
    public function recordExists($id)

    {
        return is_array($this->selectSingleFields($id, ['id'], false));
    }

    /**
     * Returns a set of fields from an existing resource in a performant manner.
     * If you need to check certain fields on an object (and don't need everything), this
     * is a better way to get what you need.
     * If the record is not present, you will receive null. If you don't need an hydrated
     * instance, make sure to pass false there.
     *
     * @param mixed $id      record id
     * @param array $fields  list of fields you need.
     * @param bool  $hydrate whether to hydrate object or not
     *
     * @return array|null|object
     */
    public function selectSingleFields($id, array $fields, $hydrate = true)
    {
        $builder = $this->repository->createQueryBuilder();
        $idField = $this->repository->getClassMetadata()->getIdentifier()[0];

        $record = $builder
            ->field($idField)->equals($id)
            ->select($fields)
            ->hydrate($hydrate)
            ->getQuery()
            ->getSingleResult();

        return $record;
    }

    /**
     * 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;
    }

    /**
     * @param Boolean $active active
     * @param String  $field  field
     * @return void
     */
    public function setFilterByAuthUser($active, $field)
    {
        $this->filterByAuthUser = is_bool($active) ? $active : false;
        $this->filterByAuthField = $field;
    }
}


Pull Request — develop (#430)

DocumentModel::updateRecord() B

Complexity

Size

Duplication

Code Coverage

Importance

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\DocumentManager;
9		use Doctrine\ODM\MongoDB\DocumentRepository;
10		use Graviton\RestBundle\Service\RqlTranslator;
11		use Graviton\Rql\Node\SearchNode;
12		use Graviton\SchemaBundle\Model\SchemaModel;
13		use Graviton\SecurityBundle\Entities\SecurityUser;
14		use Symfony\Component\HttpFoundation\Request;
15		use Doctrine\ODM\MongoDB\Query\Builder;
16		use Graviton\Rql\Visitor\MongoOdm as Visitor;
17		use Xiag\Rql\Parser\Node\Query\LogicOperator\AndNode;
18		use Xiag\Rql\Parser\Node\Query\LogicOperator\OrNode;
19		use Xiag\Rql\Parser\Node\Query\ScalarOperator\LikeNode;
20		use Xiag\Rql\Parser\Query;
21		use Graviton\ExceptionBundle\Exception\RecordOriginModifiedException;
22		use Xiag\Rql\Parser\Exception\SyntaxErrorException as RqlSyntaxErrorException;
23		use Graviton\SchemaBundle\Document\Schema as SchemaDocument;
24
25		/**
26		* Use doctrine odm as backend
27		*
28		* @author List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
29		* @license http://opensource.org/licenses/gpl-license.php GNU Public License
30		* @link http://swisscom.ch
31		*/
32		class DocumentModel extends SchemaModel implements ModelInterface
33		{
34		/**
35		* @var string
36		*/
37		protected $description;
38		/**
39		* @var string[]
40		*/
41		protected $fieldTitles;
42		/**
43		* @var string[]
44		*/
45		protected $fieldDescriptions;
46		/**
47		* @var string[]
48		*/
49		protected $requiredFields = array();
50		/**
51		* @var string[]
52		*/
53		protected $searchableFields = array();
54		/**
55		* @var DocumentRepository
56		*/
57		private $repository;
58		/**
59		* @var Visitor
60		*/
61		private $visitor;
62		/**
63		* @var array
64		*/
65		protected $notModifiableOriginRecords;
66		/**
67		* @var integer
68		*/
69		private $paginationDefaultLimit;
70
71		/**
72		* @var boolean
73		*/
74		protected $filterByAuthUser;
75
76		/**
77		* @var string
78		*/
79		protected $filterByAuthField;
80
81		/**
82		* @var RqlTranslator
83		*/
84		protected $translator;
85
86		/**
87		* @var DocumentManager
88		*/
89		protected $manager;
90
91		/**
92		* @param Visitor $visitor rql query visitor
93		* @param RqlTranslator $translator Translator for query modification
94		* @param array $notModifiableOriginRecords strings with not modifiable recordOrigin values
95		* @param integer $paginationDefaultLimit amount of data records to be returned when in pagination context
96		*/
97		public function __construct(
98		Visitor $visitor,
99		RqlTranslator $translator,
100		$notModifiableOriginRecords,
101		$paginationDefaultLimit
102		) {
103		parent::__construct();
104		$this->visitor = $visitor;
105		$this->translator = $translator;
106		$this->notModifiableOriginRecords = $notModifiableOriginRecords;
107		$this->paginationDefaultLimit = (int) $paginationDefaultLimit;
108		}
109
110		/**
111		* get repository instance
112		*
113		* @return DocumentRepository
114		*/
115		public function getRepository()
116		{
117		return $this->repository;
118		}
119
120		/**
121		* create new app model
122		*
123		* @param DocumentRepository $repository Repository of countries
124		*
125		* @return \Graviton\RestBundle\Model\DocumentModel
126		*/
127		public function setRepository(DocumentRepository $repository)
128		{
129		$this->repository = $repository;
130		$this->manager = $repository->getDocumentManager();
131
132		return $this;
133		}
134
135		/**
136		* {@inheritDoc}
137		*
138		* @param Request $request The request object
139		* @param SecurityUser $user SecurityUser Object
		0 ignored issues – show Documentation introduced 2016-03-30 09:55 UTC by Report Bug Copy Issue Report Should the type for parameter `$user` not be `null\|SecurityUser`? 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...
140		* @param SchemaDocument $schema Schema model used for search fields extraction
		0 ignored issues – show Documentation introduced 2016-03-30 09:55 UTC by Report Bug Copy Issue Report Should the type for parameter `$schema` not be `null\|SchemaDocument`? 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...
141		*
142		* @return array
143		*/
144		public function findAll(Request $request, SecurityUser $user = null, SchemaDocument $schema = null)
145		{
146		$pageNumber = $request->query->get('page', 1);
147		$numberPerPage = (int) $request->query->get('perPage', $this->getDefaultLimit());
148		$startAt = ($pageNumber - 1) * $numberPerPage;
149
150		/** @var \Doctrine\ODM\MongoDB\Query\Builder $queryBuilder */
151		$queryBuilder = $this->repository
152		->createQueryBuilder();
153
154		if ($this->filterByAuthUser && $user && $user->hasRole(SecurityUser::ROLE_USER)) {
155		$queryBuilder->field($this->filterByAuthField)->equals($user->getUser()->getId());
156		}
157
158
159		$searchableFields = $this->getSearchableFields();
160		if (!is_null($schema)) {
161		$searchableFields = $schema->getSearchable();
162		}
163
164		// *** do we have an RQL expression, do we need to filter data?
165		if ($request->attributes->get('hasRql', false)) {
166		$queryBuilder = $this->doRqlQuery(
167		$queryBuilder,
168		$this->translator->translateSearchQuery(
169		$request->attributes->get('rqlQuery'),
170		$searchableFields
		0 ignored issues – show Bug introduced 2016-03-23 14:10 UTC by Report Bug Copy Issue Report It seems like `$searchableFields` defined by `$schema->getSearchable()` on line `161` can also be of type `null`; however, `Graviton\RestBundle\Serv...:translateSearchQuery()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
171		)
172		);
173		} else {
174		// @todo [lapistano]: seems the offset is missing for this query.
175		/** @var \Doctrine\ODM\MongoDB\Query\Builder $qb */
176		$queryBuilder->find($this->repository->getDocumentName());
177		}
178
179		// define offset and limit
180		if (!array_key_exists('skip', $queryBuilder->getQuery()->getQuery())) {
181		$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...
182		} else {
183		$startAt = (int) $queryBuilder->getQuery()->getQuery()['skip'];
184		}
185
186		if (!array_key_exists('limit', $queryBuilder->getQuery()->getQuery())) {
187		$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...
188		} else {
189		$numberPerPage = (int) $queryBuilder->getQuery()->getQuery()['limit'];
190		}
191
192		// Limit can not be negative nor null.
193		if ($numberPerPage < 1) {
194		throw new RqlSyntaxErrorException('negative or null limit in rql');
195		}
196
197		/**
198		* add a default sort on id if none was specified earlier
199		*
200		* not specifying something to sort on leads to very weird cases when fetching references
201		*/
202		if (!array_key_exists('sort', $queryBuilder->getQuery()->getQuery())) {
203		$queryBuilder->sort('_id');
204		}
205
206		// run query
207		$query = $queryBuilder->getQuery();
208		$records = array_values($query->execute()->toArray());
209
210		$totalCount = $query->count();
211		$numPages = (int) ceil($totalCount / $numberPerPage);
212		$page = (int) ceil($startAt / $numberPerPage) + 1;
213		if ($numPages > 1) {
214		$request->attributes->set('paging', true);
215		$request->attributes->set('page', $page);
216		$request->attributes->set('numPages', $numPages);
217		$request->attributes->set('startAt', $startAt);
218		$request->attributes->set('perPage', $numberPerPage);
219		$request->attributes->set('totalCount', $totalCount);
220		}
221
222		return $records;
223		}
224
225		/**
226		* @param object $entity entity to insert
227		* @param bool $returnEntity true to return entity
228		* @param bool $doFlush if we should flush or not after insert
229		*
230		* @return Object\|null
231		*/
232		public function insertRecord($entity, $returnEntity = true, $doFlush = true)
233		{
234		$this->checkIfOriginRecord($entity);
235		$this->manager->persist($entity);
236
237		if ($doFlush) {
238		$this->manager->flush($entity);
239		}
240		if ($returnEntity) {
241		return $this->find($entity->getId());
242		}
243		}
244
245		/**
246		* @param string $documentId id of entity to find
247		*
248		* @return Object
249		*/
250		public function find($documentId)
251		{
252		return $this->repository->find($documentId);
253		}
254
255		/**
256		* {@inheritDoc}
257		*
258		* @param string $documentId id of entity to update
259		* @param Object $entity new entity
260		* @param bool $returnEntity true to return entity
261		*
262		* @return Object
		0 ignored issues – show Documentation introduced 2016-06-03 10:00 UTC by Report Bug Copy Issue Report Should the return type not be `object\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
263		*/
264		public function updateRecord($documentId, $entity, $returnEntity = true)
265		{
266		// In both cases the document attribute named originRecord must not be 'core'
267		$this->checkIfOriginRecord($entity);
268		$this->checkIfOriginRecord($this->selectSingleFields($documentId, ['recordOrigin']));
		0 ignored issues – show Bug introduced 2016-06-03 10:00 UTC by Report Bug Copy Issue Report It seems like `$this->selectSingleField... array('recordOrigin'))` targeting `Graviton\RestBundle\Mode...l::selectSingleFields()` can also be of type `array` or `null`; however, `Graviton\RestBundle\Mode...::checkIfOriginRecord()` does only seem to accept `object`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
269		/*
270		* @TODO @hairmare i remember this fixed something important - why do we do it? can't we just delete the old
271		* document and insert the new one? we always have the entire object(?) i guess would be faster
272		* and we surely wouldn't have any array update problems as in the past..
273		*/
274		/*
275		$manager = $this->repository->getDocumentManager();
276		$entity = $manager->merge($entity);
277		$manager->flush();
278		*/
279
280		$this->deleteById($documentId);
281		$this->manager->persist($entity);
282		$this->manager->flush($entity);
283
284		if ($returnEntity) {
285		return $entity;
286		}
287		}
288
289		/**
290		* {@inheritDoc}
291		*
292		* @param string\|object $id id of entity to delete or entity instance
293		*
294		* @return null\|Object
295		*/
296		public function deleteRecord($id)
297		{
298		if (is_object($id)) {
299		$entity = $id;
300		} else {
301		$entity = $this->find($id);
302		}
303
304		$return = $entity;
305		if ($entity) {
306		$this->checkIfOriginRecord($entity);
307		$this->manager->remove($entity);
308		$this->manager->flush();
309		$return = null;
310		}
311
312		return $return;
313		}
314
315		/**
316		* Triggers a flush on the DocumentManager
317		*
318		* @param null $document optional document
319		*
320		* @return void
321		*/
322		public function flush($document = null)
323		{
324		$this->manager->flush($document);
325		}
326
327		/**
328		* A low level delete without any checks
329		*
330		* @param mixed $id record id
331		*
332		* @return void
333		*/
334		private function deleteById($id)
335		{
336		$builder = $this->repository->createQueryBuilder();
337		$builder
338		->remove()
339		->field('id')->equals($id)
340	12	->getQuery()
341		->execute();
342	6	}
343	12
344	6	/**
345	6	* Checks in a performant way if a certain record id exists in the database
346	6	*
347		* @param mixed $id record id
348	6	*
349	2	* @return bool true if it exists, false otherwise
350		*/
351	2	public function recordExists($id)
		0 ignored issues – show Coding Style introduced 2016-06-03 10:00 UTC by Report Bug Copy Issue Report `function recordExists()` does not seem to conform to the naming convention (`^(?:is\|has\|should\|may\|supports)`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
352		{
353	2	return is_array($this->selectSingleFields($id, ['id'], false));
354	10	}
355
356		/**
357		* Returns a set of fields from an existing resource in a performant manner.
358		* If you need to check certain fields on an object (and don't need everything), this
359		* is a better way to get what you need.
360		* If the record is not present, you will receive null. If you don't need an hydrated
361		* instance, make sure to pass false there.
362		*
363		* @param mixed $id record id
364		* @param array $fields list of fields you need.
365		* @param bool $hydrate whether to hydrate object or not
366		*
367		* @return array\|null\|object
368		*/
369		public function selectSingleFields($id, array $fields, $hydrate = true)
370		{
371		$builder = $this->repository->createQueryBuilder();
372		$idField = $this->repository->getClassMetadata()->getIdentifier()[0];
373
374		$record = $builder
375		->field($idField)->equals($id)
376		->select($fields)
377		->hydrate($hydrate)
378		->getQuery()
379		->getSingleResult();
380
381		return $record;
382		}
383
384		/**
385		* get classname of entity
386		*
387		* @return string
388		*/
389		public function getEntityClass()
390		{
391		return $this->repository->getDocumentName();
392		}
393
394		/**
395		* {@inheritDoc}
396		*
397		* Currently this is being used to build the route id used for redirecting
398		* to newly made documents. It might benefit from having a different name
399		* for those purposes.
400		*
401		* We might use a convention based mapping here:
402		* Graviton\CoreBundle\Document\App -> mongodb://graviton_core
403		* Graviton\CoreBundle\Entity\Table -> mysql://graviton_core
404		*
405		* @todo implement this in a more convention based manner
406		*
407		* @return string
408		*/
409		public function getConnectionName()
410		{
411		$bundle = strtolower(substr(explode('\\', get_class($this))[1], 0, -6));
412
413		return 'graviton.' . $bundle;
414		}
415
416		/**
417		* Does the actual query using the RQL Bundle.
418		*
419		* @param Builder $queryBuilder Doctrine ODM QueryBuilder
420		* @param Query $query query from parser
421		*
422		* @return array
		0 ignored issues – show Documentation introduced 2016-03-30 09:55 UTC by Report Bug Copy Issue Report Should the return type not be `Builder\|\Doctrine\ODM\MongoDB\Query\Expr`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
423		*/
424		protected function doRqlQuery($queryBuilder, Query $query)
425		{
426		$this->visitor->setBuilder($queryBuilder);
427
428		return $this->visitor->visit($query);
429		}
430
431		/**
432		* Checks the recordOrigin attribute of a record and will throw an exception if value is not allowed
433		*
434		* @param Object $record record
435		*
436		* @return void
437		*/
438		protected function checkIfOriginRecord($record)
439		{
440		if ($record instanceof RecordOriginInterface
441		&& !$record->isRecordOriginModifiable()
442		) {
443		$values = $this->notModifiableOriginRecords;
444		$originValue = strtolower(trim($record->getRecordOrigin()));
445
446		if (in_array($originValue, $values)) {
447		$msg = sprintf("Must not be one of the following keywords: %s", implode(', ', $values));
448
449		throw new RecordOriginModifiedException($msg);
450		}
451		}
452		}
453
454		/**
455		* Determines the configured amount fo data records to be returned in pagination context.
456		*
457		* @return int
458		*/
459		private function getDefaultLimit()
460		{
461		if (0 < $this->paginationDefaultLimit) {
462		return $this->paginationDefaultLimit;
463		}
464
465		return 10;
466		}
467
468		/**
469		* @param Boolean $active active
470		* @param String $field field
471		* @return void
472		*/
473		public function setFilterByAuthUser($active, $field)
474		{
475		$this->filterByAuthUser = is_bool($active) ? $active : false;
476		$this->filterByAuthField = $field;
477		}
478		}
479

libgraviton / graviton

Pull Request — develop (#430)

DocumentModel::updateRecord() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like