Rinvex Countries

https://github.com/rinvex/countries
Admin
Rinvex Countries is a simple and lightweight PHP package for retrieving comprehensive and flexible...
Tokens:55,675
Snippets:394
Trust Score:9.6
License:MIT
Update:3 days ago
Show doc for...
Tokens:
Raw
### Usage example for set(), get(), and setAttributes()

Source: https://github.com/rinvex/countries

Demonstrates fluent setting, nested get with fallback, retrieving the whole array, and clearing attributes. The get() method returns 'Africa' for 'geo.region', 'fallback' for a missing key, and the full array when null is passed.

```php
$egypt = country('eg');
$egypt->set('custom_key', 'x')->set('flag_note', 'shared');
echo $egypt->get('geo.region');      // Africa
echo $egypt->get('geo.missing', 'fallback'); // fallback
var_export($egypt->get(null));       // the whole array
$egypt->setAttributes([]);           // replaces everything
```

--------------------------------

### Install and use Rinvex Country with Country model

Source: https://github.com/rinvex/countries/wiki/Home

Install via Composer and use the Country model to find countries by ISO code, attribute, or retrieve all countries. Supports selecting specific attributes and Laravel Collections for plucking values.

```bash
composer require rinvex/country
```

```php
use Rinvex\Country\Models\Country;

// Find a country by it's ISO 3166-1 alpha-2
$egypt = (new Country)->find('EG');

// Find a country by one of it's attributes
$usa = (new Country)->findBy('capital', 'Washington D.C.');

// Find all countries
$countries = (new Country)->findAll();

// Retrieve only `name`, `demonym`, and `currency` attributes of "Japan":
$japan = (new Country)->find('JP', ['name', 'demonym', 'currency']);

// Utilize Laravel Collections to get an array of all country names, with their 'iso_3166_1_alpha2' as the array keys
(new Country)->findAll()->pluck('name.common', 'iso_3166_1_alpha2');
```

--------------------------------

### currencies() usage examples

Source: https://github.com/rinvex/countries

Examples of using the currencies() helper. With default returns currency code keys; with true returns full currency detail arrays. Shows accessing currency name from the full array.

```php
$codes = currencies();                     // ['AED' => 'AED', 'EGP' => 'EGP', ...]
$full  = currencies(true);                 // ['EGP' => ['iso_4217_code' => 'EGP', ...], ...]
echo $full['EGP']['iso_4217_name'];        // Egyptian Pound
```

--------------------------------

### Find country with specific attributes using find method

Source: https://github.com/rinvex/countries/wiki/3)-Usage

All find* methods have an optional parameter for retrieved columns/attributes. This example retrieves only the name, demonym, and currency attributes of Japan.

```php
$japan = (new Country)->find('JP', ['name', 'demonym', 'currency']);
```

--------------------------------

### Extra accessor usage example

Source: https://github.com/rinvex/countries

Shows how to retrieve extra codes and metadata for a country using the country() helper. The example uses Egypt and prints the emoji, FIFA code, geoname ID, and address format, and checks if VAT rates are null.

```php
$egypt = country('eg');
echo $egypt->getEmoji();       // 🇪🇬
echo $egypt->getFifa();        // EGY
echo $egypt->getGeonameid();   // 357994
echo $egypt->getAddressFormat(); // "{{recipient}}\n{{street}}\n{{postalcode}} {{city}}\n{{country}}"
if ($egypt->getVatRates() === null) {
    // Egypt has no VAT rates in the dataset
}
```

--------------------------------

### Dialling accessor usage example

Source: https://github.com/rinvex/countries

Shows how to retrieve dialling data for a country using the country() helper. The example uses Egypt and prints the calling code, national prefix, international prefix, and national number length.

```php
$egypt = country('eg');
echo $egypt->getCallingCode();  // 20
echo $egypt->getNationalPrefix(); // 0
echo $egypt->getInternationalPrefix(); // 00
echo $egypt->getNationalNumberLength(); // 9
```

--------------------------------

### Currency accessor usage example

Source: https://github.com/rinvex/countries

Example using country('eg') to fetch the Egyptian currency. getCurrency('egp') uppercases the code internally and returns the EGP object; getCurrencies() returns the full map.

```php
$egypt = country('eg');
print_r($egypt->getCurrency('egp')); // uppercased internally -> EGP object
// ["iso_4217_code" => "EGP", "iso_4217_numeric" => 818,
//  "iso_4217_name" => "Egyptian Pound", "iso_4217_minor_unit" => 2]
print_r($egypt->getCurrencies());    // ["EGP" => [...same object...]]
```

--------------------------------

### countries() usage examples

Source: https://github.com/rinvex/countries

Examples of using the countries() helper. With default parameters returns 250 flat arrays; with $longlist and $hydrate true returns Country objects. Shows accessing data from both return types.

