Passed
Pull Request — main (#557)
by Johan
10:16 queued 05:20
created

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
declare(strict_types=1);
4
5
/**
0 ignored issues
show
Coding Style introduced by
The file-level docblock must follow the opening PHP tag in the file header
Loading history...
6
 * Copyright 2016 SURFnet B.V.
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
 */
20
21
namespace Surfnet\StepupMiddleware\ApiBundle\Doctrine\Type;
22
23
use Doctrine\DBAL\Platforms\AbstractPlatform;
24
use Doctrine\DBAL\Types\ConversionException;
25
use Doctrine\DBAL\Types\Type;
26
use Surfnet\Stepup\Configuration\Value\Location;
27
use Surfnet\Stepup\Exception\InvalidArgumentException;
28
use TypeError;
29
30
/**
31
 * Custom Type for the Location Value Object for the Configuration domain
32
 */
33
class ConfigurationLocationType extends Type
34
{
35
    public const NAME = 'stepup_configuration_location';
36
37
    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
38
    {
39
        return $platform->getClobTypeDeclarationSQL($column);
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 Location) {
49
            throw new ConversionException(
50
                sprintf(
51
                    "Encountered illegal location of type %s '%s', expected a Location instance",
52
                    get_debug_type($value),
53
                    is_scalar($value) ? (string)$value : '',
54
                ),
55
            );
56
        }
57
58
        return $value->getLocation();
59
    }
60
61
    public function convertToPHPValue($value, AbstractPlatform $platform): ?Location
62
    {
63
        if (is_null($value)) {
64
            return null;
65
        }
66
67
        try {
68
            $location = new Location($value);
69
        } catch (InvalidArgumentException|TypeError $e) {
0 ignored issues
show
Coding Style introduced by
Expected at least 1 space before "|"; 0 found
Loading history...
Coding Style introduced by
Expected at least 1 space after "|"; 0 found
Loading history...
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 $location;
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