Spatie\ModelStates\Exceptions\ClassDoesNotExtendBaseClass

Complexity

Total Complexity

5

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setClass()	0	5	1
A	make()	0	5	1
A	setBaseClass()	0	5	1
A	getSolution()	0	9	2

<?php

namespace Spatie\ModelStates\Exceptions;

use Facade\IgnitionContracts\BaseSolution;
use Facade\IgnitionContracts\ProvidesSolution;
use Facade\IgnitionContracts\Solution;
use Illuminate\Support\Str;

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

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

    public static function make(string $class, string $baseClass): self
    {
        return (new static("Class {$class} does not extend the `{$baseClass}` base class."))
            ->setClass($class)
            ->setBaseClass($baseClass);
    }

    public function setClass(string $class): self
    {
        $this->class = $class;

        return $this;
    }

    public function setBaseClass(string $baseClass): self
    {
        $this->baseClass = $baseClass;

        return $this;
    }

    public function getSolution(): Solution
    {
        $documentationLinks = Str::endsWith($this->baseClass, 'State')
            ? ['Configuring states' => 'https://docs.spatie.be/laravel-model-states/v1/working-with-states/01-configuring-states/']
            : ['Custom transition classes' => 'https://docs.spatie.be/laravel-model-states/v1/working-with-transitions/02-custom-transition-classes/'];

        return BaseSolution::create('')
            ->setSolutionDescription("Make sure that `{$this->class}` extends `{$this->baseClass}`")
            ->setDocumentationLinks($documentationLinks);
    }
}