```php
$all = countries();                       // 250 flat arrays
echo $all['eg']['name'];                  // Egypt

$all = countries(true, true);             // 250 Country objects
echo $all['de']->getCapital();            // Berlin
```

--------------------------------

### Find all countries using findAll method

Source: https://github.com/rinvex/countries/wiki/3)-Usage

The findAll method finds all countries and returns a collection of all results.

```php
$countries = (new Country)->findAll();
```

--------------------------------

### getCurrency()

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns the primary currency information for the country.

```APIDOC
## getCurrency()

### Description
Returns the primary currency information for the country.

### Method
`getCurrency()`

### Return Value
Object with currency details (ISO code, numeric, name, minor unit).

### Example
```php
// {"iso_4217_code":"EGP","iso_4217_numeric":818,"iso_4217_name":"Egyptian Pound","iso_4217_minor_unit":2}
$egypt->getCurrency();
```
```

--------------------------------

### country() usage examples

Source: https://github.com/rinvex/countries

Examples of using the country() helper. With $hydrate true (default) returns a Country object; with false returns a raw array. The code shows accessing properties on both return types.

```php
$egypt = country('eg');            // Country object
echo $egypt->getOfficialName();    // Arab Republic of Egypt

$raw = country('us', false);       // raw array
echo $raw['name']['common'];       // United States of America
```

--------------------------------

### Prerequisites for rinvex/countries

Source: https://github.com/rinvex/countries/wiki/1)-Installation

Required PHP version and illuminate/support package versions for compatibility with Laravel 5.1.*, 5.2.*, and 5.3.*.

```json
{
  "php": ">=5.5.9",
  "illuminate/support": "5.1.*|5.2.*|5.3.*"
}
```

--------------------------------

### where() usage examples

Source: https://github.com/rinvex/countries

Demonstrates two-argument implicit '=' operator and three-argument explicit operators. Includes continent, area, capital, landlocked, and dialling length filters with expected results.

```php
use Rinvex\Country\CountryLoader;

// Two-argument form: implicit '=' operator
$oceania = CountryLoader::where('geo.continent', ['OC' => 'Oceania']);
// -> 27 countries: as, au, ck, fj, fm, gu, ki, mh, mp, nc, nf, nu, nr, nz, pn, pw, pg, pf, sb, tk, tl, to, tv, um, vu, wf, ws

// Three-argument form with explicit operator
$big = CountryLoader::where('geo.area', '>', 12345678);   // ['aq', 'ru']
$exact = CountryLoader::where('capital', '==', 'Cairo');   // Egypt
$strict = CountryLoader::where('geo.landlocked', '!==', false); // 47 countries
$shortCodes = CountryLoader::where('dialling.national_number_lengths.0', '<', 5);
```

--------------------------------

### Usage example for file-backed accessors

Source: https://github.com/rinvex/countries

Shows how to use getGeoJson(), getFlag(), getDivision(), and getDivisions() with a country instance. Demonstrates that getFlag() returns null because the flags resource is not shipped, and that getDivision() returns a record with name and geo data.

```php
$egypt = country('eg');
echo $egypt->getGeoJson();  // {"type":"FeatureCollection","features":[...]}
echo $egypt->getFlag();     // null (flags resource not shipped)

$alex = $egypt->getDivision('ALX');
echo $alex['name'];                 // Al Iskandariyah
echo $alex['geo']['latitude'];      // 31.2000924

if (($divisions = $egypt->getDivisions()) !== null) {
    echo count($divisions);         // 27 governorates for Egypt
}
```

--------------------------------

### getCurrencies()

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns all currencies associated with the country.

```APIDOC
## getCurrencies()

### Description
Returns all currencies associated with the country.

### Method
`getCurrencies()`

### Return Value
Object mapping currency codes to currency detail objects.

### Example
```php
// {"EGP":{"iso_4217_code":"EGP","iso_4217_numeric":818,"iso_4217_name":"Egyptian Pound","iso_4217_minor_unit":2}}
$egypt->getCurrencies();
```
```

--------------------------------

### Language accessor usage example

Source: https://github.com/rinvex/countries

Example using country('eg') to fetch Egyptian language data. getLanguage('ARA') lowercases the code internally and returns 'Arabic'; getLanguage() without arguments returns the first language; getLanguages() returns the full map.

```php
$egypt = country('eg');
echo $egypt->getLanguage('ARA');  // Arabic (lowercased internally)
echo $egypt->getLanguage();       // Arabic (first language)
print_r($egypt->getLanguages());  // ["ara" => "Arabic"]
```

--------------------------------

### Retrieve country details and list countries with Rinvex Country

Source: https://github.com/rinvex/countries/blob/master/README.md

Install with `composer require rinvex/countries`. The first block shows how to fetch a single country by its ISO alpha-2 code and access attributes like name, native name, official name, ISO code, area, borders, currencies, languages, emoji, and flag. The second block demonstrates retrieving all countries and using `\Rinvex\Country\CountryLoader::where()` to filter countries by continent (e.g., Oceania). Requires PHP ^8.1.

