These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | |||
3 | namespace Kunstmaan\AdminBundle\EventListener; |
||
4 | |||
5 | use Symfony\Component\EventDispatcher\EventSubscriberInterface; |
||
6 | use Symfony\Component\HttpKernel\Event\GetResponseEvent; |
||
7 | use Symfony\Component\HttpKernel\Event\ResponseEvent; |
||
8 | use Symfony\Component\HttpKernel\KernelEvents; |
||
9 | use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface; |
||
10 | use Symfony\Component\Security\Core\Authentication\Token\TokenInterface; |
||
11 | use Symfony\Component\Translation\TranslatorInterface; |
||
12 | use Kunstmaan\AdminBundle\Helper\AdminRouteHelper; |
||
13 | |||
14 | /** |
||
15 | * AdminLocaleListener to override default locale if user-specific locale is set in database |
||
16 | */ |
||
17 | class AdminLocaleListener implements EventSubscriberInterface |
||
18 | { |
||
19 | /** |
||
20 | * @var TokenStorageInterface |
||
21 | */ |
||
22 | private $tokenStorage; |
||
23 | |||
24 | /** |
||
25 | * @var TranslatorInterface |
||
26 | */ |
||
27 | private $translator; |
||
28 | |||
29 | /** |
||
30 | * @var string |
||
31 | */ |
||
32 | private $defaultAdminLocale; |
||
33 | |||
34 | /** |
||
35 | * @var string |
||
36 | */ |
||
37 | private $providerKey; |
||
38 | |||
39 | /** |
||
40 | * @var AdminRouteHelper |
||
41 | */ |
||
42 | private $adminRouteHelper; |
||
43 | |||
44 | /** |
||
45 | * @param TokenStorageInterface $tokenStorage |
||
46 | * @param TranslatorInterface $translator |
||
47 | * @param string $defaultAdminLocale |
||
48 | * @param AdminRouteHelper $adminRouteHelper |
||
49 | * @param string $providerKey Firewall name to check against |
||
50 | */ |
||
51 | 3 | public function __construct(TokenStorageInterface $tokenStorage, TranslatorInterface $translator, AdminRouteHelper $adminRouteHelper, $defaultAdminLocale, $providerKey = 'main') |
|
52 | { |
||
53 | 3 | $this->translator = $translator; |
|
54 | 3 | $this->tokenStorage = $tokenStorage; |
|
55 | 3 | $this->defaultAdminLocale = $defaultAdminLocale; |
|
56 | 3 | $this->providerKey = $providerKey; |
|
57 | 3 | $this->adminRouteHelper = $adminRouteHelper; |
|
58 | 3 | } |
|
59 | |||
60 | /** |
||
61 | * onKernelRequest |
||
62 | * |
||
63 | * @param GetResponseEvent|ResponseEvent $event |
||
64 | */ |
||
65 | 3 | public function onKernelRequest($event) |
|
66 | { |
||
67 | 3 | View Code Duplication | if (!$event instanceof GetResponseEvent && !$event instanceof ResponseEvent) { |
0 ignored issues
–
show
|
|||
68 | throw new \InvalidArgumentException(\sprintf('Expected instance of type %s, %s given', \class_exists(ResponseEvent::class) ? ResponseEvent::class : GetResponseEvent::class, \is_object($event) ? \get_class($event) : \gettype($event))); |
||
69 | } |
||
70 | |||
71 | 3 | $url = $event->getRequest()->getRequestUri(); |
|
72 | 3 | if (!$this->adminRouteHelper->isAdminRoute($url)) { |
|
73 | 1 | return; |
|
74 | } |
||
75 | |||
76 | 2 | $token = $this->tokenStorage->getToken(); |
|
77 | 2 | if ($token && $this->isAdminToken($this->providerKey, $token)) { |
|
78 | 2 | $locale = $token->getUser()->getAdminLocale(); |
|
79 | |||
80 | 2 | if (!$locale) { |
|
81 | 2 | $locale = $this->defaultAdminLocale; |
|
82 | } |
||
83 | |||
84 | 2 | $this->translator->setLocale($locale); |
|
85 | } |
||
86 | 2 | } |
|
87 | |||
88 | /** |
||
89 | * @param TokenInterface $token |
||
0 ignored issues
–
show
Should the type for parameter
$token not be null|TokenInterface ?
This check looks for 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. ![]() |
|||
90 | * @param $providerKey |
||
91 | * |
||
92 | * @return bool |
||
93 | */ |
||
94 | 2 | private function isAdminToken($providerKey, TokenInterface $token = null) |
|
95 | { |
||
96 | 2 | return \is_callable([$token, 'getProviderKey']) && $token->getProviderKey() === $providerKey; |
|
0 ignored issues
–
show
It seems like you code against a concrete implementation and not the interface
Symfony\Component\Securi...on\Token\TokenInterface as the method getProviderKey() does only exist in the following implementations of said interface: Symfony\Component\Securi...n\PreAuthenticatedToken , Symfony\Component\Securi...n\PreAuthenticatedToken , Symfony\Component\Securi...n\Token\RememberMeToken , Symfony\Component\Securi...n\Token\RememberMeToken , Symfony\Component\Securi...n\Token\SwitchUserToken , Symfony\Component\Securi...n\Token\SwitchUserToken , Symfony\Component\Securi...n\UsernamePasswordToken , Symfony\Component\Securi...n\UsernamePasswordToken , Symfony\Component\Securi...uthenticationGuardToken .
Let’s take a look at an example: interface User
{
/** @return string */
public function getPassword();
}
class MyUser implements User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
97 | } |
||
98 | |||
99 | /** |
||
100 | * getSubscribedEvents |
||
101 | */ |
||
102 | 6 | public static function getSubscribedEvents() |
|
103 | { |
||
104 | return array( |
||
105 | // Must be registered before the default Locale listener |
||
106 | 6 | KernelEvents::REQUEST => array(array('onKernelRequest', 17)), |
|
107 | ); |
||
108 | } |
||
109 | } |
||
110 |
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.