Completed
Pull Request — master (#5848)
by Iltar
29:12 queued 20:36
created

PreFlushEventArgs::getEntities()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
cc 1
eloc 2
nc 1
nop 0
crap 1
1
<?php
2
/*
3
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14
 *
15
 * This software consists of voluntary contributions made by many individuals
16
 * and is licensed under the MIT license. For more information, see
17
 * <http://www.doctrine-project.org>.
18
 */
19
20
namespace Doctrine\ORM\Event;
21
22
use Doctrine\Common\EventArgs;
23
use Doctrine\ORM\EntityManagerInterface;
24
25
/**
26
 * Provides event arguments for the preFlush event.
27
 *
28
 * @license     http://www.opensource.org/licenses/mit-license.php MIT
29
 * @link        www.doctrine-project.com
30
 * @since       2.0
31
 * @author      Roman Borschel <[email protected]>
32
 * @author      Benjamin Eberlei <[email protected]>
33
 */
34
class PreFlushEventArgs extends EventArgs
35
{
36
    /**
37
     * @var \Doctrine\ORM\EntityManager
38
     */
39
    private $em;
40
41
    /**
42
     * @var null|array
43
     */
44
    private $entities;
45
46
    /**
47
     * Constructor.
48
     *
49
     * @param EntityManagerInterface $em
50
     * @param null|array             $entities
51
     */
52 144
    public function __construct(EntityManagerInterface $em, array $entities = null)
53
    {
54 144
        $this->em       = $em;
0 ignored issues
show
Documentation Bug introduced by
$em is of type object<Doctrine\ORM\EntityManagerInterface>, but the property $em was declared to be of type object<Doctrine\ORM\EntityManager>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly.

Either this assignment is in error or an instanceof check should be added for that assignment.

class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
Loading history...
55 144
        $this->entities = $entities;
56 144
    }
57
58
    /**
59
     * @return \Doctrine\ORM\EntityManager
60
     */
61 3
    public function getEntityManager()
62
    {
63 3
        return $this->em;
64
    }
65
66
    /**
67
     * @return bool true if flushed for a specific set of entities (explicit flush).
68
     */
69 5
    public function hasEntities()
70
    {
71 5
        return null !== $this->entities;
72
    }
73
74
    /**
75
     * @return null|array entities being flushed in an explicit flush.
76
     */
77 4
    public function getEntities()
78
    {
79 4
        return $this->entities;
80
    }
81
}
82