```php
// Get single country
$egypt = country('eg');

// Get country name                                 // Get country native name
echo $egypt->getName();                             echo $egypt->getNativeName();

// Get country official name                        // Get country ISO 3166-1 alpha2 code
echo $egypt->getOfficialName();                     echo $egypt->getIsoAlpha2();

// Get country area                                 // Get country borders
echo $egypt->getArea();                             echo $egypt->getBorders();

// Get country currencies                           // Get country languages
echo $egypt->getCurrencies();                       echo $egypt->getLanguages();

// Get country emoji                                // Get country flag
echo $egypt->getEmoji();                            echo $egypt->getFlag();
```

```php
// Get all countries                                // Get countries with where condition (continent: Oceania)
$countries = countries();                           $whereCountries = \Rinvex\Country\CountryLoader::where('geo.continent', ['OC' => 'Oceania']);
```

--------------------------------

### Usage example for country accessors

Source: https://github.com/rinvex/countries

Shows how to call the accessors on a country instance obtained via the country() helper. The output demonstrates typical values for Egypt, including native names and TLDs.

```php
$egypt = country('eg');
echo $egypt->getName();                 // Egypt
echo $egypt->getOfficialName();         // Arab Republic of Egypt
echo $egypt->getNativeName('ara');      // مصر
echo $egypt->getNativeName();           // مصر (first native)
echo $egypt->getIsoAlpha2();            // EG
echo $egypt->getIsoAlpha3();            // EGY
echo $egypt->getCapital();              // Cairo
echo $egypt->getDemonym();              // Egyptian
print_r($egypt->getTlds());             // [".eg", ".مصر"]
```

--------------------------------

### Retrieve Egypt country data with advanced methods

Source: https://github.com/rinvex/countries/blob/master/README.md

Shows advanced methods on a single country object ($egypt) to retrieve divisions, translations, timezones, locales, currency, geodata, extra info, and a specific division. Comments show example output for each method. Note: single country retrieval returns full details, while all-countries retrieval returns a short-listed result set.

```php
// Divisions returned as array                      // {"official":"جمهورية مصر العربية","common":"مصر"}
$egypt->getDivisions();                             $egypt->getTranslation();

// ['Africa/Cairo']                                 // ['ar_EG']
$egypt->getTimezones();                             $egypt->getLocales();

// Other                                            // {"ara":{"official":"جمهورية مصر العربية","common":"مصر"}}
$egypt->getDataProtection()                         $egypt->getNativeNames();

// {"iso_4217_code":"EGP","iso_4217_numeric":818,"iso_4217_name":"Egyptian Pound","iso_4217_minor_unit":2}
$egypt->getCurrency();

// {"EGP":{"iso_4217_code":"EGP","iso_4217_numeric":818,"iso_4217_name":"Egyptian Pound","iso_4217_minor_unit":2}}
$egypt->getCurrencies();

// {"ara":{"official":"جمهورية مصر العربية","common":"مصر"},"cym":{"official":"Arab Republic of Egypt","common":"Yr Aifft"},"deu":{"official":"Arabische Republik Ägypten","common":"Ägypten"},"fra":{"official":"République arabe d'Égypte","common":"Égypte"},"hrv":{"official":"Arapska Republika Egipat","common":"Egipat"},"ita":{"official":"Repubblica araba d'Egitto","common":"Egitto"},"jpn":{"official":"エジプト·アラブ共和国","common":"エジプト"},"nld":{"official":"Arabische Republiek Egypte","common":"Egypte"},"por":{"official":"República Árabe do Egipto","common":"Egito"},"rus":{"official":"Арабская Республика Египет","common":"Египет"},"spa":{"official":"República Árabe de Egipto","common":"Egipto"},"fin":{"official":"Egyptin arabitasavalta","common":"Egypti"}}
$egypt->getTranslations();

// {"continent":{"AF":"Africa"},"postal_code":true,"latitude":"27 00 N","latitude_dec":"26.756103515625","longitude":"30 00 E","longitude_dec":"29.86229705810547","max_latitude":"31.916667","max_longitude":"36.333333","min_latitude":"20.383333","min_longitude":"24.7","area":1002450,"region":"Africa","subregion":"Northern Africa","world_region":"EMEA","region_code":"002","subregion_code":"015","landlocked":false,"borders":["ISR","LBY","SDN"],"independent":"Yes"}
$egypt->getGeodata();

// {"geonameid":357994,"edgar":"H2","itu":"EGY","marc":"ua","wmo":"EG","ds":"ET","fifa":"EGY","fips":"EG","gaul":40765,"ioc":"EGY","cowc":"EGY","cown":651,"fao":59,"imf":469,"ar5":"MAF","address_format":"{{recipient}}\n{{street}}\n{{postalcode}} {{city}}\n{{country}}","eu_member":null,"data_protection":"Other","vat_rates":null,"emoji":"🇪🇬"}
$egypt->getExtra();

// {"name":"Al Iskandariyah","alt_names":["El Iskandariya","al-Iskandariyah","al-Iskandarīyah","Alexandria","Alexandrie","Alexandria"],"geo":{"latitude":31.2000924,"longitude":29.9187387,"min_latitude":31.1173177,"min_longitude":29.8233701,"max_latitude":31.330904,"max_longitude":30.0864016}}
$egypt->getDivision("ALX");
```

