====== TranslationLoader ======

**Layer:** ''Core'' · **Source:** ''lib/core/TranslationLoader.php:10'' (lines 10–231)

----
<code>
class TranslationLoader
</code>

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

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

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

//None.//

======= Properties (7) =======

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$cacheDir'' |  | 12 |
| ''private'' | ''(untyped)'' | ''$cacheEnabled'' | ''true'' | 13 |
| ''private'' | ''(untyped)'' | ''$cacheTtl'' | ''3600'' | 14 |
| ''private'' | ''(untyped)'' | ''$loaded'' | ''[]'' | 15 |
| ''private'' | ''(untyped)'' | ''$translationDao'' |  | 16 |
| ''private'' | ''(untyped)'' | ''$languageDao'' |  | 17 |
| ''private'' | ''(untyped)'' | ''$initialized'' | ''false'' | 18 |

======= Methods (17) =======

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | (undocumented) | 20 |
| private | ''initializeDao()'' | (undocumented) | 27 |
| private | ''ensureCacheDirectory()'' | (undocumented) | 45 |
| public | ''load()'' | (undocumented) | 52 |
| public | ''get()'' | (undocumented) | 77 |
| private | ''loadFromCache()'' | (undocumented) | 91 |
| private | ''saveToCache()'' | (undocumented) | 109 |
| private | ''loadFromDatabase()'' | (undocumented) | 127 |
| private | ''loadDefaultStrings()'' | (undocumented) | 153 |
| private | ''getThemeIdentifier()'' | (undocumented) | 166 |
| private | ''getCacheFilePath()'' | (undocumented) | 178 |
| private | ''isCacheExpired()'' | (undocumented) | 183 |
| public | ''invalidate()'' | (undocumented) | 193 |
| private | ''interpolate()'' | (undocumented) | 204 |
| private | ''getCurrentLocale()'' | (undocumented) | 213 |
| public | ''isCacheEnabled()'' | (undocumented) | 222 |
| public | ''setCacheEnabled()'' | (undocumented) | 227 |


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

<code>
public function __construct()
</code>

//lines 20–25 (6)//

//Takes no parameters.//


======== initializeDao() ========

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

//lines 27–43 (17)//

//Takes no parameters.//

**Returns:** ''void''


======== ensureCacheDirectory() ========

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

//lines 45–50 (6)//

//Takes no parameters.//

**Returns:** ''void''


======== load() ========

<code>
public function load(string $locale): array
</code>

//lines 52–75 (24)//

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

**Returns:** ''array''


======== get() ========

<code>
public function get(string $key, ?string $locale = null, array $params = []): string
</code>

//lines 77–89 (13)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$key'' |  ''string'' |  //required// |  //none// |
|  ''$locale'' |  ''?string'' |  ''null'' |  //none// |
|  ''$params'' |  ''array'' |  ''[]'' |  //none// |

**Returns:** ''string''


======== loadFromCache() ========

<code>
private function loadFromCache(string $locale): ?array
</code>

//lines 91–107 (17)//

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

**Returns:** ''?array''


======== saveToCache() ========

<code>
private function saveToCache(string $locale, array $translations): void
</code>

//lines 109–125 (17)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$locale'' |  ''string'' |  //required// |  //none// |
|  ''$translations'' |  ''array'' |  //required// |  //none// |

**Returns:** ''void''


======== loadFromDatabase() ========

<code>
private function loadFromDatabase(string $locale): array
</code>

//lines 127–151 (25)//

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

**Returns:** ''array''


======== loadDefaultStrings() ========

<code>
private function loadDefaultStrings(string $locale): array
</code>

//lines 153–164 (12)//

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

**Returns:** ''array''


======== getThemeIdentifier() ========

<code>
private function getThemeIdentifier(): string
</code>

//lines 166–176 (11)//

//Takes no parameters.//

**Returns:** ''string''


======== getCacheFilePath() ========

<code>
private function getCacheFilePath(string $locale): string
</code>

//lines 178–181 (4)//

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

**Returns:** ''string''


======== isCacheExpired() ========

<code>
private function isCacheExpired(string $cacheFile): bool
</code>

//lines 183–191 (9)//

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

**Returns:** ''bool''


======== invalidate() ========

<code>
public function invalidate(string $locale): void
</code>

//lines 193–202 (10)//

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

**Returns:** ''void''


======== interpolate() ========

<code>
private function interpolate(string $text, array $params): string
</code>

//lines 204–211 (8)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$text'' |  ''string'' |  //required// |  //none// |
|  ''$params'' |  ''array'' |  //required// |  //none// |

**Returns:** ''string''


======== getCurrentLocale() ========

<code>
private function getCurrentLocale(): string
</code>

//lines 213–220 (8)//

//Takes no parameters.//

**Returns:** ''string''


======== isCacheEnabled() ========

<code>
public function isCacheEnabled(): bool
</code>

//lines 222–225 (4)//

//Takes no parameters.//

**Returns:** ''bool''


======== setCacheEnabled() ========

<code>
public function setCacheEnabled(bool $enabled): void
</code>

//lines 227–230 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$enabled'' |  ''bool'' |  //required// |  //none// |

**Returns:** ''void''

======= Imports =======

^ Alias ^ Fully-qualified name ^
| ''LanguageDao'' | [[scriptlog:lib:dao:languagedao|''Scriptlog\Dao\LanguageDao'']] |
| ''TranslationDao'' | [[scriptlog:lib:dao:translationdao|''Scriptlog\Dao\TranslationDao'']] |


----

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