TypedArrays\Exceptions\GuardException

Complexity

Total Complexity

5

Size/Duplication

Total Lines	25
Duplicated Lines	0 %

Test Coverage

Coverage

80%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	keysRequiredInMap()	0	3	1
A	keysNotAllowedInList()	0	3	1
A	invalidEnforceType()	0	3	1
A	invalidCollectionType()	0	3	1
A	immutableCannotMutate()	0	3	1

<?php

declare(strict_types=1);

namespace TypedArrays\Exceptions;

use Exception;

final class GuardException extends Exception
{
    public static function invalidCollectionType(string $collectionType): self
    {
        return new self("Only available options: array, map or list. Selected: $collectionType");
    }

    public static function invalidEnforceType(string $typeToEnforce): self
    {
        return new self("TypedArrays objects can only enforce scalars and objects. Tried to enforce: $typeToEnforce");
    }

    public static function keysNotAllowedInList(): self
    {
        return new self('This TypedArray object is a list and can not have keys.');
    }

    public static function keysRequiredInMap(): self
    {
        return new self('This TypedArray object is a map and must have keys.');
    }

    public static function immutableCannotMutate(): self
    {
        return new self('This TypedArray object is immutable.');
    }
}