yii2-module/yii2-insee-ban

A module that structures the data of the Base des Adresses Nationales (fr : BAN) from the INSEE and others

Installs: 1 497

Dependents: 1

Suggesters: 0

Security: 0

Type:yii2-module


README

A module that structures the data of the Base des Adresses Nationales (fr : BAN) from the INSEE and others.

coverage build status

Installation

The installation of this library is made via composer. Download composer.phar from their website. Then add to your composer.json :

	"require": {
		...
		"yii2-module/yii2-insee-ban": "^4",
		...
	}

Then run php composer.phar update to install this library. The autoloading of all classes of this library is made through composer's autoloader.

Configuration

This module needs the following components to be set at the configuration level:

  • 'db_insee_ban' should be a \yii\db\Connection

If you already have a database connection, you may use the following trick :

'db_insee_ban' => function() { return \Yii::$app->get('db'); },

where 'db' is the id of your database connection.

This module uses the following parameters to be set at the configuration level:

  • InseeBanModule::tempDirPath may be configured to a valid directory or alias known by Yii. Its default is @app/runtime/insee-ban, which is automatically created if it does not exist. This parameter is used to download and uncompress the csv source files of the BAN, and should be cleared occasionnally.

Then the module should be configured as follows (in console.php or web.php) :

$config = [
	...
	'modules' => [
		...
		'insee-ban' => [
			'class' => 'Yii2Module\Yii2InseeBan\InseeBanModule',
		],
		...
	],
	...
];

License

MIT (See license file)