DoctrineDonationEventLogger::log() - Code Metrics - Inspection of "Moved files to reflect contexts" - wmde/FundraisingFrontend - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#594)

by Jeroen De

created 2016-07-31 06:06 UTC

DoctrineDonationEventLogger::log() B

↳ Parent: DoctrineDonationEventLogger

Complexity

Conditions	5
Paths	8

Size

Total Lines	29
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	29
rs	8.439
c	1
b	0
f	0
cc	5
eloc	17
nc	8
nop	2

<?php

declare( strict_types = 1 );

namespace WMDE\Fundraising\Frontend\DonatingContext\DataAccess;

use Doctrine\ORM\EntityManager;
use Doctrine\ORM\ORMException;
use WMDE\Fundraising\Entities\Donation as DoctrineDonation;
use WMDE\Fundraising\Frontend\DonatingContext\Infrastructure\DonationEventLogException;
use WMDE\Fundraising\Frontend\DonatingContext\Infrastructure\DonationEventLogger;

/**
 * @license GNU GPL v2+
 * @author Gabriel Birke < [email protected] >
 */
class DoctrineDonationEventLogger implements DonationEventLogger {

	private $entityManager;
	private $timestampFunction;

	public function __construct( EntityManager $entityManager, callable $timestampFunction = 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;
    }
}
		$this->entityManager = $entityManager;
		if ( is_null( $timestampFunction ) ) {
			$this->timestampFunction = function () {
				return date( 'Y-m-d H:i:s' );
			};
		} else {
			$this->timestampFunction = $timestampFunction;
		}
	}

	public function log( int $donationId, string $message ) {
		try {
			/** @var DoctrineDonation $donation */
			$donation = $this->entityManager->find( DoctrineDonation::class, $donationId );
		}
		catch ( ORMException $e ) {
			throw new DonationEventLogException( 'Could not get donation', $e );
		}

		if ( is_null( $donation ) ) {
			throw new DonationEventLogException( 'Could not find donation with id ' . $donationId );
		}

		$data = $donation->getDecodedData();
		if ( empty( $data['log'] ) ) {
			$data['log'] = [];
		}
		$data['log'][call_user_func( $this->timestampFunction )] = $message;
		$donation->encodeAndSetData( $data );

		try {
			$this->entityManager->persist( $donation );
			$this->entityManager->flush();
		}
		catch ( ORMException $e ) {
			throw new DonationEventLogException( 'Could not store donation', $e );
		}

	}

}

1			<?php
2
3			declare( strict_types = 1 );
4
5			namespace WMDE\Fundraising\Frontend\DonatingContext\DataAccess;
6
7			use Doctrine\ORM\EntityManager;
8			use Doctrine\ORM\ORMException;
9			use WMDE\Fundraising\Entities\Donation as DoctrineDonation;
10			use WMDE\Fundraising\Frontend\DonatingContext\Infrastructure\DonationEventLogException;
11			use WMDE\Fundraising\Frontend\DonatingContext\Infrastructure\DonationEventLogger;
12
13			/**
14			* @license GNU GPL v2+
15			* @author Gabriel Birke < [email protected] >
16			*/
17			class DoctrineDonationEventLogger implements DonationEventLogger {
18
19			private $entityManager;
20			private $timestampFunction;
21
22			public function __construct( EntityManager $entityManager, callable $timestampFunction = null ) {
			0 ignored issues – show Bug introduced 2016-06-19 07:25 UTC by Report Bug Copy Issue Report You have injected the EntityManager via parameter `$entityManager`. 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...
23			$this->entityManager = $entityManager;
24			if ( is_null( $timestampFunction ) ) {
25			$this->timestampFunction = function () {
26			return date( 'Y-m-d H:i:s' );
27			};
28			} else {
29			$this->timestampFunction = $timestampFunction;
30			}
31			}
32
33			public function log( int $donationId, string $message ) {
34			try {
35			/** @var DoctrineDonation $donation */
36			$donation = $this->entityManager->find( DoctrineDonation::class, $donationId );
37			}
38			catch ( ORMException $e ) {
39			throw new DonationEventLogException( 'Could not get donation', $e );
40			}
41
42			if ( is_null( $donation ) ) {
43			throw new DonationEventLogException( 'Could not find donation with id ' . $donationId );
44			}
45
46			$data = $donation->getDecodedData();
47			if ( empty( $data['log'] ) ) {
48			$data['log'] = [];
49			}
50			$data['log'][call_user_func( $this->timestampFunction )] = $message;
51			$donation->encodeAndSetData( $data );
52
53			try {
54			$this->entityManager->persist( $donation );
55			$this->entityManager->flush();
56			}
57			catch ( ORMException $e ) {
58			throw new DonationEventLogException( 'Could not store donation', $e );
59			}
60
61			}
62
63			}

wmde / FundraisingFrontend

Pull Request — master (#594)

DoctrineDonationEventLogger::log() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like