Phrase.php 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. <?php
  2. /**
  3. * Phrase (for replacing Data Value with Object)
  4. *
  5. * Copyright © Magento, Inc. All rights reserved.
  6. * See COPYING.txt for license details.
  7. */
  8. namespace Magento\Framework;
  9. use Magento\Framework\Phrase\Renderer\Placeholder as RendererPlaceholder;
  10. use Magento\Framework\Phrase\RendererInterface;
  11. /**
  12. * @api
  13. * @since 100.0.2
  14. */
  15. class Phrase implements \JsonSerializable
  16. {
  17. /**
  18. * Default phrase renderer. Allows stacking renderers that "don't know about each other"
  19. *
  20. * @var RendererInterface
  21. */
  22. private static $renderer;
  23. /**
  24. * String for rendering
  25. *
  26. * @var string
  27. */
  28. private $text;
  29. /**
  30. * Arguments for placeholder values
  31. *
  32. * @var array
  33. */
  34. private $arguments;
  35. /**
  36. * Set default Phrase renderer
  37. *
  38. * @param RendererInterface $renderer
  39. * @return void
  40. */
  41. public static function setRenderer(RendererInterface $renderer)
  42. {
  43. self::$renderer = $renderer;
  44. }
  45. /**
  46. * Get default Phrase renderer
  47. *
  48. * @return RendererInterface
  49. */
  50. public static function getRenderer()
  51. {
  52. if (!self::$renderer) {
  53. self::$renderer = new RendererPlaceholder();
  54. }
  55. return self::$renderer;
  56. }
  57. /**
  58. * Phrase construct
  59. *
  60. * @param string $text
  61. * @param array $arguments
  62. */
  63. public function __construct($text, array $arguments = [])
  64. {
  65. $this->text = (string)$text;
  66. $this->arguments = $arguments;
  67. }
  68. /**
  69. * Get phrase base text
  70. *
  71. * @return string
  72. */
  73. public function getText()
  74. {
  75. return $this->text;
  76. }
  77. /**
  78. * Get phrase message arguments
  79. *
  80. * @return array
  81. */
  82. public function getArguments()
  83. {
  84. return $this->arguments;
  85. }
  86. /**
  87. * Render phrase
  88. *
  89. * @return string
  90. */
  91. public function render()
  92. {
  93. try {
  94. return self::getRenderer()->render([$this->text], $this->getArguments());
  95. } catch (\Exception $e) {
  96. return $this->getText();
  97. }
  98. }
  99. /**
  100. * Defers rendering to the last possible moment (when converted to string)
  101. *
  102. * @return string
  103. */
  104. public function __toString()
  105. {
  106. return $this->render();
  107. }
  108. /**
  109. * Specify data which should be serialized to JSON
  110. *
  111. * @return string
  112. */
  113. public function jsonSerialize()
  114. {
  115. return $this->render();
  116. }
  117. }