Spatie\ModelStates\Exceptions\FieldDoesNotExtendState

Complexity

Total Complexity

5

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	make()	0	7	1
A	setField()	0	6	1
A	setExpectedStateClass()	0	6	1
A	setActualClass()	0	6	1
A	getSolution()	0	8	1

<?php

namespace Spatie\ModelStates\Exceptions;

use Facade\IgnitionContracts\Solution;
use Facade\IgnitionContracts\BaseSolution;
use Facade\IgnitionContracts\ProvidesSolution;

class FieldDoesNotExtendState extends InvalidConfig implements ProvidesSolution
{
    /** @var string */
    protected $field;

    /** @var string */
    protected $expectedStateClass;

    /** @var string */
    protected $actualClass;

    public static function make(string $field, string $expectedStateClass, string $actualClass): self
    {
        return (new static("State field `{$field}` expects state to be of type `{$expectedStateClass}`, instead got `{$actualClass}`"))
            ->setField($field)
            ->setExpectedStateClass($expectedStateClass)
            ->setActualClass($actualClass);
    }

    public function setField(string $field): self
    {
        $this->field = $field;

        return $this;
    }

    public function setExpectedStateClass(string $expectedStateClass): self
    {
        $this->expectedStateClass = $expectedStateClass;

        return $this;
    }

    public function setActualClass(string $actualClass): self
    {
        $this->actualClass = $actualClass;

        return $this;
    }

    public function getSolution(): Solution
    {
        return BaseSolution::create("State field `{$this->field}` is the wrong type")
            ->setSolutionDescription("Make sure that states for state field `{$this->field}` extend `{$this->expectedStateClass}`, not `{$this->actualClass}`")
            ->setDocumentationLinks([
                'Configuring states' => 'https://docs.spatie.be/laravel-model-states/v1/working-with-states/01-configuring-states/'
            ]);
    }
}