AbstractEvent::__construct() - Code Metrics - Inspection of "include event metadata" - phpgears/event - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0fe229...42b9af )

by Julián

created 2019-06-07 23:50 UTC

AbstractEvent::__construct() A

↳ Parent: AbstractEvent

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	3

<?php

/*
 * event (https://github.com/phpgears/event).
 * Event handling.
 *
 * @license MIT
 * @link https://github.com/phpgears/event
 * @author Julián Gutiérrez <[email protected]>
 */

declare(strict_types=1);

namespace Gears\Event;

use Gears\Event\Time\SystemTimeProvider;
use Gears\Event\Time\TimeProvider;

/**
 * Abstract immutable event.
 */
abstract class AbstractEvent implements Event
{
    use EventBehaviour;

    /**
     * AbstractEvent constructor.
     *
     * @param array<string, mixed> $payload
     * @param array<string, mixed> $metadata
     * @param \DateTimeImmutable   $createdAt
     */
    private function __construct(array $payload, array $metadata, \DateTimeImmutable $createdAt)
    {
        $this->checkImmutability();

        $this->setPayload($payload);
        $this->setMetadata($metadata);
        $this->createdAt = $createdAt->setTimezone(new \DateTimeZone('UTC'));
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * Instantiate new event.
     *
     * @param array<string, mixed> $payload
     * @param TimeProvider         $timeProvider

     *
     * @return mixed|self

     */
    final protected static function occurred(array $payload, ?TimeProvider $timeProvider = null)
    {
        $timeProvider = $timeProvider ?? new SystemTimeProvider();

        return new static($payload, [], $timeProvider->getCurrentTime());
    }

    /**
     * {@inheritdoc}
     *
     * @return mixed|self

     */
    public static function reconstitute(array $payload, array $attributes)
    {
        return new static($payload, $attributes['metadata'], $attributes['createdAt']);
    }

    /**
     * {@inheritdoc}
     *
     * @return string[]
     */
    final protected function getAllowedInterfaces(): array
    {
        return [Event::class];
    }
}


1			<?php
2
3			/*
4			* event (https://github.com/phpgears/event).
5			* Event handling.
6			*
7			* @license MIT
8			* @link https://github.com/phpgears/event
9			* @author Julián Gutiérrez <[email protected]>
10			*/
11
12			declare(strict_types=1);
13
14			namespace Gears\Event;
15
16			use Gears\Event\Time\SystemTimeProvider;
17			use Gears\Event\Time\TimeProvider;
18
19			/**
20			* Abstract immutable event.
21			*/
22			abstract class AbstractEvent implements Event
23			{
24			use EventBehaviour;
25
26			/**
27			* AbstractEvent constructor.
28			*
29			* @param array<string, mixed> $payload
30			* @param array<string, mixed> $metadata
31			* @param \DateTimeImmutable $createdAt
32			*/
33			private function __construct(array $payload, array $metadata, \DateTimeImmutable $createdAt)
34			{
35			$this->checkImmutability();
36
37			$this->setPayload($payload);
38			$this->setMetadata($metadata);
39			$this->createdAt = $createdAt->setTimezone(new \DateTimeZone('UTC'));
			0 ignored issues – show Documentation Bug introduced 2018-11-21 22:27 UTC by Report Bug Copy Issue Report It seems like `$createdAt->setTimezone(new \DateTimeZone('UTC'))` can also be of type `false`. However, the property `$createdAt` is declared as type `object<DateTimeImmutable>`. Maybe add an additional type 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 mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
40			}
41
42			/**
43			* Instantiate new event.
44			*
45			* @param array<string, mixed> $payload
46			* @param TimeProvider $timeProvider
			0 ignored issues – show Documentation introduced 2018-11-21 22:27 UTC by Report Bug Copy Issue Report Should the type for parameter `$timeProvider` not be `TimeProvider\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
47			*
48			* @return mixed\|self
			0 ignored issues – show Documentation introduced 2018-11-21 22:27 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `AbstractEvent`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
49			*/
50			final protected static function occurred(array $payload, ?TimeProvider $timeProvider = null)
51			{
52			$timeProvider = $timeProvider ?? new SystemTimeProvider();
53
54			return new static($payload, [], $timeProvider->getCurrentTime());
55			}
56
57			/**
58			* {@inheritdoc}
59			*
60			* @return mixed\|self
			0 ignored issues – show Documentation introduced 2018-11-21 22:27 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `AbstractEvent`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
61			*/
62			public static function reconstitute(array $payload, array $attributes)
63			{
64			return new static($payload, $attributes['metadata'], $attributes['createdAt']);
65			}
66
67			/**
68			* {@inheritdoc}
69			*
70			* @return string[]
71			*/
72			final protected function getAllowedInterfaces(): array
73			{
74			return [Event::class];
75			}
76			}
77

phpgears / event

Push — master ( 0fe229...42b9af )

AbstractEvent::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like