--------------------------------

### getExtra()

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns additional metadata for the country, such as codes and formatting information.

```APIDOC
## getExtra()

### Description
Returns additional metadata for the country, such as codes and formatting information.

### Method
`getExtra()`

### Return Value
Object with extra metadata fields.

### Example
```php
// {"geonameid":357994,"edgar":"H2","itu":"EGY","marc":"ua","wmo":"EG","ds":"ET","fifa":"EGY","fips":"EG","gaul":40765,"ioc":"EGY","cowc":"EGY","cown":651,"fao":59,"imf":469,"ar5":"MAF","address_format":"{{recipient}}\n{{street}}\n{{postalcode}} {{city}}\n{{country}}","eu_member":null,"data_protection":"Other","vat_rates":null,"emoji":"🇪🇬"}
$egypt->getExtra();
```
```

--------------------------------

### getTranslations()

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns translations of the country name in multiple languages.

```APIDOC
## getTranslations()

### Description
Returns translations of the country name in multiple languages.

### Method
`getTranslations()`

### Return Value
Object mapping language codes to translation objects.

### Example
```php
// {"ara":{"official":"جمهورية مصر العربية","common":"مصر"},"cym":{"official":"Arab Republic of Egypt","common":"Yr Aifft"},"deu":{"official":"Arabische Republik Ägypten","common":"Ägypten"},"fra":{"official":"République arabe d'Égypte","common":"Égypte"},"hrv":{"official":"Arapska Republika Egipat","common":"Egipat"},"ita":{"official":"Repubblica araba d'Egitto","common":"Egitto"},"jpn":{"official":"エジプト·アラブ共和国","common":"エジプト"},"nld":{"official":"Arabische Republiek Egypte","common":"Egypte"},"por":{"official":"República Árabe do Egipto","common":"Egito"},"rus":{"official":"Арабская Республика Египет","common":"Египет"},"spa":{"official":"República Árabe de Egipto","common":"Egipto"},"fin":{"official":"Egyptin arabitasavalta","common":"Egypti"}}
$egypt->getTranslations();
```
```

--------------------------------

### Get country attributes with country('eg')

Source: https://github.com/rinvex/countries/blob/master/README.md

Retrieves a Country model instance for Egypt and demonstrates self-descriptive getter methods for attributes such as names, codes, geography, telecommunications, and flags. Each getter returns the corresponding value, with comments showing expected outputs. Use this pattern to access any country's data by its ISO alpha-2 code.

```php
$egypt = country('eg');

// Egypt                                            // مصر
$egypt->getName();                                  $egypt->getNativeName();

// Arab Republic of Egypt                           // جمهورية مصر العربية
$egypt->getOfficialName();                          $egypt->getNativeOfficialName();

// Egyptian                                         // Cairo
$egypt->getDemonym();                               $egypt->getCapital();

// EG                                               // EGY
$egypt->getIsoAlpha2();                             $egypt->getIsoAlpha3();

// 818                                              // .eg
$egypt->getIsoNumeric();                            $egypt->getTld();

// [".eg",".مصر"]                                   // ["EG","Arab Republic of Egypt"]
$egypt->getTlds();                                  $egypt->getAltSpellings();

// Arabic                                           // {"ara":"Arabic"}
$egypt->getLanguage();                              $egypt->getLanguages();

// Africa                                           // true
$egypt->getContinent();                             $egypt->usesPostalCode();

// 27 00 N                                          // 30 00 E
$egypt->getLatitude();                              $egypt->getLongitude();

// 26.756103515625                                  // 29.86229705810547
$egypt->getLatitudeDesc();                          $egypt->getLongitudeDesc();

// 31.916667                                        // 36.333333
$egypt->getMaxLatitude();                           $egypt->getMaxLongitude();

// 20.383333                                        // 24.7
$egypt->getMinLatitude();                           $egypt->getMinLongitude();

// 1002450                                          // Africa
$egypt->getArea();                                  $egypt->getRegion();

// Northern Africa                                  // EMEA
$egypt->getSubregion();                             $egypt->getWorldRegion();

// 002                                              // 015
$egypt->getRegionCode();                            $egypt->getSubregionCode();

// false                                            // ["ISR","LBY","SDN"]
$egypt->isLandlocked();                             $egypt->getBorders();

// Yes                                              // 20
$egypt->isIndependent();                            $egypt->getCallingCode();

// ["20"]                                           // 0
$egypt->getCallingCodes();                          $egypt->getNationalPrefix();

// 9                                                // [9]
$egypt->getNationalNumberLength();                  $egypt->getNationalNumberLengths();

// 2                                                // [2]
$egypt->getNationalDestinationCodeLength();         $egypt->getnationaldestinationcodelengths();

// "00"                                             // {{recipient}}\n{{street}}\n{{postalcode}} {{city}}\n{{country}}
$egypt->getInternationalPrefix();                   $egypt->getAddressFormat();

// 357994                                           // H2
$egypt->getGeonameid();                             $egypt->getEdgar();

// EGY                                              // ua
$egypt->getItu();                                   $egypt->getMarc();

// EG                                               // ET
$egypt->getWmo();                                   $egypt->getDs();

// EGY                                              // EG
$egypt->getFifa();                                  $egypt->getFips();

// 40765                                            // EGY
$egypt->getGaul();                                  $egypt->getIoc();

// EGY                                              // 651
$egypt->getCowc();                                  $egypt->getCown();

// 59                                               // 469
$egypt->getFao();                                   $egypt->getImf();

// MAF                                              // null
$egypt->getAr5();                                   $egypt->isEuMember();

// null                                             // 🇪🇬
$egypt->getVatRates();                              $egypt->getEmoji();

// GeoJson data returned as string                  // SVG data returned as string
$egypt->getGeoJson();                               $egypt->getFlag();
```

