3 * @file src/Core/L10n.php
5 namespace Friendica\Core;
7 use Friendica\Core\L10n\L10n as L10nClass;
10 * Provide Language, Translation, and Localization functions to the application
11 * Localization can be referred to by the numeronym L10N (as in: "L", followed by ten more letters, and then "N").
21 * Initializes the L10n static wrapper with the instance
23 * @param L10nClass $l10n The l10n class
25 public static function init(L10nClass $l10n)
31 * Returns the current language code
33 * @return string Language code
35 public static function getCurrentLang()
37 return self::$l10n->getCurrentLang();
41 * This function should be called before formatting messages in a specific target language
42 * different from the current user/system language.
44 * It saves the current translation strings in a separate variable and loads new translations strings.
46 * If called repeatedly, it won't save the translation strings again, just load the new ones.
49 * @brief Stores the current language strings and load a different language.
50 * @param string $lang Language code
53 public static function pushLang($lang)
55 self::$l10n->pushLang($lang);
59 * Restores the original user/system language after having used pushLang()
61 public static function popLang()
63 self::$l10n->popLang();
67 * @brief Return the localized version of the provided string with optional string interpolation
69 * This function takes a english string as parameter, and if a localized version
70 * exists for the current language, substitutes it before performing an eventual
71 * string interpolation (sprintf) with additional optional arguments.
74 * - L10n::t('This is an example')
75 * - L10n::t('URL %s returned no result', $url)
76 * - L10n::t('Current version: %s, new version: %s', $current_version, $new_version)
79 * @param array $vars Variables to interpolate in the translation string
82 public static function t($s, ...$vars)
84 return self::$l10n->t($s, $vars);
88 * @brief Return the localized version of a singular/plural string with optional string interpolation
90 * This function takes two english strings as parameters, singular and plural, as
91 * well as a count. If a localized version exists for the current language, they
92 * are used instead. Discrimination between singular and plural is done using the
93 * localized function if any or the default one. Finally, a string interpolation
94 * is performed using the count as parameter.
97 * - L10n::tt('Like', 'Likes', $count)
98 * - L10n::tt("%s user deleted", "%s users deleted", count($users))
100 * @param string $singular
101 * @param string $plural
106 public static function tt(string $singular, string $plural, int $count)
108 return self::$l10n->tt($singular, $plural, $count);
112 * @brief Return installed languages codes as associative array
114 * Scans the view/lang directory for the existence of "strings.php" files, and
115 * returns an alphabetical list of their folder names (@-char language codes).
116 * Adds the english language if it's missing from the list.
118 * Ex: array('de' => 'de', 'en' => 'en', 'fr' => 'fr', ...)
122 public static function getAvailableLanguages()
124 return self::$l10n::getAvailableLanguages();
128 * @brief Translate days and months names.
130 * @param string $s String with day or month name.
131 * @return string Translated string.
133 public static function getDay($s)
135 return self::$l10n->getDay($s);
139 * @brief Translate short days and months names.
141 * @param string $s String with short day or month name.
142 * @return string Translated string.
144 public static function getDayShort($s)
146 return self::$l10n->getDayShort($s);