Fix #4: Add support for generation of locale based URLs (#123)

README.md

@@ -155,6 +155,27 @@ function getUrl(UrlGeneratorInterface $urlGenerator, $parameters = [])
 }
 ```
 
+### Creating locale URLs
+
+Locale based URLs can be configured the following:
+
+```php
+
+$urlGenerator->setLocales(['en' => 'en-US', 'ru' => 'ru-RU', 'uz' => 'uz-UZ']);
+$urlGenerator->setLocaleParameterName('_locale');
+```
+
+Then that is how locale URL could be obtained for it:
+
+```php
+use Yiisoft\Router\UrlGeneratorInterface;
+
+function getLocaleUrl(UrlGeneratorInterface $urlGenerator, string $locale)
+{
+    return $urlGenerator->generate('test', ['_locale' => $locale]);
+}
+```
+
 ## Obtain current route and URI
 
 Current route (matched last) and URI could be obtained the following:

src/UrlGeneratorInterface.php

@@ -39,4 +39,10 @@ public function generateAbsolute(string $name, array $parameters = [], string $s
     public function getUriPrefix(): string;
 
     public function setUriPrefix(string $name): void;
+
+    public function getLocales(): array;
+
+    public function setLocales(array $locales): void;
+
+    public function setLocaleParameterName(string $localeParameterName): void;
 }