--------------------------------

### getNativeNames()

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns the native names of the country in various languages.

```APIDOC
## getNativeNames()

### Description
Returns the native names of the country in various languages.

### Method
`getNativeNames()`

### Return Value
Object mapping language codes to native name objects.

### Example
```php
// {"ara":{"official":"جمهورية مصر العربية","common":"مصر"}}
$egypt->getNativeNames();
```
```

--------------------------------

### countries() usage examples

Source: https://github.com/rinvex/countries

Shows default shortlist access, full longlist records, and hydrated Country objects. Shortlist records lack a 'geo' key; longlist records include official names and geo data.

```php
use Rinvex\Country\CountryLoader;

// Default: shortlist as plain arrays
$all = CountryLoader::countries();
echo $all['eg']['name'];            // Egypt
// Note: shortlist records have no 'geo' key

// Full records
$all = CountryLoader::countries(true);
echo $all['eg']['name']['official']; // Arab Republic of Egypt

// Hydrated Country objects (longlist)
$countries = CountryLoader::countries(true, true);
echo $countries['eg']->getArea();    // 1002450
```

--------------------------------

### Find country by ISO 3166-1 alpha-2 using find method

Source: https://github.com/rinvex/countries/wiki/3)-Usage

The find method finds a country by its ISO 3166-1 alpha-2 code and returns an array of the first result.

```php
$egypt = (new Country)->find('EG');
```

--------------------------------

### get() method signature

Source: https://github.com/rinvex/countries

Retrieves an attribute by key, supporting dot.notation for nested lookup. Returns the default when missing, or the entire array when key is null. Unlike CountryLoader::get(), no wildcard support or object traversal.

```php
public function get($key, mixed $default = null)
```

--------------------------------

### getTimezones()

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns the timezones associated with the country.

```APIDOC
## getTimezones()

### Description
Returns the timezones associated with the country.

### Method
`getTimezones()`

### Return Value
Array of timezone strings.

### Example
```php
// ['Africa/Cairo']
$egypt->getTimezones();
```
```

--------------------------------

### getDataProtection()

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns the data protection status or classification for the country.

```APIDOC
## getDataProtection()

### Description
Returns the data protection status or classification for the country.

### Method
`getDataProtection()`

### Return Value
String or null.

### Example
```php
// Other
$egypt->getDataProtection();
```
```

--------------------------------

### getLocales()

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns the locales (language codes) supported for the country.

```APIDOC
## getLocales()

### Description
Returns the locales (language codes) supported for the country.

### Method
`getLocales()`

### Return Value
Array of locale strings.

### Example
```php
// ['ar_EG']
$egypt->getLocales();
```
```

--------------------------------

### country() exception handling

Source: https://github.com/rinvex/countries

Example of catching CountryLoaderException when an unknown country code is passed to country(). The exception is thrown for invalid codes.

```php
try {
    country('xx');
} catch (\Rinvex\Country\CountryLoaderException $e) {
    // invalid code
}
```

--------------------------------

### getGeodata()

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns geographical data for the country, including coordinates, area, and borders.

```APIDOC
## getGeodata()

### Description
Returns geographical data for the country, including coordinates, area, and borders.

### Method
`getGeodata()`

### Return Value
Object with geographic properties.

### Example
```php
// {"continent":{"AF":"Africa"},"postal_code":true,"latitude":"27 00 N","latitude_dec":"26.756103515625","longitude":"30 00 E","longitude_dec":"29.86229705810547","max_latitude":"31.916667","max_longitude":"36.333333","min_latitude":"20.383333","min_longitude":"24.7","area":1002450,"region":"Africa","subregion":"Northern Africa","world_region":"EMEA","region_code":"002","subregion_code":"015","landlocked":false,"borders":["ISR","LBY","SDN"],"independent":"Yes"}
$egypt->getGeodata();
```
```

