====== LocaleRouter ======

**Layer:** ''Core'' · **Source:** ''lib/core/LocaleRouter.php:7'' (lines 7–112)

----
<code>
class LocaleRouter
</code>

======= Inheritance =======

//No parent, interface or trait. This is a root type.//

======= Constants (0) =======

//None.//

======= Properties (3) =======

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$routes'' | ''[]'' | 9 |
| ''private'' | ''(untyped)'' | ''$detector'' |  | 10 |
| ''private'' | ''(untyped)'' | ''$availableLocales'' | ''[]'' | 11 |

======= Methods (10) =======

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | (undocumented) | 13 |
| private | ''registerDefaultRoutes()'' | (undocumented) | 20 |
| public | ''addRoute()'' | (undocumented) | 34 |
| public | ''extractLocale()'' | (undocumented) | 62 |
| public | ''stripLocalePrefix()'' | (undocumented) | 75 |
| public | ''buildUrl()'' | (undocumented) | 85 |
| public | ''buildCurrentUrl()'' | (undocumented) | 93 |
| public | ''getRoutes()'' | (undocumented) | 98 |
| public | ''hasLocalePrefix()'' | (undocumented) | 103 |
| public | ''getDetector()'' | (undocumented) | 108 |


======== __construct() ========

<code>
public function __construct(array $detectorSettings = [])
</code>

//lines 13–18 (6)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$detectorSettings'' |  ''array'' |  ''[]'' |  //none// |


======== registerDefaultRoutes() ========

<code>
private function registerDefaultRoutes(): void
</code>

//lines 20–32 (13)//

//Takes no parameters.//

**Returns:** ''void''


======== addRoute() ========

<code>
public function addRoute(string $name, string $pattern): void
</code>

//lines 34–37 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$name'' |  ''string'' |  //required// |  //none// |
|  ''$pattern'' |  ''string'' |  //required// |  //none// |

**Returns:** ''void''


======== extractLocale() ========

<code>
public function extractLocale(string $path): ?string
</code>

//lines 62–73 (12)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$path'' |  ''string'' |  //required// |  //none// |

**Returns:** ''?string''


======== stripLocalePrefix() ========

<code>
public function stripLocalePrefix(string $path): string
</code>

//lines 75–83 (9)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$path'' |  ''string'' |  //required// |  //none// |

**Returns:** ''string''


======== buildUrl() ========

<code>
public function buildUrl(string $path, ?string $locale = null): string
</code>

//lines 85–91 (7)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$path'' |  ''string'' |  //required// |  //none// |
|  ''$locale'' |  ''?string'' |  ''null'' |  //none// |

**Returns:** ''string''


======== buildCurrentUrl() ========

<code>
public function buildCurrentUrl(string $path): string
</code>

//lines 93–96 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$path'' |  ''string'' |  //required// |  //none// |

**Returns:** ''string''


======== getRoutes() ========

<code>
public function getRoutes(): array
</code>

//lines 98–101 (4)//

//Takes no parameters.//

**Returns:** ''array''


======== hasLocalePrefix() ========

<code>
public function hasLocalePrefix(string $path): bool
</code>

//lines 103–106 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$path'' |  ''string'' |  //required// |  //none// |

**Returns:** ''bool''


======== getDetector() ========

<code>
public function getDetector(): LocaleDetector
</code>

//lines 108–111 (4)//

//Takes no parameters.//

**Returns:** [[scriptlog:lib:core:localedetector|''LocaleDetector'']]


----

//This page is generated from source by 'tools/gendoc'. Edits will be overwritten.//