AttributeFilter - Code Metrics - OpenConext/OpenConext-profile - Measure and Improve Code Quality continuously with Scrutinizer

AttributeFilter A
last analyzed 2019-11-07 14:09 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	25
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	3
lcom	1
cbo	3
dl	0
loc	25
rs	10
c	0
b	0
f	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	filter()	0	12	3

<?php

/**
 * Copyright 2017 SURFnet B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace OpenConext\ProfileBundle\Attribute;

use Surfnet\SamlBundle\SAML2\Attribute\AttributeSet;
use Surfnet\SamlBundle\SAML2\Attribute\Attribute;

final class AttributeFilter
{
    private static $filterValues = [
        'commonName',
        'displayName',
        'mail',
        'uid',
        'eduPersonPrincipalName',
        'affiliation',
        'schacHomeOrganization',
    ];

    public function filter(AttributeSet $attributeSet)
    {
        /** @var Attribute[] $attributes */
        $attributes = $attributeSet->getIterator()->getArrayCopy();
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.
    }
}
        foreach ($attributes as $index => $attribute) {
            $attributeName = $attribute->getAttributeDefinition()->getName();
            if (!in_array($attributeName, self::$filterValues)) {
                unset($attributes[$index]);
            }
        }
        return AttributeSet::create($attributes);
    }
}


1			<?php
2
3			/**
4			* Copyright 2017 SURFnet B.V.
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License");
7			* you may not use this file except in compliance with the License.
8			* You may obtain a copy of the License at
9			*
10			* http://www.apache.org/licenses/LICENSE-2.0
11			*
12			* Unless required by applicable law or agreed to in writing, software
13			* distributed under the License is distributed on an "AS IS" BASIS,
14			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15			* See the License for the specific language governing permissions and
16			* limitations under the License.
17			*/
18
19			namespace OpenConext\ProfileBundle\Attribute;
20
21			use Surfnet\SamlBundle\SAML2\Attribute\AttributeSet;
22			use Surfnet\SamlBundle\SAML2\Attribute\Attribute;
23
24			final class AttributeFilter
25			{
26			private static $filterValues = [
27			'commonName',
28			'displayName',
29			'mail',
30			'uid',
31			'eduPersonPrincipalName',
32			'affiliation',
33			'schacHomeOrganization',
34			];
35
36			public function filter(AttributeSet $attributeSet)
37			{
38			/** @var Attribute[] $attributes */
39			$attributes = $attributeSet->getIterator()->getArrayCopy();
			0 ignored issues – show Bug introduced 2019-06-24 09:43 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Traversable` as the method `getArrayCopy()` does only exist in the following implementations of said interface: `ArrayIterator`, `ArrayObject`, `DoctrineTest\Instantiato...tAsset\ArrayObjectAsset`, `DoctrineTest\Instantiato...lizableArrayObjectAsset`, `DoctrineTest\Instantiato...ceptionArrayObjectAsset`, `DoctrineTest\Instantiato...sset\WakeUpNoticesAsset`, `Issue523`, `JakubOnderka\PhpParallelLint\ArrayIterator`, `RecursiveArrayIterator`, `Symfony\Component\Finder...rator\InnerNameIterator`, `Symfony\Component\Finder...rator\InnerSizeIterator`, `Symfony\Component\Finder...rator\InnerTypeIterator`, `Symfony\Component\Finder...or\MockFileListIterator`, `Symfony\Component\Form\E...r\ViolationPathIterator`, `Symfony\Component\Proper...ss\PropertyPathIterator`, `Symfony\Component\VarDum...\Caster\MyArrayIterator`. 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 Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
40			foreach ($attributes as $index => $attribute) {
41			$attributeName = $attribute->getAttributeDefinition()->getName();
42			if (!in_array($attributeName, self::$filterValues)) {
43			unset($attributes[$index]);
44			}
45			}
46			return AttributeSet::create($attributes);
47			}
48			}
49

OpenConext / OpenConext-profile

AttributeFilter A last analyzed 2019-11-07 14:09 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

Available Fixes

Duplication Side-by-Side

Filter issues like

AttributeFilter A
last analyzed 2019-11-07 14:09 UTC