HandlesEvents::getEventHandlingMethods() - Code Metrics - spatie/laravel-event-projector - Measure and Improve Code Quality continuously with Scrutinizer

HandlesEvents::getEventHandlingMethods() A
last analyzed 2019-09-20 09:16 UTC

↳ Parent: HandlesEvents

Complexity

Conditions	5
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	21
rs	9.2728
c	0
b	0
f	0
cc	5
nc	3
nop	0

<?php

namespace Spatie\EventProjector\EventHandlers;

use Exception;
use ReflectionClass;
use ReflectionMethod;
use ReflectionParameter;
use Illuminate\Support\Collection;
use Spatie\EventProjector\StoredEvent;
use Spatie\EventProjector\ShouldBeStored;
use Spatie\EventProjector\Exceptions\InvalidEventHandler;

trait HandlesEvents
{
    public function handles(): array
    {
        return $this->getEventHandlingMethods()->keys()->toArray();
    }

    public function handle(StoredEvent $storedEvent)
    {
        $eventClass = $storedEvent->event_class;

        $handlerClassOrMethod = $this->getEventHandlingMethods()->get($eventClass);

        $parameters = [
            'event' => $storedEvent->event,
            'storedEvent' => $storedEvent,
            'aggregateUuid' => $storedEvent->aggregate_uuid,
        ];

        if (class_exists($handlerClassOrMethod)) {
            return app()->call([app($handlerClassOrMethod), '__invoke'], $parameters);
        }

        if (! method_exists($this, $handlerClassOrMethod)) {
            throw InvalidEventHandler::eventHandlingMethodDoesNotExist($this, $storedEvent->event, $handlerClassOrMethod);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }

        app()->call([$this, $handlerClassOrMethod], $parameters);
    }

    public function handleException(Exception $exception): void
    {
        report($exception);
    }

    public function getEventHandlingMethods(): Collection
    {
        if (! isset($this->handlesEvents) && ! isset($this->handleEvent)) {
            return $this->autoDetectHandlesEvents();
        }

        $handlesEvents = collect($this->handlesEvents ?? [])
class MyClass { }

$x = new MyClass();
$x->foo = true;
            ->mapWithKeys(function (string $handlerMethod, $eventClass) {
                if (is_numeric($eventClass)) {
                    return [$handlerMethod => 'on'.ucfirst(class_basename($handlerMethod))];
                }

                return [$eventClass => $handlerMethod];
            });

        if ($this->handleEvent ?? false) {

            $handlesEvents->put($this->handleEvent, get_class($this));

        }

        return $handlesEvents;
    }

    private function autoDetectHandlesEvents(): Collection
    {
        return collect((new ReflectionClass($this))->getMethods())
            ->flatMap(function (ReflectionMethod $method) {
                $method = new ReflectionMethod($this, $method->name);
                if (! $method->isPublic()) {
                    return;
                }

                $eventClass = collect($method->getParameters())
                    ->map(function (ReflectionParameter $parameter) {
                        return optional($parameter->getType())->getName();
                    })
                    ->first(function ($typeHint) {
                        return is_subclass_of($typeHint, ShouldBeStored::class);
                    });

                if (! $eventClass) {
                    return;
                }

                return [$eventClass => $method->name];
            })
            ->filter();
    }
}


1			<?php
2
3			namespace Spatie\EventProjector\EventHandlers;
4
5			use Exception;
6			use ReflectionClass;
7			use ReflectionMethod;
8			use ReflectionParameter;
9			use Illuminate\Support\Collection;
10			use Spatie\EventProjector\StoredEvent;
11			use Spatie\EventProjector\ShouldBeStored;
12			use Spatie\EventProjector\Exceptions\InvalidEventHandler;
13
14			trait HandlesEvents
15			{
16			public function handles(): array
17			{
18			return $this->getEventHandlingMethods()->keys()->toArray();
19			}
20
21			public function handle(StoredEvent $storedEvent)
22			{
23			$eventClass = $storedEvent->event_class;
24
25			$handlerClassOrMethod = $this->getEventHandlingMethods()->get($eventClass);
26
27			$parameters = [
28			'event' => $storedEvent->event,
29			'storedEvent' => $storedEvent,
30			'aggregateUuid' => $storedEvent->aggregate_uuid,
31			];
32
33			if (class_exists($handlerClassOrMethod)) {
34			return app()->call([app($handlerClassOrMethod), '__invoke'], $parameters);
35			}
36
37			if (! method_exists($this, $handlerClassOrMethod)) {
38			throw InvalidEventHandler::eventHandlingMethodDoesNotExist($this, $storedEvent->event, $handlerClassOrMethod);
			0 ignored issues – show Bug introduced 2019-08-09 13:25 UTC by Report Bug Copy Issue Report It seems like `$storedEvent->event` can be `null`; however, `eventHandlingMethodDoesNotExist()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
39			}
40
41			app()->call([$this, $handlerClassOrMethod], $parameters);
42			}
43
44			public function handleException(Exception $exception): void
45			{
46			report($exception);
47			}
48
49			public function getEventHandlingMethods(): Collection
50			{
51			if (! isset($this->handlesEvents) && ! isset($this->handleEvent)) {
52			return $this->autoDetectHandlesEvents();
53			}
54
55			$handlesEvents = collect($this->handlesEvents ?? [])
			0 ignored issues – show Bug introduced 2019-04-08 16:03 UTC by Report Bug Copy Issue Report The property `handlesEvents` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
56			->mapWithKeys(function (string $handlerMethod, $eventClass) {
57			if (is_numeric($eventClass)) {
58			return [$handlerMethod => 'on'.ucfirst(class_basename($handlerMethod))];
59			}
60
61			return [$eventClass => $handlerMethod];
62			});
63
64			if ($this->handleEvent ?? false) {
			0 ignored issues – show Bug introduced 2019-04-08 16:03 UTC by Report Bug Copy Issue Report The property `handleEvent` does not seem to exist. Did you mean `handlesEvents`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
65			$handlesEvents->put($this->handleEvent, get_class($this));
			0 ignored issues – show Bug introduced 2019-04-08 16:03 UTC by Report Bug Copy Issue Report The property `handleEvent` does not seem to exist. Did you mean `handlesEvents`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
66			}
67
68			return $handlesEvents;
69			}
70
71			private function autoDetectHandlesEvents(): Collection
72			{
73			return collect((new ReflectionClass($this))->getMethods())
74			->flatMap(function (ReflectionMethod $method) {
75			$method = new ReflectionMethod($this, $method->name);
76			if (! $method->isPublic()) {
77			return;
78			}
79
80			$eventClass = collect($method->getParameters())
81			->map(function (ReflectionParameter $parameter) {
82			return optional($parameter->getType())->getName();
83			})
84			->first(function ($typeHint) {
85			return is_subclass_of($typeHint, ShouldBeStored::class);
86			});
87
88			if (! $eventClass) {
89			return;
90			}
91
92			return [$eventClass => $method->name];
93			})
94			->filter();
95			}
96			}
97

spatie / laravel-event-projector

HandlesEvents::getEventHandlingMethods() A last analyzed 2019-09-20 09:16 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

HandlesEvents::getEventHandlingMethods() A
last analyzed 2019-09-20 09:16 UTC