Completed
Push — master ( 67a92e...b03a00 )
by Grégoire
01:54
created

src/Consumer/LoggerConsumer.php (2 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
declare(strict_types=1);
4
5
/*
6
 * This file is part of the Sonata Project package.
7
 *
8
 * (c) Thomas Rabaix <[email protected]>
9
 *
10
 * For the full copyright and license information, please view the LICENSE
11
 * file that was distributed with this source code.
12
 */
13
14
namespace Sonata\NotificationBundle\Consumer;
15
16
use Psr\Log\LoggerInterface;
17
use Sonata\NotificationBundle\Exception\InvalidParameterException;
18
use Symfony\Component\HttpKernel\Log\LoggerInterface as LegacyLoggerInterface;
19
20
class LoggerConsumer implements ConsumerInterface
21
{
22
    /**
23
     * @var LoggerInterface
24
     */
25
    protected $logger;
26
27
    /**
28
     * @var string[]
29
     */
30
    protected $types = [
31
        'emerg' => 'emergency',
32
        'alert' => 'alert',
33
        'crit' => 'critical',
34
        'err' => 'error',
35
        'warn' => 'warning',
36
        'notice' => 'notice',
37
        'info' => 'info',
38
        'debug' => 'debug',
39
    ];
40
41
    /**
42
     * @param LoggerInterface|LegacyLoggerInterface $logger
43
     */
44
    public function __construct($logger)
45
    {
46
        if ($logger instanceof LegacyLoggerInterface) {
47
            @trigger_error(
48
                sprintf(
49
                    'Using an instance of "%s" is deprecated since version 2.3. Use Psr\Log\LoggerInterface instead.',
50
                    \get_class($logger)
51
                ),
52
                E_USER_DEPRECATED
53
            );
54
        }
55
        $this->logger = $logger;
0 ignored issues
show
Documentation Bug introduced by
It seems like $logger can also be of type object<Symfony\Component...el\Log\LoggerInterface>. However, the property $logger is declared as type object<Psr\Log\LoggerInterface>. 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...
56
    }
57
58
    /**
59
     * {@inheritdoc}
60
     */
61
    public function process(ConsumerEvent $event): void
62
    {
63
        $message = $event->getMessage();
64
65
        if (!array_key_exists($message->getValue('level'), $this->types)) {
66
            throw new InvalidParameterException();
0 ignored issues
show
Deprecated Code introduced by
The class Sonata\NotificationBundl...validParameterException has been deprecated with message: Use Sonata\CoreBundle\Exception\InvalidParameterException instead

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
67
        }
68
69
        $level = $this->types[$message->getValue('level')];
70
71
        $this->logger->{$level}($message->getValue('message'));
72
    }
73
}
74