--------------------------------

### getDivisions()

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns the divisions of the country as an array.

```APIDOC
## getDivisions()

### Description
Returns the divisions of the country as an array.

### Method
`getDivisions()`

### Return Value
Array of division names.

### Example
```php
// Divisions returned as array
$egypt->getDivisions();
```
```

--------------------------------

### Load currency keys and details with CurrencyLoader::currencies()

Source: https://github.com/rinvex/countries

Use CurrencyLoader::currencies() to get a map of ISO 4217 currency codes. With $longlist=false (default), returns currency keys only (165 entries from the shortlist). With $longlist=true, returns full currency detail arrays (also 165 entries). The map is sorted via ksort() and keyed by currency code; shared currencies collapse into a single key.

```php
use Rinvex\Country\CurrencyLoader;

// Currency keys only
$codes = CurrencyLoader::currencies();
echo $codes['EGP'];                 // EGP
echo count($codes);                 // 165

// Full currency details
$details = CurrencyLoader::currencies(true);
echo $details['EGP']['iso_4217_name'];       // Egyptian Pound
echo $details['EGP']['iso_4217_minor_unit']; // 2
echo $details['EUR']['iso_4217_numeric'];    // 978
```

--------------------------------

### Usage inside a Laravel FormRequest or controller

Source: https://github.com/rinvex/countries

Shows how to use the 'country' and 'currency' rules in a validator. The example uses 'eg' for country (passes) and 'egp' for currency (fails because it is lower-cased and not a key).

```php
// Usage inside a Laravel FormRequest or controller
use Illuminate\Support\Facades\Validator;

$v = Validator::make(
    ['country' => 'eg', 'currency' => 'egp'],
    ['country' => 'required|country', 'currency' => 'required|currency']
);

if ($v->fails()) {
    $errors = $v->errors(); // country passes, currency fails ("egp" lower-cased is not a key)
}
```

--------------------------------

### Usage example for getTimezones() and getLocales()

Source: https://github.com/rinvex/countries

Shows how to call getTimezones() and getLocales() on a country object. The output comments indicate the expected results for Egypt: timezones as ['Africa/Cairo'] and locales as ['ar_EG'].

```php
$egypt = country('eg');
print_r($egypt->getTimezones()); // ["Africa/Cairo"]
print_r($egypt->getLocales());   // ["ar_EG"]
```

--------------------------------

### Find country by attribute using findBy method

Source: https://github.com/rinvex/countries/wiki/3)-Usage

The findBy method finds a country by one of its attributes and returns an array of the first result.

```php
$usa = (new Country)->findBy('capital', 'Washington D.C.');
```

--------------------------------

### getDivision($code)

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns details for a specific division of the country by its code.

```APIDOC
## getDivision($code)

### Description
Returns details for a specific division of the country by its code.

### Method
`getDivision($code)`

### Parameters
- `$code` (string) - Required - The division code (e.g., 'ALX').

### Return Value
Object with division details.

### Example
```php
// {"name":"Al Iskandariyah","alt_names":["El Iskandariya","al-Iskandariyah","al-Iskandarīyah","Alexandria","Alexandrie","Alexandria"],"geo":{"latitude":31.2000924,"longitude":29.9187387,"min_latitude":31.1173177,"min_longitude":29.8233701,"max_latitude":31.330904,"max_longitude":30.0864016}}
$egypt->getDivision("ALX");
```
```

--------------------------------

### get()

Source: https://github.com/rinvex/countries

Retrieves an attribute value by key, supporting dot notation for nested lookup. Returns a default value when the key is not found, or the entire array when key is null.

```APIDOC
## get()

### Description
Retrieves an attribute value by key, supporting dot notation for nested lookup. Returns a default value when the key is not found, or the entire array when key is null.

### Method
get

### Signature
public function get($key, mixed $default = null)

### Parameters
- **$key** (string) - Required - Attribute key, supports dot.notation for nested lookup; null returns the whole array
- **$default** (mixed) - Optional - Returned when the key (or any segment) is not found

### Return
- **mixed** - The value, $default when missing, or the entire $attributes array when $key is null.

### Request Example
```php
$egypt = country('eg');
$egypt->set('custom_key', 'x')->set('flag_note', 'shared');
echo $egypt->get('geo.region');      // Africa
echo $egypt->get('geo.missing', 'fallback'); // fallback
var_export($egypt->get(null));       // the whole array
$egypt->setAttributes([]);           // replaces everything
```
```

--------------------------------

### country() helper function

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns a Country object for the given country code. The returned object provides access to various country attributes through getter methods.

