RoleProvider::updateUserContext() - Code Metrics - Inspection of "Merge pull request #523 from hal869/master" - FriendsOfSymfony/FOSHttpCacheBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a4efda...49f2e8 )

by David

created 2019-06-18 06:09 UTC

RoleProvider::updateUserContext() A

↳ Parent: RoleProvider

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	3

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	19
ccs	11
cts	11
cp	1
rs	9.6333
cc	3
nc	3
nop	1
crap	3

<?php

/*
 * This file is part of the FOSHttpCacheBundle package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\HttpCacheBundle\UserContext;

use FOS\HttpCache\UserContext\ContextProvider;
use FOS\HttpCache\UserContext\UserContext;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Role\Role;

/**
 * The RoleProvider adds roles to the UserContext for the hash generation.
 */
class RoleProvider implements ContextProvider
{
    /**
     * @var TokenStorageInterface|null
     */
    private $tokenStorage;

    /**
     * Create the role provider with a security context.
     *
     * The token storage is optional to not fail on routes that have no
     * firewall. It is however not valid to call updateUserContext when not in
     * a firewall context.
     *
     * @param TokenStorageInterface $tokenStorage

     */
    public function __construct(TokenStorageInterface $tokenStorage = null)
    {
        $this->tokenStorage = $tokenStorage;
    }

    /**
     * {@inheritdoc}
     *
     * @throws InvalidConfigurationException when called without a security context being set
     */
    public function updateUserContext(UserContext $context)
    {
        if (null === $this->tokenStorage) {
            throw new InvalidConfigurationException('The context hash URL must be under a firewall.');
        }

        if (null === $token = $this->tokenStorage->getToken()) {
            return;
        }

        $roles = array_map(function (Role $role) {
            return $role->getRole();
        }, $token->getRoles());


        // Order is not important for roles and should not change hash.
        sort($roles);

        $context->addParameter('roles', $roles);
    }
}


1		<?php
2
3		/*
4		* This file is part of the FOSHttpCacheBundle package.
5		*
6		* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace FOS\HttpCacheBundle\UserContext;
13
14		use FOS\HttpCache\UserContext\ContextProvider;
15		use FOS\HttpCache\UserContext\UserContext;
16		use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
17		use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
18		use Symfony\Component\Security\Core\Role\Role;
19
20		/**
21		* The RoleProvider adds roles to the UserContext for the hash generation.
22		*/
23		class RoleProvider implements ContextProvider
24		{
25		/**
26		* @var TokenStorageInterface\|null
27		*/
28		private $tokenStorage;
29
30		/**
31		* Create the role provider with a security context.
32		*
33		* The token storage is optional to not fail on routes that have no
34		* firewall. It is however not valid to call updateUserContext when not in
35		* a firewall context.
36		*
37		* @param TokenStorageInterface $tokenStorage
		0 ignored issues – show Documentation introduced 2018-01-30 17:01 UTC by Report Bug Copy Issue Report Should the type for parameter `$tokenStorage` not be `null\|TokenStorageInterface`? 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...
38		*/
39	24	public function __construct(TokenStorageInterface $tokenStorage = null)
40		{
41	24	$this->tokenStorage = $tokenStorage;
42	24	}
43
44		/**
45		* {@inheritdoc}
46		*
47		* @throws InvalidConfigurationException when called without a security context being set
48		*/
49	5	public function updateUserContext(UserContext $context)
50		{
51	5	if (null === $this->tokenStorage) {
52	1	throw new InvalidConfigurationException('The context hash URL must be under a firewall.');
53		}
54
55	4	if (null === $token = $this->tokenStorage->getToken()) {
56	1	return;
57		}
58
59	3	$roles = array_map(function (Role $role) {
60	1	return $role->getRole();
61	3	}, $token->getRoles());
		0 ignored issues – show Deprecated Code introduced 2019-06-17 15:51 UTC by Report Bug Copy Issue Report The method `Symfony\Component\Securi...enInterface::getRoles()` has been deprecated with message: since Symfony 4.3, use the getRoleNames() method instead This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
62
63		// Order is not important for roles and should not change hash.
64	3	sort($roles);
65
66	3	$context->addParameter('roles', $roles);
67	3	}
68		}
69

FriendsOfSymfony / FOSHttpCacheBundle

Push — master ( a4efda...49f2e8 )

RoleProvider::updateUserContext() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like