File Validator/TimeZone.php | ICanBoogie/Validate v0.1.0

 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Validate\Validator;

use ICanBoogie\Validate\Context;

/**
 * Validates that a value is a valid time zone.
 *
 * **Note:** This class validates _time zone_ such as "Europe/Paris" **NOT** _time zone offsets_
 * such as "+02:00".
 */
class TimeZone extends AbstractValidator
{
    const ALIAS = 'timezone';
    const DEFAULT_MESSAGE = "`{value}` is not a valid time zone, did you mean `{suggestion}`?";

    /**
     * @inheritdoc
     */
    public function validate($value, Context $context)
    {
        $identifiers = timezone_identifiers_list();

        if (in_array($value, $identifiers))
        {
            return true;
        }

        $context->message_args['suggestion'] = $this->find_best_match($value, $identifiers);

        return false;
    }

    /**
     * Find best possible match.
     *
     * @param string $value
     * @param array $identifiers
     *
     * @return string
     */
    protected function find_best_match($value, array $identifiers)
    {
        $matches = array_fill_keys($identifiers, 0);

        foreach ($identifiers as $identifier)
        {
            similar_text($identifier, $value, $matches[$identifier]);
        }

        arsort($matches);

        return key($matches);
    }
}

Namespaces

Classes