```APIDOC
## country()

### Description
Returns a Country object for the specified country code. Use the returned object to access country attributes via getter methods.

### Method
Function call

### Parameters
- **$code** (string) - Required - The country code (e.g., 'eg' for Egypt).

### Return Value
Country object with getter methods for various attributes.

### Example
```php
$egypt = country('eg');
```
```

--------------------------------

### Require rinvex/country in composer.json

Source: https://github.com/rinvex/countries/wiki/1)-Installation

Add this line to the require array in your application's composer.json file. After changes, run 'composer validate' to ensure the file is valid.

```json
"rinvex/country": "1.0.*"
```

--------------------------------

### getTranslation()

Source: https://github.com/rinvex/countries/blob/master/README.md

Returns the translation of the country name in the current locale.

```APIDOC
## getTranslation()

### Description
Returns the translation of the country name in the current locale.

### Method
`getTranslation()`

### Return Value
Object with `official` and `common` name translations.

### Example
```php
// {"official":"جمهورية مصر العربية","common":"مصر"}
$egypt->getTranslation();
```
```

--------------------------------

### Country object getter methods

Source: https://github.com/rinvex/countries/blob/master/README.md

Getter methods on the Country object to retrieve various country attributes such as names, codes, geographic data, and more.

```APIDOC
## Country Object Getter Methods

### Description
These methods are available on the Country object returned by the `country()` helper. Each method returns a specific attribute of the country.

### Methods
- **getName()** - Returns the country name (e.g., 'Egypt').
- **getNativeName()** - Returns the native name (e.g., 'مصر').
- **getOfficialName()** - Returns the official name (e.g., 'Arab Republic of Egypt').
- **getNativeOfficialName()** - Returns the native official name (e.g., 'جمهورية مصر العربية').
- **getDemonym()** - Returns the demonym (e.g., 'Egyptian').
- **getCapital()** - Returns the capital city (e.g., 'Cairo').
- **getIsoAlpha2()** - Returns the ISO alpha-2 code (e.g., 'EG').
- **getIsoAlpha3()** - Returns the ISO alpha-3 code (e.g., 'EGY').
- **getIsoNumeric()** - Returns the ISO numeric code (e.g., 818).
- **getTld()** - Returns the top-level domain (e.g., '.eg').
- **getTlds()** - Returns an array of top-level domains (e.g., ['.eg', '.مصر']).
- **getAltSpellings()** - Returns alternative spellings (e.g., ['EG', 'Arab Republic of Egypt']).
- **getLanguage()** - Returns the primary language (e.g., 'Arabic').
- **getLanguages()** - Returns an object of languages (e.g., {'ara': 'Arabic'}).
- **getContinent()** - Returns the continent (e.g., 'Africa').
- **usesPostalCode()** - Returns whether postal codes are used (e.g., true).
- **getLatitude()** - Returns the latitude (e.g., '27 00 N').
- **getLongitude()** - Returns the longitude (e.g., '30 00 E').
- **getLatitudeDesc()** - Returns the latitude description (e.g., 26.756103515625).
- **getLongitudeDesc()** - Returns the longitude description (e.g., 29.86229705810547).
- **getMaxLatitude()** - Returns the maximum latitude (e.g., 31.916667).
- **getMaxLongitude()** - Returns the maximum longitude (e.g., 36.333333).
- **getMinLatitude()** - Returns the minimum latitude (e.g., 20.383333).
- **getMinLongitude()** - Returns the minimum longitude (e.g., 24.7).
- **getArea()** - Returns the area (e.g., 1002450).
- **getRegion()** - Returns the region (e.g., 'Africa').
- **getSubregion()** - Returns the subregion (e.g., 'Northern Africa').
- **getWorldRegion()** - Returns the world region (e.g., 'EMEA').
- **getRegionCode()** - Returns the region code (e.g., '002').
- **getSubregionCode()** - Returns the subregion code (e.g., '015').
- **isLandlocked()** - Returns whether the country is landlocked (e.g., false).
- **getBorders()** - Returns an array of bordering country codes (e.g., ['ISR', 'LBY', 'SDN']).
- **isIndependent()** - Returns whether the country is independent (e.g., 'Yes').
- **getCallingCode()** - Returns the calling code (e.g., 20).
- **getCallingCodes()** - Returns an array of calling codes (e.g., ['20']).
- **getNationalPrefix()** - Returns the national prefix (e.g., 0).
- **getNationalNumberLength()** - Returns the national number length (e.g., 9).
- **getNationalNumberLengths()** - Returns an array of national number lengths (e.g., [9]).
- **getNationalDestinationCodeLength()** - Returns the national destination code length (e.g., 2).
- **getnationaldestinationcodelengths()** - Returns an array of national destination code lengths (e.g., [2]).
- **getInternationalPrefix()** - Returns the international prefix (e.g., '00').
- **getAddressFormat()** - Returns the address format (e.g., '{{recipient}}\n{{street}}\n{{postalcode}} {{city}}\n{{country}}').
- **getGeonameid()** - Returns the geoname ID (e.g., 357994).
- **getEdgar()** - Returns the Edgar code (e.g., 'H2').
- **getItu()** - Returns the ITU code (e.g., 'EGY').
- **getMarc()** - Returns the MARC code (e.g., 'ua').
- **getWmo()** - Returns the WMO code (e.g., 'EG').
- **getDs()** - Returns the DS code (e.g., 'ET').
- **getFifa()** - Returns the FIFA code (e.g., 'EGY').
- **getFips()** - Returns the FIPS code (e.g., 'EG').
- **getGaul()** - Returns the GAUL code (e.g., 40765).
- **getIoc()** - Returns the IOC code (e.g., 'EGY').
- **getCowc()** - Returns the COW code (e.g., 'EGY').
- **getCown()** - Returns the COWN code (e.g., 651).
- **getFao()** - Returns the FAO code (e.g., 59).
- **getImf()** - Returns the IMF code (e.g., 469).
- **getAr5()** - Returns the AR5 code (e.g., 'MAF').
- **isEuMember()** - Returns whether the country is an EU member (e.g., null).
- **getVatRates()** - Returns VAT rates (e.g., null).
- **getEmoji()** - Returns the emoji flag (e.g., '🇪🇬').
- **getGeoJson()** - Returns GeoJSON data as a string.
- **getFlag()** - Returns SVG flag data as a string.

### Example
```php
$egypt = country('eg');
echo $egypt->getName(); // Egypt
echo $egypt->getCapital(); // Cairo
```
```

