This is an old revision of the document!
Table of Contents
LocaleDetector
Layer: Core · Source: lib/core/LocaleDetector.php:9 (lines 9–180)
class LocaleDetector
Inheritance
No parent, interface or trait. This is a root type.
Constants (0)
None.
Properties (4)
^ Visibility ^ Type ^ Name ^ Default ^ Line ^ | ''private'' | ''(untyped)'' | ''$availableLocales'' | ''[];'' | 11 | | ''private'' | ''(untyped)'' | ''$defaultLocale'' | '''en';'' | 12 | | ''private'' | ''(untyped)'' | ''$autoDetectEnabled'' | ''true;'' | 13 | | ''private'' | ''(untyped)'' | ''$settingsLoaded'' | ''false;'' | 14 |
Methods (14)
^ Visibility ^ Method ^ Summary ^ Line ^ | public | ''__construct()'' | (undocumented) | 16 | | private | ''applySettings()'' | (undocumented) | 26 | | private | ''loadSettings()'' | (undocumented) | 34 | | public | ''detect()'' | (undocumented) | 68 | | private | ''extractFromUrl()'' | (undocumented) | 94 | | private | ''detectFromBrowser()'' | (undocumented) | 109 | | public | ''isValidLocale()'' | (undocumented) | 134 | | public | ''setLocale()'' | (undocumented) | 139 | | public | ''getAvailableLocales()'' | (undocumented) | 151 | | public | ''setAvailableLocales()'' | (undocumented) | 156 | | public | ''getDefaultLocale()'' | (undocumented) | 161 | | public | ''setDefaultLocale()'' | (undocumented) | 166 | | public | ''isAutoDetectEnabled()'' | (undocumented) | 171 | | public | ''setAutoDetect()'' | (undocumented) | 176 |
__construct()
public function __construct(array $settings = [])
lines 16–24 (9)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$settings'' | ''array'' | ''[]'' | //none// |
applySettings()
private function applySettings(array $settings): void
lines 26–32 (7)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$settings'' | ''array'' | //required// | //none// |
Returns: void
loadSettings()
private function loadSettings(): void
lines 34–66 (33)
Takes no parameters.
Returns: void
detect()
public function detect(): string
lines 68–92 (25)
Takes no parameters.
Returns: string
extractFromUrl()
private function extractFromUrl(): ?string
lines 94–107 (14)
Takes no parameters.
Returns: ?string
detectFromBrowser()
private function detectFromBrowser(): ?string
lines 109–132 (24)
Takes no parameters.
Returns: ?string
isValidLocale()
public function isValidLocale(string $locale): bool
lines 134–137 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$locale'' | ''string'' | //required// | //none// |
Returns: bool
setLocale()
public function setLocale(string $locale): bool
lines 139–149 (11)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$locale'' | ''string'' | //required// | //none// |
Returns: bool
getAvailableLocales()
public function getAvailableLocales(): array
lines 151–154 (4)
Takes no parameters.
Returns: array
setAvailableLocales()
public function setAvailableLocales(array $locales): void
lines 156–159 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$locales'' | ''array'' | //required// | //none// |
Returns: void
getDefaultLocale()
public function getDefaultLocale(): string
lines 161–164 (4)
Takes no parameters.
Returns: string
setDefaultLocale()
public function setDefaultLocale(string $locale): void
lines 166–169 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$locale'' | ''string'' | //required// | //none// |
Returns: void
isAutoDetectEnabled()
public function isAutoDetectEnabled(): bool
lines 171–174 (4)
Takes no parameters.
Returns: bool
setAutoDetect()
public function setAutoDetect(bool $enabled): void
lines 176–179 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$enabled'' | ''bool'' | //required// | //none// |
Returns: void
Imports
^ Alias ^ Fully-qualified name ^ | ''ConfigurationDao'' | [[scriptlog:lib:dao:configurationdao|''Scriptlog\Dao\ConfigurationDao'']] |
This page is generated from source by 'tools/gendoc'. Edits will be overwritten.