README 文档

README

Attention: Please do not use in production environments. It‘s WIP.

This is a Geonames API client extension for the Yii2 Framework. It wraps around the geonames-api php library.

Requirements

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist spacedealer/yii2-geonames "*"

or add

"spacedealer/yii2-geonames": "*"

to the require section of your composer.json file.

Once the extension is installed, simply modify your application components configuration as follows:

'geonames' => [
	'class' => 'spacedealer\geonames\Geonames',
	'username' => 'your_username',
	'language' => 'de',
],

Use within your Yii2 application logic:

$geonames = \Yii::$app->get('geonames')->getClient();
$response = $geonames->postalCodeSearch([
	'country' => 'de',
	'postalcode' => '10997',
]);