Completed
Pull Request — master (#26)
by David
06:59
created

EventPublisherMixin::publish()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 7
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 2

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 7
ccs 5
cts 5
cp 1
rs 9.4286
cc 2
eloc 3
nc 2
nop 2
crap 2
1
<?php
2
3
namespace Rawkode\Eidetic\EventStore;
4
5
use Doctrine\Common\EventSubscriber;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, Rawkode\Eidetic\EventStore\EventSubscriber.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
6
7
trait EventPublisherMixin
8
{
9
    /**
10
     * @var array
11
     */
12
    private $eventSubscribers = [ ];
13
14
    /**
15
     * @param EventSubscriber $eventSubscriber
16
     */
17 2
    public function registerEventSubscriber($eventSubscriber)
18
    {
19 2
        array_push($this->eventSubscribers, $eventSubscriber);
20 2
    }
21
22
    /**
23
     * @param  int $eventHook
24
     * @param  object $event
25
     */
26 8
    public function publish($eventHook, $event)
27
    {
28
        /** @var EventSubscriber $eventSubscriber */
29 8
        foreach ($this->eventSubscribers as $eventSubscriber) {
30 2
            $eventSubscriber->handle($eventHook, $event);
31 8
        }
32 8
    }
33
}
34