Doctrine2::__construct() - Code Metrics - libreworks/caridea-dao - Measure and Improve Code Quality continuously with Scrutinizer

Doctrine2::__construct() A
last analyzed 2018-01-29 00:15 UTC

↳ Parent: Doctrine2

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	5
nc	1
nop	3
crap	1

<?php
declare(strict_types=1);
/**
 * Caridea
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 * @copyright 2015-2018 LibreWorks contributors
 * @license   Apache-2.0
 */
namespace Caridea\Dao;

use Doctrine\ORM\EntityManager;

/**
 * An abstract Data Access Object for the Doctrine ORM library.
 *
 * @copyright 2015-2018 LibreWorks contributors
 * @license   Apache-2.0
 */
abstract class Doctrine2 extends Dao
{
    /**
     * @var \Doctrine\ORM\EntityManager The entity manager
     */
    protected $manager;
    /**
     * @var string
     */
    protected $entityName;
    /**
     * @var \Doctrine\ORM\EntityRepository The entity repository
     */
    protected $repository;

    /**
     * Creates a new MongoDB DAO.
     *
     * @param \Doctrine\ORM\EntityManager $manager The entity manager
     * @param string $entityName The entity name
     * @param \Psr\Log\LoggerInterface $logger A logger
     */
    public function __construct(EntityManager $manager, string $entityName, \Psr\Log\LoggerInterface $logger = null)
function someFunction(ManagerRegistry $registry) {
    $em = $registry->getManager();
    $em->getConnection()->beginTransaction();
    try {
        // Do something.
        $em->getConnection()->commit();
    } catch (\Exception $ex) {
        $em->getConnection()->rollback();
        $em->close();

        throw $ex;
    }
}
    {
        parent::__construct($logger);
        $this->manager = $manager;
        $this->entityName = $entityName;
        $this->repository = $manager->getRepository($entityName);
    }

    /**
     * Executes something in the context of the entityManager.
     *
     * Exceptions are caught and translated.
     *
     * @param Closure $cb The closure to execute, takes the entityManager
     * @return mixed whatever the function returns, this method also returns
     * @throws \Caridea\Dao\Exception If a database problem occurs
     * @see \Caridea\Dao\Exception\Translator\Doctrine
     */
    protected function doExecute(\Closure $cb)
    {
        try {
            return $cb($this->manager);
        } catch (\Exception $e) {
            throw Exception\Translator\Doctrine::translate($e);
        }
    }

    /**
     * Executes something in the context of the entityRepository.
     *
     * Exceptions are caught and translated.
     *
     * @param Closure $cb The closure to execute, takes the entityRepository
     * @return mixed whatever the function returns, this method also returns
     * @throws \Caridea\Dao\Exception If a database problem occurs
     * @see \Caridea\Dao\Exception\Translator\Doctrine
     */
    protected function doExecuteInRepository(\Closure $cb)
    {
        try {
            return $cb($this->repository);
        } catch (\Exception $e) {
            throw Exception\Translator\Doctrine::translate($e);
        }
    }
}


1		<?php
2		declare(strict_types=1);
3		/**
4		* Caridea
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License"); you may not
7		* use this file except in compliance with the License. You may obtain a copy of
8		* the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14		* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15		* License for the specific language governing permissions and limitations under
16		* the License.
17		*
18		* @copyright 2015-2018 LibreWorks contributors
19		* @license Apache-2.0
20		*/
21		namespace Caridea\Dao;
22
23		use Doctrine\ORM\EntityManager;
24
25		/**
26		* An abstract Data Access Object for the Doctrine ORM library.
27		*
28		* @copyright 2015-2018 LibreWorks contributors
29		* @license Apache-2.0
30		*/
31		abstract class Doctrine2 extends Dao
32		{
33		/**
34		* @var \Doctrine\ORM\EntityManager The entity manager
35		*/
36		protected $manager;
37		/**
38		* @var string
39		*/
40		protected $entityName;
41		/**
42		* @var \Doctrine\ORM\EntityRepository The entity repository
43		*/
44		protected $repository;
45
46		/**
47		* Creates a new MongoDB DAO.
48		*
49		* @param \Doctrine\ORM\EntityManager $manager The entity manager
50		* @param string $entityName The entity name
51		* @param \Psr\Log\LoggerInterface $logger A logger
52		*/
53	4	public function __construct(EntityManager $manager, string $entityName, \Psr\Log\LoggerInterface $logger = null)
		0 ignored issues – show Bug introduced 2018-01-29 00:15 UTC by Report Bug Copy Issue Report You have injected the EntityManager via parameter `$manager`. This is generally not recommended as it might get closed and become unusable. Instead, it is recommended to inject the ManagerRegistry and retrieve the EntityManager via `getManager()` each time you need it. The `EntityManager` might become unusable for example if a transaction is rolled back and it gets closed. Let’s assume that somewhere in your application, or in a third-party library, there is code such as the following: function someFunction(ManagerRegistry $registry) { $em = $registry->getManager(); $em->getConnection()->beginTransaction(); try { // Do something. $em->getConnection()->commit(); } catch (\Exception $ex) { $em->getConnection()->rollback(); $em->close(); throw $ex; } } If that code throws an exception and the `EntityManager` is closed. Any other code which depends on the same instance of the `EntityManager` during this request will fail. On the other hand, if you instead inject the `ManagerRegistry`, the `getManager()` method guarantees that you will always get a usable manager instance. Loading history...
54		{
55	4	parent::__construct($logger);
56	4	$this->manager = $manager;
57	4	$this->entityName = $entityName;
58	4	$this->repository = $manager->getRepository($entityName);
59	4	}
60
61		/**
62		* Executes something in the context of the entityManager.
63		*
64		* Exceptions are caught and translated.
65		*
66		* @param Closure $cb The closure to execute, takes the entityManager
67		* @return mixed whatever the function returns, this method also returns
68		* @throws \Caridea\Dao\Exception If a database problem occurs
69		* @see \Caridea\Dao\Exception\Translator\Doctrine
70		*/
71	2	protected function doExecute(\Closure $cb)
72		{
73		try {
74	2	return $cb($this->manager);
75	1	} catch (\Exception $e) {
76	1	throw Exception\Translator\Doctrine::translate($e);
77		}
78		}
79
80		/**
81		* Executes something in the context of the entityRepository.
82		*
83		* Exceptions are caught and translated.
84		*
85		* @param Closure $cb The closure to execute, takes the entityRepository
86		* @return mixed whatever the function returns, this method also returns
87		* @throws \Caridea\Dao\Exception If a database problem occurs
88		* @see \Caridea\Dao\Exception\Translator\Doctrine
89		*/
90	2	protected function doExecuteInRepository(\Closure $cb)
91		{
92		try {
93	2	return $cb($this->repository);
94	1	} catch (\Exception $e) {
95	1	throw Exception\Translator\Doctrine::translate($e);
96		}
97		}
98		}
99

libreworks / caridea-dao

Doctrine2::__construct() A last analyzed 2018-01-29 00:15 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Doctrine2::__construct() A
last analyzed 2018-01-29 00:15 UTC