Cycle\Schema\Exception\TableInheritance\DiscriminatorColumnNotPresentException

Complexity

Total Complexity

3

Size/Duplication

Total Lines	24
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getSolution()	0	9	1
A	getName()	0	3	1
A	__construct()	0	5	1

<?php

declare(strict_types=1);

namespace Cycle\Schema\Exception\TableInheritance;

use Cycle\Schema\Definition\Entity;
use Cycle\Schema\Exception\TableInheritanceException;
use Yiisoft\FriendlyException\FriendlyExceptionInterface;

class DiscriminatorColumnNotPresentException extends TableInheritanceException implements FriendlyExceptionInterface
{
    public function __construct(private Entity $entity)
    {
        parent::__construct(sprintf(
            'Discriminator column for the `%s` role should be defined.',
            (string) ($this->entity->getRole() ?? $this->entity->getClass()),
        ));
    }

    public function getName(): string
    {
        return 'Discriminator column is not present.';
    }

    public function getSolution(): ?string
    {
        $fields = implode('`, `', $this->entity->getFields()->getNames());

        return sprintf(
            "Discriminator column is required for Single Table Inheritance schema.\n" .
            'You have to specify one of the defined fields of the `%s` role: `%s`',
            (string) ($this->entity->getRole() ?? $this->entity->getClass()),
            $fields,
        );
    }
}