[v4] New translations root
#6216
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| <?php | ||
|
|
||
| namespace Kirby\Cms; | ||
|
|
||
| use Exception; | ||
| use Kirby\Data\Data; | ||
| use Kirby\Filesystem\F; | ||
|
|
||
| /** | ||
| * With helper methods provides get language translations or | ||
| * loads from custom `translations` root | ||
| * @since 4.2.0 | ||
| * | ||
| * @package Kirby Cms | ||
| * @author Ahmet Bora <[email protected]> | ||
| * @link https://getkirby.com | ||
| * @copyright Bastian Allgeier | ||
| * @license https://getkirby.com/license | ||
| */ | ||
| class LanguageTranslations | ||
| { | ||
| protected array $data; | ||
|
|
||
| public function __construct( | ||
| protected Language $language, | ||
| self|array $translations = [] | ||
| ) { | ||
| $this->setTranslations($translations); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a single translation string by key | ||
| */ | ||
| public function get(string $key, string $default = null): string|null | ||
| { | ||
| return $this->data[$key] ?? $default; | ||
| } | ||
|
|
||
| /** | ||
| * Loads the language translations based on custom roots for provided language code | ||
| */ | ||
| public function load(array $default = []): array | ||
| { | ||
| if ($file = $this->root()) { | ||
| try { | ||
| return Data::read($file); | ||
| } catch (Exception) { | ||
| return $default; | ||
| } | ||
| } | ||
|
|
||
| return $default; | ||
| } | ||
|
|
||
| /** | ||
| * Saves the language translations in the custom root | ||
| * @internal | ||
| * | ||
| * @return $this | ||
| */ | ||
| public function save(array $translations = []): static | ||
| { | ||
| $this->setTranslations($translations); | ||
|
|
||
| if ($root = $this->root()) { | ||
| Data::write($root, $translations); | ||
| } | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Returns custom translations root path if defined | ||
| */ | ||
| public function root(): string|null | ||
| { | ||
| $kirby = App::instance(); | ||
| $root = $kirby->root('translations'); | ||
| $file = ($root ?? '') . '/' . $this->language->code() . '.php'; | ||
|
|
||
| if ( | ||
| $root !== null && | ||
| F::exists($file) === true | ||
| ) { | ||
| return $file; | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * Removes a translation key | ||
| * | ||
| * @return $this | ||
| */ | ||
| public function remove(string $key): static | ||
| { | ||
| unset($this->data[$key]); | ||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the translation key | ||
| * | ||
| * @return $this | ||
| */ | ||
| public function set(string $key, string|null $value = null): static | ||
| { | ||
| $this->data[$key] = $value; | ||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Set translations | ||
| * | ||
| * @return $this | ||
| */ | ||
| public function setTranslations(self|array $translations = []): static | ||
| { | ||
| $this->data = match (true) { | ||
| empty($translations) === true => $this->load(), | ||
| $translations instanceof self => $translations->toArray(), | ||
| default => $translations | ||
| }; | ||
|
|
||
afbora marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Returns translations | ||
| */ | ||
| public function toArray(): array | ||
| { | ||
| return $this->data; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.