README

Built with ❤️ for Persian developers ;)

It's been a hard time for me to find and list all Iran banks logos, IBAN codes and valid card numbers. So I decided to put them together in this package.

If you need to check users IBAN (sheba) Code or card number and find out which bank is his/her account, this is what you need.

⭐ Your Stars Make Us Do More

If you found this package useful, and you want to encourage the maintainer to work on it, just press the star button to declare your willingness.

Stargazers

⬇️ Installation

You can install the package via composer:

composer require morieti/iran-banks-info

You may also publish banks logo files by adding this in your prject composer.json:

"scripts": {
    "post-autoload-dump": "Morieti\\IranBanksInfo\\Config::publishBankImages"
}

And then:

composer dump-autoload

💎 Usage

You can use global \Morieti\IranBanksInfo\Config class to change some configs:

####standardCardNumberSize: To change standard size of banks card numbers which is 16 by default.

####standardIbanSize: To change standard size of iban code which is 26 by default. If you don't store 'IR' from beginning of the code, you can set this property to 24.

####baseImagePath: By default, package will publish banks logos to public/iran_banks_images relative to your project's root. You may relocate the pictures, but remember to set the relative path to them by changing this property.

###Config class uses the singleton pattern, so you may call it once and for all.

Credits

• Morteza
• All Contributors

License

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

🙋 Contributing

If you find an issue or have a better way to do something, feel free to open an issue, or a pull request. If you use iran-banks-info in your open source project, create a pull request to provide its URL as a sample application in the README.md file.

❗ Security

If you discover any security-related issues, please email pouretemadi.morteza@gmail.com instead of using the issue tracker.

A man will never fail unless he stops trying.

Albert einstein