src/Core/L10n.php

   1 <?php
   2 /**
   3  * @file src/Core/L10n.php
   4  */
   5 namespace Friendica\Core;
   6
   7 use Friendica\BaseObject;
   8 use Friendica\Core\L10n\L10n as L10nClass;
   9
  10 /**
  11  * Provide Language, Translation, and Localization functions to the application
  12  * Localization can be referred to by the numeronym L10N (as in: "L", followed by ten more letters, and then "N").
  13  */
  14 class L10n extends BaseObject
  15 {
  16         /**
  17          * Returns the current language code
  18          *
  19          * @return string Language code
  20          */
  21         public static function getCurrentLang()
  22         {
  23                 return self::getClass(L10nClass::class)->getCurrentLang();
  24         }
  25
  26         /**
  27          * This function should be called before formatting messages in a specific target language
  28          * different from the current user/system language.
  29          *
  30          * It saves the current translation strings in a separate variable and loads new translations strings.
  31          *
  32          * If called repeatedly, it won't save the translation strings again, just load the new ones.
  33          *
  34          * @see   popLang()
  35          * @brief Stores the current language strings and load a different language.
  36          * @param string $lang Language code
  37          * @throws \Exception
  38          */
  39         public static function pushLang($lang)
  40         {
  41                 self::getClass(L10nClass::class)->pushLang($lang);
  42         }
  43
  44         /**
  45          * Restores the original user/system language after having used pushLang()
  46          */
  47         public static function popLang()
  48         {
  49                 self::getClass(L10nClass::class)->popLang();
  50         }
  51
  52         /**
  53          * @brief Return the localized version of the provided string with optional string interpolation
  54          *
  55          * This function takes a english string as parameter, and if a localized version
  56          * exists for the current language, substitutes it before performing an eventual
  57          * string interpolation (sprintf) with additional optional arguments.
  58          *
  59          * Usages:
  60          * - L10n::t('This is an example')
  61          * - L10n::t('URL %s returned no result', $url)
  62          * - L10n::t('Current version: %s, new version: %s', $current_version, $new_version)
  63          *
  64          * @param string $s
  65          * @param array  $vars Variables to interpolate in the translation string
  66          * @return string
  67          */
  68         public static function t($s, ...$vars)
  69         {
  70                 return self::getClass(L10nClass::class)->t($s, ...$vars);
  71         }
  72
  73         /**
  74          * @brief Return the localized version of a singular/plural string with optional string interpolation
  75          *
  76          * This function takes two english strings as parameters, singular and plural, as
  77          * well as a count. If a localized version exists for the current language, they
  78          * are used instead. Discrimination between singular and plural is done using the
  79          * localized function if any or the default one. Finally, a string interpolation
  80          * is performed using the count as parameter.
  81          *
  82          * Usages:
  83          * - L10n::tt('Like', 'Likes', $count)
  84          * - L10n::tt("%s user deleted", "%s users deleted", count($users))
  85          *
  86          * @param string $singular
  87          * @param string $plural
  88          * @param int    $count
  89          * @return string
  90          * @throws \Exception
  91          */
  92         public static function tt(string $singular, string $plural, int $count)
  93         {
  94                 return self::getClass(L10nClass::class)->tt($singular, $plural, $count);
  95         }
  96
  97         /**
  98          * @brief Return installed languages codes as associative array
  99          *
 100          * Scans the view/lang directory for the existence of "strings.php" files, and
 101          * returns an alphabetical list of their folder names (@-char language codes).
 102          * Adds the english language if it's missing from the list.
 103          *
 104          * Ex: array('de' => 'de', 'en' => 'en', 'fr' => 'fr', ...)
 105          *
 106          * @return array
 107          */
 108         public static function getAvailableLanguages()
 109         {
 110                 return L10nClass::getAvailableLanguages();
 111         }
 112
 113         /**
 114          * @brief Translate days and months names.
 115          *
 116          * @param string $s String with day or month name.
 117          * @return string Translated string.
 118          */
 119         public static function getDay($s)
 120         {
 121                 return self::getClass(L10nClass::class)->getDay($s);
 122         }
 123
 124         /**
 125          * @brief Translate short days and months names.
 126          *
 127          * @param string $s String with short day or month name.
 128          * @return string Translated string.
 129          */
 130         public static function getDayShort($s)
 131         {
 132                 return self::getClass(L10nClass::class)->getDayShort($s);
 133         }
 134 }