Configuration::addProvidersSection() - Code Metrics - Inspection of "Show the Gssf logo if set in configuration" - OpenConext/Stepup-SelfService - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/gssp-add-through-confi... ( bd6c70 )

unknown

created 2017-05-29 14:12 UTC

Configuration::addProvidersSection() B

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	90
Code Lines	85

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	90
rs	8.5454
c	0
b	0
f	0
cc	1
eloc	85
nc	1
nop	1

How to fix Long Method

<?php

/**
 * Copyright 2014 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\StepupSelfService\SamlStepupProviderBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

class Configuration implements ConfigurationInterface
{
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('surfnet_stepup_self_service_saml_stepup_provider');

        $this->addRoutesSection($rootNode);
        $this->addProvidersSection($rootNode);

        return $treeBuilder;
    }

    /**
     * @param ArrayNodeDefinition $rootNode
     */
    private function addRoutesSection(ArrayNodeDefinition $rootNode)
    {
        $rootNode
            ->children()
            ->arrayNode('routes')
                ->children()
                    ->scalarNode('consume_assertion')
                        ->isRequired()
                        ->validate()
                            ->ifTrue(function ($v) {
                                return !is_string($v) || strlen($v) === 0;
                            })
                            ->thenInvalid('Consume assertion route must be a non-empty string')
                        ->end()
                    ->end()
                    ->scalarNode('metadata')
                        ->isRequired()
                        ->validate()
                            ->ifTrue(function ($v) {
                                return !is_string($v) || strlen($v) === 0;
                            })
                            ->thenInvalid('Metadata route must be a non-empty string')
                        ->end()
                    ->end()
                ->end()
            ->end();
    }

    /**
     * @param ArrayNodeDefinition $rootNode
     */
    private function addProvidersSection(ArrayNodeDefinition $rootNode)
    {
        /** @var ArrayNodeDefinition $protoType */
        $protoType = $rootNode
            ->children()
                ->arrayNode('providers')
                ->isRequired()
                ->requiresAtLeastOneElement()
                ->useAttributeAsKey('type')
                ->prototype('array');

        $protoType
            ->children()
                ->arrayNode('hosted')
                    ->children()
                        ->arrayNode('service_provider')
                            ->children()
                                ->scalarNode('public_key')
                                    ->isRequired()
                                    ->info('The absolute path to the public key used to sign AuthnRequests')
                                ->end()
                                ->scalarNode('private_key')
                                    ->isRequired()
                                    ->info('The absolute path to the private key used to sign AuthnRequests')
                                ->end()
                            ->end()
                        ->end()
                        ->arrayNode('metadata')
                            ->children()
                                ->scalarNode('public_key')
                                    ->isRequired()
                                    ->info('The absolute path to the public key used to sign the metadata')
                                ->end()
                                ->scalarNode('private_key')
                                    ->isRequired()
                                    ->info('The absolute path to the private key used to sign the metadata')
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('remote')
                    ->children()
                        ->scalarNode('entity_id')
                            ->isRequired()
                            ->info('The EntityID of the remote identity provider')
                        ->end()
                        ->scalarNode('sso_url')
                            ->isRequired()
                            ->info('The name of the route to generate the SSO URL')
                        ->end()
                        ->scalarNode('certificate')
                            ->isRequired()
                            ->info(
                                'The contents of the certificate used to sign the AuthnResponse with, if different from'
                                . ' the public key configured below'
                            )
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('view_config')
                    ->children()
                        ->scalarNode('loa')
                            ->isRequired()
                            ->info('The loa level (for now 1-3 are supported)')
                        ->end()
                        ->scalarNode('logo')
                            ->isRequired()
                            ->info('The absolute path to the logo of the gssp')
                        ->end()
                        ->scalarNode('alt')
                            ->isRequired()
                            ->info('The alt text of the gssp logo')
                        ->end()
                        ->scalarNode('title')
                            ->isRequired()
                            ->info('The title of the gssp')
                        ->end()
                        ->scalarNode('description')
                            ->isRequired()
                            ->info('The description of the gssp')
                        ->end()
                        ->scalarNode('button_use')
                            ->isRequired()
                            ->info('The text shown on the use button')
                        ->end()
                    ->end()
                ->end()
            ->end();
    }
}


