InstitutionConfigurationService::__construct() - Code Metrics - Inspection of "Address some remaining SSO on 2FA issues" - OpenConext/Stepup-Gateway - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — develop (#295)

by Peter

created 2023-09-07 06:58 UTC

InstitutionConfigurationService::__construct() A

↳ Parent: InstitutionConfigurationService

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
nc	1
nop	2
dl	0
loc	6
rs	10
c	1
b	0
f	0

<?php declare(strict_types=1);

/**
 * Copyright 2022 SURFnet bv
 *
 * 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 Surfnet\StepupGateway\GatewayBundle\Service;

use Psr\Log\LoggerInterface;
use Surfnet\StepupGateway\GatewayBundle\Entity\InstitutionConfigurationRepository;
use Surfnet\StepupGateway\GatewayBundle\Exception\InstitutionConfigurationNotFoundException;

class InstitutionConfigurationService

{
    private $repository;


    public function __construct(

        InstitutionConfigurationRepository $institutionConfigurationRepository,
        LoggerInterface $logger
    ) {
        $this->repository = $institutionConfigurationRepository;
        $this->logger = $logger;

    }


    public function ssoOn2faEnabled(string $institution): bool

    {
        try {
            return $this->repository->getInstitutionConfiguration($institution)->ssoOn2faEnabled;
        } catch (InstitutionConfigurationNotFoundException $e) {
            $this->logger->notice(sprintf('Institution %s is not configured to use SSO on 2FA', $institution));
        }
        return false;
    }
}


1			<?php declare(strict_types=1);
2
3			/**
4			* Copyright 2022 SURFnet bv
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			*/
			0 ignored issues – show Coding Style introduced 2023-09-07 07:02 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2023-09-07 07:02 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2023-09-07 07:02 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2023-09-07 07:02 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2023-09-07 07:02 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history... Coding Style introduced 2023-09-07 07:02 UTC by Report Bug Copy Issue Report Missing @link tag in file comment Loading history...
18
19			namespace Surfnet\StepupGateway\GatewayBundle\Service;
20
21			use Psr\Log\LoggerInterface;
22			use Surfnet\StepupGateway\GatewayBundle\Entity\InstitutionConfigurationRepository;
23			use Surfnet\StepupGateway\GatewayBundle\Exception\InstitutionConfigurationNotFoundException;
24
25			class InstitutionConfigurationService
			0 ignored issues – show Coding Style introduced 2023-09-07 07:02 UTC by Report Bug Copy Issue Report Missing doc comment for class InstitutionConfigurationService Loading history...
26			{
27			private $repository;
			0 ignored issues – show Coding Style introduced 2023-09-07 07:02 UTC by Report Bug Copy Issue Report Private member variable "repository" must be prefixed with an underscore Loading history...
28
29			public function __construct(
			0 ignored issues – show Coding Style introduced 2023-09-07 07:02 UTC by Report Bug Copy Issue Report Missing doc comment for function __construct() Loading history...
30			InstitutionConfigurationRepository $institutionConfigurationRepository,
31			LoggerInterface $logger
32			) {
33			$this->repository = $institutionConfigurationRepository;
34			$this->logger = $logger;
			0 ignored issues – show Bug Best Practice introduced 2023-09-07 07:02 UTC by Report Bug Copy Issue Report The property `logger` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
35			}
36
37
38			public function ssoOn2faEnabled(string $institution): bool
			0 ignored issues – show Coding Style introduced 2023-09-07 07:02 UTC by Report Bug Copy Issue Report Missing doc comment for function ssoOn2faEnabled() Loading history...
39			{
40			try {
41			return $this->repository->getInstitutionConfiguration($institution)->ssoOn2faEnabled;
42			} catch (InstitutionConfigurationNotFoundException $e) {
43			$this->logger->notice(sprintf('Institution %s is not configured to use SSO on 2FA', $institution));
44			}
45			return false;
46			}
47			}
48

OpenConext / Stepup-Gateway

Pull Request — develop (#295)

InstitutionConfigurationService::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like