<?php // phpcs:ignore - @generation-checksum BR-27-5640
/**
 * Country Class for Brazil (BR).
 *
 * State/province count: 27
 * City count: 5640
 * City count per state/province:
 * - MG: 856 cities
 * - SP: 653 cities
 * - RS: 501 cities
 * - BA: 421 cities
 * - PR: 400 cities
 * - SC: 314 cities
 * - GO: 246 cities
 * - PI: 225 cities
 * - PB: 223 cities
 * - MA: 219 cities
 * - PE: 193 cities
 * - CE: 187 cities
 * - RN: 169 cities
 * - PA: 147 cities
 * - MT: 143 cities
 * - TO: 139 cities
 * - AL: 102 cities
 * - RJ: 94 cities
 * - MS: 82 cities
 * - ES: 79 cities
 * - SE: 75 cities
 * - AM: 62 cities
 * - RO: 56 cities
 * - AC: 22 cities
 * - AP: 16 cities
 * - RR: 14 cities
 * - DF: 2 cities
 *
 * @package WP_Ultimo\Country
 * @since 2.0.11
 */

namespace WP_Ultimo\Country;

// Exit if accessed directly
defined('ABSPATH') || exit;

/**
 * Country Class for Brazil (BR).
 *
 * IMPORTANT:
 * This file is generated by build scripts, do not
 * change it directly or your changes will be LOST!
 *
 * @since 2.0.11
 *
 * @property-read string $code
 * @property-read string $currency
 * @property-read int $phone_code
 */
class Country_BR extends Country {

	use \WP_Ultimo\Traits\Singleton;

	/**
	 * General country attributes.
	 *
	 * This might be useful, might be not.
	 * In case of doubt, keep it.
	 *
	 * @since 2.0.11
	 * @var array
	 */
	protected $attributes = array(
		'country_code' => 'BR',
		'currency'     => 'BRL',
		'phone_code'   => 55,
	);

	/**
	 * The type of nomenclature used to refer to the country sub-divisions.
	 *
	 * @since 2.0.11
	 * @var string
	 */
	protected $state_type = 'state';

	/**
	 * Return the country name.
	 *
	 * @since 2.0.11
	 * @return string
	 */
	public function get_name() {

		return __('Brazil', 'wp-ultimo-locations');

	} // end get_name;

	/**
	 * Returns the list of states for BR.
	 *
	 * @since 2.0.11
	 * @return array The list of state/provinces for the country.
	 */
	protected function states() {

		return array(
			'AC' => __('Acre', 'wp-ultimo-locations'),
			'AL' => __('Alagoas', 'wp-ultimo-locations'),
			'AP' => __('Amapá', 'wp-ultimo-locations'),
			'AM' => __('Amazonas', 'wp-ultimo-locations'),
			'BA' => __('Bahia', 'wp-ultimo-locations'),
			'CE' => __('Ceará', 'wp-ultimo-locations'),
			'DF' => __('Distrito Federal', 'wp-ultimo-locations'),
			'ES' => __('Espírito Santo', 'wp-ultimo-locations'),
			'GO' => __('Goiás', 'wp-ultimo-locations'),
			'MA' => __('Maranhão', 'wp-ultimo-locations'),
			'MT' => __('Mato Grosso', 'wp-ultimo-locations'),
			'MS' => __('Mato Grosso do Sul', 'wp-ultimo-locations'),
			'MG' => __('Minas Gerais', 'wp-ultimo-locations'),
			'PR' => __('Paraná', 'wp-ultimo-locations'),
			'PB' => __('Paraíba', 'wp-ultimo-locations'),
			'PA' => __('Pará', 'wp-ultimo-locations'),
			'PE' => __('Pernambuco', 'wp-ultimo-locations'),
			'PI' => __('Piauí', 'wp-ultimo-locations'),
			'RN' => __('Rio Grande do Norte', 'wp-ultimo-locations'),
			'RS' => __('Rio Grande do Sul', 'wp-ultimo-locations'),
			'RJ' => __('Rio de Janeiro', 'wp-ultimo-locations'),
			'RO' => __('Rondônia', 'wp-ultimo-locations'),
			'RR' => __('Roraima', 'wp-ultimo-locations'),
			'SC' => __('Santa Catarina', 'wp-ultimo-locations'),
			'SE' => __('Sergipe', 'wp-ultimo-locations'),
			'SP' => __('São Paulo', 'wp-ultimo-locations'),
			'TO' => __('Tocantins', 'wp-ultimo-locations'),
		);

	} // end states;

} // end class Country_BR;
