Surfnet\StepupMiddleware\ApiBundle\Doctrine\Type\DocumentNumberType

Complexity

Total Complexity

8

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1
A	convertToDatabaseValue()	0	17	4
A	getSQLDeclaration()	0	3	1
A	convertToPHPValue()	0	7	2

<?php

declare(strict_types=1);

/**
 * Copyright 2014 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Missing @link tag in file comment

namespace Surfnet\StepupMiddleware\ApiBundle\Doctrine\Type;

use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Types\ConversionException;
use Doctrine\DBAL\Types\Type;
use Surfnet\Stepup\Exception\InvalidArgumentException;
use Surfnet\Stepup\Identity\Value\DocumentNumber;

/**
 * Custom Type for the Surfnet\Stepup\Identity\Value\DocumentNumber Object
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class DocumentNumberType extends Type
{
    public const NAME = 'stepup_document_number';

    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
    {
        return $platform->getVarcharTypeDeclarationSQL($column);

The function Doctrine\DBAL\Platforms\AbstractPlatform::getVarcharTypeDeclarationSQL() has been deprecated: Use {@link getStringTypeDeclarationSQL()} instead.

    }

    /**

Parameter $value should have a doc-comment as per coding-style.

Parameter $platform should have a doc-comment as per coding-style.

     * @throws ConversionException
     */

Missing @return tag in function comment

    public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string
    {
        if (is_null($value)) {
            return null;
        }

        if (!$value instanceof DocumentNumber) {
            throw new ConversionException(
                sprintf(
                    "Encountered illegal document number of type %s '%s', expected a DocumentNumber instance",
                    get_debug_type($value),
                    is_scalar($value) ? (string)$value : '',
                ),
            );
        }

        return $value->getDocumentNumber();
    }

    /**

Parameter $value should have a doc-comment as per coding-style.

Parameter $platform should have a doc-comment as per coding-style.

     * @throws InvalidArgumentException
     */

Missing @return tag in function comment

    public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?DocumentNumber
    {
        if (is_null($value)) {
            return null;
        }

        return new DocumentNumber($value);
    }

    public function getName(): string
    {
        return self::NAME;
    }
}