You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

67 lines
2.5 KiB

3 years ago
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Contracts\Translation;
  11. /**
  12. * @author Fabien Potencier <fabien@symfony.com>
  13. *
  14. * @method string getLocale() Returns the default locale
  15. */
  16. interface TranslatorInterface
  17. {
  18. /**
  19. * Translates the given message.
  20. *
  21. * When a number is provided as a parameter named "%count%", the message is parsed for plural
  22. * forms and a translation is chosen according to this number using the following rules:
  23. *
  24. * Given a message with different plural translations separated by a
  25. * pipe (|), this method returns the correct portion of the message based
  26. * on the given number, locale and the pluralization rules in the message
  27. * itself.
  28. *
  29. * The message supports two different types of pluralization rules:
  30. *
  31. * interval: {0} There are no apples|{1} There is one apple|]1,Inf] There are %count% apples
  32. * indexed: There is one apple|There are %count% apples
  33. *
  34. * The indexed solution can also contain labels (e.g. one: There is one apple).
  35. * This is purely for making the translations more clear - it does not
  36. * affect the functionality.
  37. *
  38. * The two methods can also be mixed:
  39. * {0} There are no apples|one: There is one apple|more: There are %count% apples
  40. *
  41. * An interval can represent a finite set of numbers:
  42. * {1,2,3,4}
  43. *
  44. * An interval can represent numbers between two numbers:
  45. * [1, +Inf]
  46. * ]-1,2[
  47. *
  48. * The left delimiter can be [ (inclusive) or ] (exclusive).
  49. * The right delimiter can be [ (exclusive) or ] (inclusive).
  50. * Beside numbers, you can use -Inf and +Inf for the infinite.
  51. *
  52. * @see https://en.wikipedia.org/wiki/ISO_31-11
  53. *
  54. * @param string $id The message id (may also be an object that can be cast to string)
  55. * @param array $parameters An array of parameters for the message
  56. * @param string|null $domain The domain for the message or null to use the default
  57. * @param string|null $locale The locale or null to use the default
  58. *
  59. * @return string The translated string
  60. *
  61. * @throws \InvalidArgumentException If the locale contains invalid characters
  62. */
  63. public function trans(string $id, array $parameters = [], string $domain = null, string $locale = null);
  64. }