Fusion\Collection\CollectionValidator

Complexity

Total Complexity

14

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	notAcceptedType()	0	3	1
A	validateValueIsAcceptedType()	0	11	3
A	validateNonNullValue()	0	5	2
A	validateIntValue()	0	10	2
A	validateNonEmptyAcceptedType()	0	5	2
A	validateStringValue()	0	5	2
A	validateOffsetExists()	0	5	2

<?php

/**
 * Part of the Fusion.Collection package.
 *
 * @license MIT
 */

declare(strict_types=1);

namespace Fusion\Collection;

use Fusion\Collection\Contracts\AbstractCollection;
use Fusion\Collection\Contracts\CollectionValidationInterface;
use Fusion\Collection\Exceptions\CollectionException;

/**
 * Library-provided implementation of the `CollectionValidationInterface`.
 *
 * @since 2.0.0
 */
class CollectionValidator implements CollectionValidationInterface
{
    /** {@inheritdoc} */
    public function validateNonNullValue($value): void
    {
        if ($value === null)
        {
            throw new CollectionException('Collection operations will not accept null values.');
        }
    }

    /** {@inheritdoc} */
    public function validateOffsetExists($offset, AbstractCollection $collection): void
    {
        if ($collection->offsetExists($offset) === false)
        {
            throw new CollectionException("The key or index '$offset' does not exist in the collection.");
        }
    }

    /** {@inheritdoc} */
    public function validateIntValue($value): void
    {
        if (is_int($value) === false)
        {
            $message = sprintf(
                'Collection offset type must be an integer. %s given.',
                gettype($value)
            );

            throw new CollectionException($message);
        }
    }

    /** {@inheritdoc} */
    public function validateStringValue($value): void
    {
        if (is_string($value) === false)
        {
            throw new CollectionException('Offset to access must be a string.');
        }
    }

    /** {@inheritdoc} */
    public function validateNonEmptyAcceptedType(string $acceptedType): void
    {
        if ($acceptedType == '')
        {
            throw new CollectionException('Accepted type string cannot be empty.');
        }
    }

    /** {@inheritdoc} */
    public function validateValueIsAcceptedType($value, string $acceptedType): void
    {
        if ($this->notAcceptedType($value, $acceptedType))
        {
            $message = sprintf(
                'Unable to modify collection. Only instances of type "%s" are allowed. Type "%s" given.',
                $acceptedType,
                is_object($value) ? get_class($value) : gettype($value)
            );

            throw new CollectionException($message);
        }
    }

    /** {@inheritdoc} */
    private function notAcceptedType($value, string $acceptedType)
    {
        return ($value instanceof $acceptedType) === false;
    }
}