TraderInteractive\Filter\TimeOfDayFilter

Complexity

Total Complexity

4

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	filter()	0	11	4

<?php

namespace TraderInteractive\Filter;

use TraderInteractive\Exceptions\FilterException;

final class TimeOfDayFilter
{
    /**
     * @var string
     */
    const NON_EMPTY_STRING_ERROR = 'Value must be a non-empty string';

    /**
     * @var string
     */
    const INCORRECT_FORMAT_ERROR = 'Value must be in the format HH:MM:SS';

    /**
     * @var string
     */
    const TIME_OF_DAY_REGEX = '/^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$/';

    /**
     * Filters a given value as a valid HH:MM:SS formatted string.
     *
     * @param mixed $value the value to be filtered.
     *
     * @return string
     *
     * @throws FilterException Thrown if the value cannot be filtered.
     */
    public static function filter($value) : string
    {
        if (!is_string($value) || trim($value) === '') {
            throw new FilterException(self::NON_EMPTY_STRING_ERROR);
        }

        if (preg_match(self::TIME_OF_DAY_REGEX, $value) === 0) {
            throw new FilterException(self::INCORRECT_FORMAT_ERROR);
        }

        return $value;
    }
}