1			<?php
2
3			/**
4			* Copyright 2014 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			*/
18
19			namespace Surfnet\StepupSelfService\SamlStepupProviderBundle\DependencyInjection;
20
21			use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
22			use Symfony\Component\Config\Definition\Builder\TreeBuilder;
23			use Symfony\Component\Config\Definition\ConfigurationInterface;
24
25			class Configuration implements ConfigurationInterface
26			{
27			public function getConfigTreeBuilder()
28			{
29			$treeBuilder = new TreeBuilder();
30			$rootNode = $treeBuilder->root('surfnet_stepup_self_service_saml_stepup_provider');
31
32			$this->addRoutesSection($rootNode);
33			$this->addProvidersSection($rootNode);
34
35			return $treeBuilder;
36			}
37
38			/**
39			* @param ArrayNodeDefinition $rootNode
40			*/
41			private function addRoutesSection(ArrayNodeDefinition $rootNode)
42			{
43			$rootNode
44			->children()
45			->arrayNode('routes')
46			->children()
47			->scalarNode('consume_assertion')
48			->isRequired()
49			->validate()
50			->ifTrue(function ($v) {
51			return !is_string($v) \|\| strlen($v) === 0;
52			})
53			->thenInvalid('Consume assertion route must be a non-empty string')
54			->end()
55			->end()
56			->scalarNode('metadata')
57			->isRequired()
58			->validate()
59			->ifTrue(function ($v) {
60			return !is_string($v) \|\| strlen($v) === 0;
61			})
62			->thenInvalid('Metadata route must be a non-empty string')
63			->end()
64			->end()
65			->end()
66			->end();
67			}
68
69			/**
70			* @param ArrayNodeDefinition $rootNode
71			*/
72			private function addProvidersSection(ArrayNodeDefinition $rootNode)
73			{
74			/** @var ArrayNodeDefinition $protoType */
75			$protoType = $rootNode
76			->children()
77			->arrayNode('providers')
78			->isRequired()
79			->requiresAtLeastOneElement()
80			->useAttributeAsKey('type')
81			->prototype('array');
82
83			$protoType
84			->children()
85			->arrayNode('hosted')
86			->children()
87			->arrayNode('service_provider')
88			->children()
89			->scalarNode('public_key')
90			->isRequired()
91			->info('The absolute path to the public key used to sign AuthnRequests')
92			->end()
93			->scalarNode('private_key')
94			->isRequired()
95			->info('The absolute path to the private key used to sign AuthnRequests')
96			->end()
97			->end()
98			->end()
99			->arrayNode('metadata')
100			->children()
101			->scalarNode('public_key')
102			->isRequired()
103			->info('The absolute path to the public key used to sign the metadata')
104			->end()
105			->scalarNode('private_key')
106			->isRequired()
107			->info('The absolute path to the private key used to sign the metadata')
108			->end()
109			->end()
110			->end()
111			->end()
112			->end()
113			->arrayNode('remote')
114			->children()
115			->scalarNode('entity_id')
116			->isRequired()
117			->info('The EntityID of the remote identity provider')
118			->end()
119			->scalarNode('sso_url')
120			->isRequired()
121			->info('The name of the route to generate the SSO URL')
122			->end()
123			->scalarNode('certificate')
124			->isRequired()
125			->info(
126			'The contents of the certificate used to sign the AuthnResponse with, if different from'
127			. ' the public key configured below'
128			)
129			->end()
130			->end()
131			->end()
132			->arrayNode('view_config')
133			->children()
134			->scalarNode('loa')
135			->isRequired()
136			->info('The loa level (for now 1-3 are supported)')
137			->end()
138			->scalarNode('logo')
139			->isRequired()
140			->info('The absolute path to the logo of the gssp')
141			->end()
142			->scalarNode('alt')
143			->isRequired()
144			->info('The alt text of the gssp logo')
145			->end()
146			->scalarNode('title')
147			->isRequired()
148			->info('The title of the gssp')
149			->end()
150			->scalarNode('description')
151			->isRequired()
152			->info('The description of the gssp')
153			->end()
154			->scalarNode('button_use')
155			->isRequired()
156			->info('The text shown on the use button')
157			->end()
158			->end()
159			->end()
160			->end();
161			}
162			}
163

OpenConext / Stepup-SelfService

Push — feature/gssp-add-through-confi... ( bd6c70 )

Configuration::addProvidersSection() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like