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

InstitutionType::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 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\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\Exception\InvalidArgumentException;
25
use Surfnet\Stepup\Identity\Value\Institution;
26
27
/**
28
 * Custom Type for the Institution Value Object
29
 */
30
class InstitutionType extends Type
31
{
32
    public const NAME = 'institution';
33
34
    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
35
    {
36
        if (!isset($column['length'])) {
37
            $column['length'] = 255;
38
        }
39
40
        return $platform->getStringTypeDeclarationSQL($column);
41
    }
42
43
    public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string
44
    {
45
        if (is_null($value)) {
46
            return null;
47
        }
48
49
        return (string)$value;
50
    }
51
52
    public function convertToPHPValue($value, AbstractPlatform $platform): ?Institution
53
    {
54
        if (is_null($value)) {
55
            return null;
56
        }
57
58
        try {
59
            $institution = new Institution($value);
60
        } catch (InvalidArgumentException $e) {
61
            // get nice standard message, so we can throw it keeping the exception chain
62
            $doctrineExceptionMessage = ConversionException::conversionFailed(
63
                $value,
64
                $this->getName(),
65
            )->getMessage();
66
67
            throw new ConversionException($doctrineExceptionMessage, 0, $e);
68
        }
69
70
        return $institution;
71
    }
72
73
    public function getName(): string
74
    {
75
        return self::NAME;
76
    }
77
78
    public function requiresSQLCommentHint(AbstractPlatform $platform): bool
79
    {
80
        return false;
81
    }
82
}
83