--------------------------------

### Import Country class

Source: https://github.com/rinvex/countries/wiki/3)-Usage

Import the Rinvex\Country\Models\Country class before using any of its methods.

```php
use Rinvex\Country\Models\Country;
```

--------------------------------

### Using getTranslations() and getTranslation()

Source: https://github.com/rinvex/countries

Example usage with Egypt. getTranslations() returns all translations; getTranslation('fra') returns French, getTranslation() returns first after ksort(). Outputs Arabic official name, English common name, and French translation.

```php
$egypt = country('eg');
$all = $egypt->getTranslations();
echo $all['ara']['official'];            // جمهورية مصر العربية
echo $all['eng']['common'];              // Egypt
print_r($egypt->getTranslation('fra'));  // ["official" => "République arabe d'Égypte", "common" => "Égypte"]
print_r($egypt->getTranslation());       // first record after ksort() — "ara" for Egypt
```

--------------------------------

### Load country with hydration and raw array

Source: https://github.com/rinvex/countries

Shows two ways to call CountryLoader::country(): with default hydration returning a Country object, and with $hydrate=false returning a raw array. The code is case-insensitive, so 'eg' and 'EG' both work. The example prints the country name from both forms.

```php
use Rinvex\Country\CountryLoader;

// Hydrated Country object
$egypt = CountryLoader::country('eg');
echo $egypt->getName();   // Egypt

// Raw array (no hydration)
$data = CountryLoader::country('EG', false); // case-insensitive
echo $data['name']['common']; // Egypt
```

--------------------------------

### boot() method signature

Source: https://github.com/rinvex/countries

Declares the boot method that registers global validation rules.

```php
public function boot(): void
```

--------------------------------

### set() method signature

Source: https://github.com/rinvex/countries

Sets a top-level attribute key to a value and returns the same instance (fluent). The key is used verbatim; dot notation is not expanded.

```php
public function set($key, mixed $value): static
```

--------------------------------

### getTld()

Source: https://github.com/rinvex/countries

Returns the first top-level domain (TLD) for the country, or null if none exist.

```APIDOC
## getTld()

### Description
Returns the first top-level domain (TLD) for the country, or null if none exist.

### Method
`getTld()`

### Return Value
- **string|null** - The first TLD.

### Example
No example provided in the source.
```

--------------------------------

### Constructor signature

Source: https://github.com/rinvex/countries

Defines the Country constructor that accepts a country attribute array. Throws an exception if mandatory attributes are missing.

```php
public function __construct($attributes)
```

--------------------------------

### Construction fails when mandatory attributes are missing

Source: https://github.com/rinvex/countries

Shows that constructing with only a 'capital' attribute throws an exception with the message 'Missing mandatory country attributes!'.

```php
// Construction fails when mandatory attributes are missing
try {
    new \Rinvex\Country\Country(['capital' => 'Cairo']); // no names, no ISO codes
} catch (\Exception $e) {
    echo $e->getMessage(); // Missing mandatory country attributes!
}
```

--------------------------------

### getItu()

Source: https://github.com/rinvex/countries

Returns the ITU code for the country.

```APIDOC
## getItu()

### Description
Returns the ITU code for the country.

### Method
`getItu()`

### Return Value
`?string` - The ITU code or `null` if not available.
```
Tokens:
Raw