Caridea\Validate\Rule\Timezone

Complexity

Total Complexity

5

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	apply()	0	7	3
A	timezone()	0	4	1
A	__construct()	0	4	1

<?php
declare(strict_types=1);
/**
 * Caridea
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 * @copyright 2015-2018 LibreWorks contributors
 * @license   Apache-2.0
 */
namespace Caridea\Validate\Rule;

/**
 * Tests strings as valid timezone identifier.
 *
 * @copyright 2015-2018 LibreWorks contributors
 * @license   Apache-2.0
 */
class Timezone implements \Caridea\Validate\Rule
{
    /**
     * @var array The comparison value
     */
    private $zones;

    /**
     * Creates a new Timezone Rule.
     */
    protected function __construct()
    {
        $this->zones = timezone_identifiers_list(\DateTimeZone::ALL_WITH_BC);
    }

    /**
     * {@inheritDoc}
     */
    public function apply($value, $data = []): ?array
    {
        if (!is_string($value)) {
            return ['FORMAT_ERROR'];
        }
        return in_array($value, $this->zones, true) ? null : ['WRONG_TIMEZONE'];
    }

    /**
     * Gets a rule that tests a string as a valid timezone.
     *
     * @return \Caridea\Validate\Rule\Timezone the created rule
     */
    public static function timezone(): Timezone
    {
        return new Timezone();
    }
}