Stratadox\ImmutableCollection\NoSuchValue

Complexity

Total Complexity

2

Size/Duplication

Total Lines	21
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	noneOfTheValuesMatched()	0	5	1
A	couldNotFind()	0	6	1

<?php

namespace Stratadox\ImmutableCollection;

use function get_class;
use function sprintf;
use Stratadox\Collection\Collection;
use Stratadox\Collection\NotFound;
use Stratadox\Collection\Searchable;
use UnexpectedValueException;
use function var_export;

/**
 * Exception to notify the client code that the requested value does not exist.
 *
 * In order to prevent this exception from being thrown, client code can usually
 * implement a method like @see Searchable::has() to be certain that the value
 * actually exists.
 * When looking for an object by reference, use @see Searchable::hasThe() instead.
 *
 * @package Stratadox\Collection
 * @author  Stratadox
 */
final class NoSuchValue extends UnexpectedValueException implements NotFound
{
    /**
     * @param Collection $collection The collection that does not have the item.
     * @param mixed      $theValue   The value that was not found.
     * @return NotFound              The exception object to throw.
     */
    public static function couldNotFind(Collection $collection, $theValue): NotFound
    {
        return new static(sprintf(
            'Could not find %s in %s',
            var_export($theValue, true),
            get_class($collection)
        ));
    }

    public static function noneOfTheValuesMatched(Collection $collection): self
    {
        return new self(sprintf(
            'Could not find any accepted item in the %s.',
            get_class($collection)
        ));
    }
}