NameIdFormat::isTransient()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 0
1
<?php
2
3
/**
4
 * Copyright 2018 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\Profile\Value;
20
21
use OpenConext\Profile\Assert;
22
23
final class NameIdFormat
24
{
25
    const PERSISTENT_IDENTIFIER = 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent';
26
    const TRANSIENT_IDENTIFIER  = 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient';
27
28
    /**
29
     * @var string
30
     */
31
    private $value;
32
33
    /**
34
     * @param string $value
35
     */
36
    public function __construct($value)
37
    {
38
        // A service provider usually always has a NameIDFormat, because it's
39
        // required by the manage web interface.
40
        //
41
        // In practice, programmatically created entities can be saved
42
        // without NameIDFormat. In those cases, we fall back to most likely
43
        // used value by EngineBlock: persistent.
44
        if ($value === null) {
45
            $value = self::PERSISTENT_IDENTIFIER;
46
        }
47
48
        Assert::string($value, 'NameIDFormat "%s" must be a string');
49
50
        $this->value = $value;
51
    }
52
53
    /**
54
     * @return bool
55
     */
56
    public function isPersistent()
57
    {
58
        return $this->value === self::PERSISTENT_IDENTIFIER;
59
    }
60
61
    /**
62
     * @return bool
63
     */
64
    public function isTransient()
65
    {
66
        return $this->value === self::TRANSIENT_IDENTIFIER;
67
    }
68
}
69