Transaction::__destruct() - Code Metrics - hfw/db - Measure and Improve Code Quality continuously with Scrutinizer

Transaction::__destruct() A
last analyzed 2021-07-26 13:53 UTC

↳ Parent: Transaction

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php

namespace Helix\DB;

use Helix\DB;

/**
 * Scoped transaction/savepoint.
 *
 * If the instance isn't committed before it loses scope, it's rolled back.
 * There is no `rollback()` method.
 *
 * In order to ensure proper destruction, the instance MUST NOT leave the scope it's created in.
 *
 * @method static static factory(DB $db)
 */
class Transaction
{

    use FactoryTrait;

    /**
     * @var bool
     */
    protected $committed = false;

    /**
     * @var DB
     */
    protected $db;

    /**
     * Begins the transaction/savepoint.
     *
     * @param DB $db
     */
    public function __construct(DB $db)
    {
        $this->db = $db;
        $db->beginTransaction();
    }

    /**
     * Rolls back if the instance wasn't committed.
     */
    public function __destruct()
    {
        if (!$this->committed) {
            $this->db->rollBack();
        }
    }

    /**
     * Commits the transaction/savepoint.
     *
     * This is safe to call multiple times, it won't have any effect after the first time.
     *
     * @return true
     */
    public function commit(): bool
    {
        return $this->committed or $this->committed = $this->db->commit();

    }

    /**
     * @return bool
     */
    final public function wasCommitted(): bool
    {
        return $this->committed;
    }
}


1			<?php
2
3			namespace Helix\DB;
4
5			use Helix\DB;
6
7			/**
8			* Scoped transaction/savepoint.
9			*
10			* If the instance isn't committed before it loses scope, it's rolled back.
11			* There is no `rollback()` method.
12			*
13			* In order to ensure proper destruction, the instance MUST NOT leave the scope it's created in.
14			*
15			* @method static static factory(DB $db)
16			*/
17			class Transaction
18			{
19
20			use FactoryTrait;
21
22			/**
23			* @var bool
24			*/
25			protected $committed = false;
26
27			/**
28			* @var DB
29			*/
30			protected $db;
31
32			/**
33			* Begins the transaction/savepoint.
34			*
35			* @param DB $db
36			*/
37			public function __construct(DB $db)
38			{
39			$this->db = $db;
40			$db->beginTransaction();
41			}
42
43			/**
44			* Rolls back if the instance wasn't committed.
45			*/
46			public function __destruct()
47			{
48			if (!$this->committed) {
49			$this->db->rollBack();
50			}
51			}
52
53			/**
54			* Commits the transaction/savepoint.
55			*
56			* This is safe to call multiple times, it won't have any effect after the first time.
57			*
58			* @return true
59			*/
60			public function commit(): bool
61			{
62			return $this->committed or $this->committed = $this->db->commit();
			0 ignored issues – show Bug Best Practice introduced 2021-06-07 08:25 UTC by Report Bug Copy Issue Report The expression `return $this->committed ...d = $this->db->commit()` returns the type `boolean` which is incompatible with the documented return type `true`. Loading history...
63			}
64
65			/**
66			* @return bool
67			*/
68			final public function wasCommitted(): bool
69			{
70			return $this->committed;
71			}
72			}
73

hfw / db

Transaction::__destruct() A last analyzed 2021-07-26 13:53 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Transaction::__destruct() A
last analyzed 2021-07-26 13:53 UTC