Completed
Pull Request — master (#24)
by Travis
01:27
created

InvalidConfig::unknownState()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 6
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 2
1
<?php
2
3
namespace Spatie\ModelStates\Exceptions;
4
5
use Exception;
6
use Spatie\ModelStates\State;
7
use Spatie\ModelStates\HasStates;
8
use Spatie\ModelStates\Transition;
9
use Illuminate\Database\Eloquent\Model;
10
11
class InvalidConfig extends Exception
12
{
13
    public static function unknownState(string $field, Model $model): InvalidConfig
14
    {
15
        $modelClass = get_class($model);
16
17
        return new self("No state field found for {$modelClass}::{$field}, did you forget to provide a mapping in {$modelClass}::registerStates()?");
18
    }
19
20
    public static function fieldDoesNotExtendState(string $field, string $expectedStateClass, string $actualClass): InvalidConfig
21
    {
22
        return new self("State field `{$field}` expects state to be of type `{$expectedStateClass}`, instead got `{$actualClass}`");
23
    }
24
25
    public static function doesNotExtendState(string $class): InvalidConfig
26
    {
27
        return self::doesNotExtendBaseClass($class, State::class);
28
    }
29
30
    public static function doesNotExtendTransition(string $class): InvalidConfig
31
    {
32
        return self::doesNotExtendBaseClass($class, Transition::class);
33
    }
34
35
    public static function doesNotExtendBaseClass(string $class, string $baseClass): InvalidConfig
36
    {
37
        return new self("Class {$class} does not extend the `{$baseClass}` base class.");
38
    }
39
40
    public static function resolveTransitionNotFound(Model $model): InvalidConfig
41
    {
42
        $modelClass = get_class($model);
43
44
        $trait = HasStates::class;
45
46
        return new self("The method `resolveTransition` was not found on model `{$modelClass}`, are you sure it uses the `{$trait} trait?`");
47
    }
48
}
49