matriphe / bendera
Laravel package to convert country code (ISO 3166-1 alpha-2) to the corresponding flag emoji
Requires
- illuminate/support: ^10.0
- spatie/laravel-package-tools: ^1.0
- stidges/country-flags: ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.0
- orchestra/testbench: ^8.0
- phpunit/phpunit: ^10.0
README
A Laravel package to convert country code (ISO 3166-1 alpha-2) to corresponding flag emoji.
This packages wraps Country Flags and all limitations on that package also apply to this.
Bendera means flag in Indonesian 🇮🇩.
Installation
You can install the package via composer:
Laravel 10
composer require matriphe/bendera
Laravel 9 or Older
composer require matriphe/bendera:0.3.0
Configuration
It is not necessary, but if you want to add mapping, publish the config file.
php artisan vendor:publish --provider="Matriphe\Bendera\BenderaServiceProvider" --tag="bendera"
For example you want to map a custom country XY
and shows it as ID
.
return [ 'aliases' => [ 'XY' => 'ID', ] ];
Usage
You can use the Facade Bendera
to get the emoji.
Bendera::emoji('id'); // will return 🇮🇩 Bendera::emoji('en'); // will return 🇬🇧 Bendera::emoji('uk'); // will return 🇬🇧 Bendera::emoji('GB'); // will return 🇬🇧 Bendera::emoji('XYZ'); // will return null
For invalid country code, it will return null
;
You can also use dependency injection style by injecting BenderaContract
to your class.
class SomeAwesomeClass { public function awesome(\Matriphe\Bendera\BenderaContract $bendera) { return $bendera->emoji('id'); } }
Contributing
Contributions are welcome via Pull Requests on Github.
Credits
License
The MIT License (MIT). Please see License File for more information.