TxTextControl\ReportingCloud\Assert\AssertCultureTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	assertCulture()	0	7	2
A	getCultures()	0	5	1
A	getCulturesFilename()	0	6	1

<?php
declare(strict_types=1);

/**
 * ReportingCloud PHP Wrapper
 *
 * PHP wrapper for ReportingCloud Web API. Authored and supported by Text Control GmbH.
 *
 * @link      https://www.reporting.cloud to learn more about ReportingCloud
 * @link      https://github.com/TextControl/txtextcontrol-reportingcloud-php for the canonical source repository
 * @license   https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-php/master/LICENSE.md
 * @copyright © 2019 Text Control GmbH
 */

namespace TxTextControl\ReportingCloud\Assert;

/**
 * Trait AssertLanguageTrait
 *
 * @package TxTextControl\ReportingCloud
 * @author  Jonathan Maron (@JonathanMaron)
 */
trait AssertCultureTrait
{
    /**
     * Validate culture
     *
     * @param string $value
     * @param string $message
     *
     * @return null
     * @throws \TxTextControl\ReportingCloud\Exception\InvalidArgumentException
     */
    public static function assertCulture(string $value, string $message = '')
    {
        $haystack = self::getCultures();
        $format   = $message ?: '%s contains an unsupported culture';
        $message  = sprintf($format, self::valueToString($value));

        return self::oneOf($value, $haystack, $message);
    }

    /**
     * Return the filename, containing cultures array
     *
     * @return string
     */
    public static function getCulturesFilename(): string
    {
        $filename = __DIR__ . '/../../data/cultures.php';
        $filename = realpath($filename);

        return $filename;
    }

    /**
     * Return cultures array
     *
     * @return array
     */
    private static function getCultures(): array
    {
        $filename = self::getCulturesFilename();

        return include $filename;
    }
}