Passed
Push — feature/symfony6-upgrade ( ee4c86...d448d5 )
by Michiel
06:57
created

StateHandler::setRequestId()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 2
nc 1
nop 1
dl 0
loc 5
rs 10
c 0
b 0
f 0
1
<?php
2
3
declare(strict_types = 1);
4
5
/**
6
 * Copyright 2014 SURFnet bv
7
 *
8
 * Licensed under the Apache License, Version 2.0 (the "License");
9
 * you may not use this file except in compliance with the License.
10
 * You may obtain a copy of the License at
11
 *
12
 *     http://www.apache.org/licenses/LICENSE-2.0
13
 *
14
 * Unless required by applicable law or agreed to in writing, software
15
 * distributed under the License is distributed on an "AS IS" BASIS,
16
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17
 * See the License for the specific language governing permissions and
18
 * limitations under the License.
19
 */
0 ignored issues
show
Coding Style introduced by
PHP version not specified
Loading history...
Coding Style introduced by
Missing @category tag in file comment
Loading history...
Coding Style introduced by
Missing @package tag in file comment
Loading history...
Coding Style introduced by
Missing @author tag in file comment
Loading history...
Coding Style introduced by
Missing @license tag in file comment
Loading history...
Coding Style introduced by
Missing @link tag in file comment
Loading history...
20
21
namespace Surfnet\StepupSelfService\SamlStepupProviderBundle\Saml;
22
23
use Symfony\Component\HttpFoundation\RequestStack;
24
use Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface;
25
26
final  class StateHandler
0 ignored issues
show
Coding Style introduced by
Missing doc comment for class StateHandler
Loading history...
27
{
28
    const REQUEST_ID = 'request_id';
29
30
    public function __construct(
0 ignored issues
show
Coding Style introduced by
Missing doc comment for function __construct()
Loading history...
31
        private RequestStack $requestStack,
32
        private string                $provider,
33
    ) {
34
    }
35
36
    public function setRequestId(string $originalRequestId): self
0 ignored issues
show
Coding Style introduced by
Missing doc comment for function setRequestId()
Loading history...
37
    {
38
        $this->set(self::REQUEST_ID, $originalRequestId);
39
40
        return $this;
41
    }
42
43
    public function getRequestId(): ?string
0 ignored issues
show
Coding Style introduced by
Missing doc comment for function getRequestId()
Loading history...
44
    {
45
        return $this->get(self::REQUEST_ID);
46
    }
47
48
    public function clear(): void
0 ignored issues
show
Coding Style introduced by
Missing doc comment for function clear()
Loading history...
49
    {
50
        // @todo this used to only remove the GSSP state for a provider. But now removes noting as $this->provider is not a session key
51
        // The namespaced sesion bag would remove all session state prepended with $this->provider.
52
        //
53
        //demogssp/sstateitem1 => foobar
54
        //demogssp/requestid => foobar
55
        $session = $this->requestStack->getSession();
56
        $session->getBag()->clear();
0 ignored issues
show
Bug introduced by
The call to Symfony\Component\HttpFo...sionInterface::getBag() has too few arguments starting with name. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

56
        $session->/** @scrutinizer ignore-call */ 
57
                  getBag()->clear();

This check compares calls to functions or methods with their respective definitions. If the call has less arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. Please note the @ignore annotation hint above.

Loading history...
57
58
        $this->requestStack->getSession()->remove($this->provider);
59
    }
60
61
    protected function set(string $key, $value): void
0 ignored issues
show
Coding Style introduced by
Missing doc comment for function set()
Loading history...
62
    {
63
64
        $this->requestStack->getSession()->set($this->provider . '/' . $key, $value);
65
    }
66
67
    protected function get(string $key)
0 ignored issues
show
Coding Style introduced by
Missing doc comment for function get()
Loading history...
68
    {
69
        return $this->requestStack->getSession()->get($this->provider . '/' . $key);
70
    }
71
}
72