Passed
Push — feature/updates-nov25 ( 8eba28...986d8f )
by Johan
15:38 queued 09:59
created

RaLocationNameType::requiresSQLCommentHint()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 1
dl 0
loc 3
rs 10
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * Copyright 2016 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 Surfnet\StepupMiddleware\ApiBundle\Doctrine\Type;
20
21
use Doctrine\DBAL\Platforms\AbstractPlatform;
22
use Doctrine\DBAL\Types\ConversionException;
23
use Doctrine\DBAL\Types\Type;
24
use Surfnet\Stepup\Configuration\Value\RaLocationName;
25
use Surfnet\Stepup\Exception\InvalidArgumentException;
26
27
/**
28
 * Custom Type for the RaLocationName Value Object
29
 */
30
class RaLocationNameType extends Type
31
{
32
    public const NAME = 'stepup_ra_location_name';
33
34
    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
35
    {
36
        $clearColumn = [];
37
        $clearColumn['length'] = 255;
38
39
        return $platform->getStringTypeDeclarationSQL($clearColumn);
40
    }
41
42
    public function convertToDatabaseValue($value, AbstractPlatform $platform): mixed
43
    {
44
        if (is_null($value)) {
45
            return null;
46
        }
47
48
        if (!$value instanceof RaLocationName) {
49
            throw new ConversionException(
50
                sprintf(
51
                    "Encountered illegal RA location name of type %s '%s', expected a RaLocationName instance",
52
                    get_debug_type($value),
53
                    is_scalar($value) ? (string)$value : '',
54
                ),
55
            );
56
        }
57
58
        return $value->getRaLocationName();
59
    }
60
61
    public function convertToPHPValue($value, AbstractPlatform $platform): ?RaLocationName
62
    {
63
        if (is_null($value)) {
64
            return null;
65
        }
66
67
        try {
68
            $raLocationName = new RaLocationName($value);
69
        } catch (InvalidArgumentException $e) {
70
            // get nice standard message, so we can throw it keeping the exception chain
71
            $doctrineExceptionMessage = ConversionException::conversionFailed(
72
                $value,
73
                $this->getName(),
74
            )->getMessage();
75
76
            throw new ConversionException($doctrineExceptionMessage, 0, $e);
77
        }
78
79
        return $raLocationName;
80
    }
81
82
    public function getName(): string
83
    {
84
        return self::NAME;
85
    }
86
87
    public function requiresSQLCommentHint(AbstractPlatform $platform): bool
88
    {
89
        return false;
90
    }
91
}
92