<?php declare(strict_types=1);

namespace App\Komma\Globalization;


use Illuminate\Support\Collection;

/**
 * Class RegionInfo
 *
 * Contains information about the country/region.
 * Inspired on the RegionInfo class from C#
 *
 * @see https://docs.microsoft.com/en-us/dotnet/api/system.globalization.regioninfo?view=netframework-4.7.2
 * @package App\Komma\Globalization
 */
interface RegionInfoInterface
{
    /**
     * Parses the region name. It must either be a two-letter region name, such as "US" for the United States,
     * or the name of a specific culture, such as "en-US" for English (United States)
     *
     * @param string $name
     */
    function parseName(string $name);

    /**
     *  Returns the neutral region (the one not associated to a language
     */
    public function getNeutralRegionInfo(): RegionInfoInterface;

    /**
     * Find one or more regionInfo's by a certain where statement
     *
     * @param $name
     * @param $operator
     * @param $value
     * @return Collection|null
     */
    public static function getWhere($name, $operator, $value);

    /**
     * @return string
     */
    public function getDisplayName(): string;

    /**
     * @return string
     */
    public function getNativeName(): string;

    /**
     * @return string
     */
    public function getCurrencyName(): string;

    /**
     * @return string
     */
    public function getCurrencyMinorName(): string;

    /**
     * @return string
     */
    public function getCurrencySymbol(): string;

    /**
     * @return string
     */
    public function getISOCurrencySymbol(): string;

    /**
     * @return bool
     */
    public function isMetric(): bool;

    /**
     * @return string
     */
    public function getThreeLetterISORegionName(): string;

    /**
     * @return string
     */
    public function getTwoLetterISORegionName(): string;

    /**
     * @return string
     */
    public function getName(): string;

    /** @return NumberFormatInfo */
    public function getNumberFormat(): NumberFormatInfo;

    /**
     * @return Collection
     */
    public function getLanguages(): Collection;

    /** @return bool */
    public function isNeutral(): bool;

    /** @return bool */
    public function getNeutral(): bool;
}