stidges/country-flags

A small package to convert a country code to the corresponding country flag emoji

v2.0.0 2021-01-08 13:52 UTC

This package is auto-updated.

Last update: 2021-11-08 18:04:16 UTC


README

Latest Version on Packagist Software License Build Status Total Downloads

A small package to convert a country code to the corresponding country flag emoji.

Note: Emoji flags are not supported on Windows, which displays two-letter country codes instead of emoji flag images.

Installation

You can install the package via Composer:

$ composer require stidges/country-flags

Basic Usage

$countryFlag = new CountryFlag;

echo $countryFlag->get('NL'); // "🇳🇱"

Aliasing

If you would like to make country codes available under a custom aliases, you can pass these to the constructor:

$countryFlag = new CountryFlag([
    'AA' => 'NL',
]);

echo $countryFlag->get('AA'); // "🇳🇱"

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email info@stidges.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.