https://github.com/sadi01/yii2-open-banking
Open Banking Service for Yii 2 framework
https://github.com/sadi01/yii2-open-banking
open-banking
Last synced: 5 months ago
JSON representation
Open Banking Service for Yii 2 framework
- Host: GitHub
- URL: https://github.com/sadi01/yii2-open-banking
- Owner: Sadi01
- License: bsd-3-clause
- Created: 2024-05-05T08:24:15.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-18T09:30:28.000Z (10 months ago)
- Last Synced: 2024-11-02T09:27:40.921Z (6 months ago)
- Topics: open-banking
- Language: PHP
- Homepage:
- Size: 341 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Open banking extension for Yii 2
# Yii2 Open Banking
**Openbanking** is an extension for integrating the service calls of various banking platforms, including Faraboom,
Finotech, Shaheen, and Shahkar.
This extension enables the unified management of calling various banking services for
the [Yii framework 2.0](http://www.yiiframework.com).
For license information check the [LICENSE](LICENSE.md)-file.
Installation
------------
### Using Composer (Preferred Method):
The preferred way to install this extension is through [composer](http://getcomposer.org/download/):
```
composer require --prefer-dist sadi01/yii2-open-banking"*"
```
### Alternative Method:
If you prefer adding the openbanking extension to your `composer.json` file manually, you can do so by adding the
following entry to the `require` section:
```json
{
"require": {
"sadi01/yii2-open-banking": "*"
}
}
```
After adding the entry, save the `composer.json` file and run the following command in the terminal or command prompt
within your project directory:
```
composer update
```
This command will fetch and install the openbanking extension and its required dependencies into your Yii 2 project.
Configuration
-------------
To use this extension, you have to configure the openbanking module in your application configuration:
```php
return [
//....
'modules' => [
'openbanking' => [
'class' => 'sadi01\openbanking\Module'
],
]
];
```
and you have to configure the openbanking component in your application configuration:
```php
return [
//....
'components' => [
'openBanking' => [
'class' => 'sadi01\openbanking\components\OpenBanking',
'bsVersion' => 4 //your project bs version
],
]
];
```
DB Migrations
-------------
Run module migrations:
```php
php yii migrate --migrationPath=@sadi01/openbanking/migrations
```
Or, Add migrations path in console application config:
```php
'controllerMap' => [
'migrate' => [
'class' => 'yii\console\controllers\MigrateController',
'migrationNamespaces' => [],
'migrationPath' => [
'@vendor/sadi01/yii2-open-banking/src/migrations',
'@app/migrations'
]
],
],
```
How To Use
-------------
add to your code:
```php
Yii::$app->openBanking->call('','',[])
```
Advanced config
-------------
- [Installation Guide](./src/guide/installation.md)
- [Faraboom Description Guide](./src/guide/faraboom.md)
- [Finnotech Description Guide](./src/guide/finnotech.md)