Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Static Public Member Functions
Phrase Class Reference
Inheritance diagram for Phrase:

Public Member Functions

 __construct ($text, array $arguments=[])
 
 getText ()
 
 getArguments ()
 
 render ()
 
 __toString ()
 
 jsonSerialize ()
 

Static Public Member Functions

static setRenderer (RendererInterface $renderer)
 
static getRenderer ()
 

Detailed Description

@api

Since
100.0.2

Definition at line 17 of file Phrase.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $text,
array  $arguments = [] 
)

Phrase construct

Parameters
string$text
array$arguments

Definition at line 70 of file Phrase.php.

71  {
72  $this->text = (string)$text;
73  $this->arguments = $arguments;
74  }

Member Function Documentation

◆ __toString()

__toString ( )

Defers rendering to the last possible moment (when converted to string)

Returns
string

Definition at line 115 of file Phrase.php.

116  {
117  return $this->render();
118  }

◆ getArguments()

getArguments ( )

Get phrase message arguments

Returns
array

Definition at line 91 of file Phrase.php.

92  {
93  return $this->arguments;
94  }

◆ getRenderer()

static getRenderer ( )
static

Get default Phrase renderer

Returns
RendererInterface

Definition at line 56 of file Phrase.php.

57  {
58  if (!self::$renderer) {
59  self::$renderer = new RendererPlaceholder();
60  }
61  return self::$renderer;
62  }

◆ getText()

getText ( )

Get phrase base text

Returns
string

Definition at line 81 of file Phrase.php.

82  {
83  return $this->text;
84  }

◆ jsonSerialize()

jsonSerialize ( )

Specify data which should be serialized to JSON

Returns
string

Definition at line 125 of file Phrase.php.

126  {
127  return $this->render();
128  }

◆ render()

render ( )

Render phrase

Returns
string

Definition at line 101 of file Phrase.php.

102  {
103  try {
104  return self::getRenderer()->render([$this->text], $this->getArguments());
105  } catch (\Exception $e) {
106  return $this->getText();
107  }
108  }

◆ setRenderer()

static setRenderer ( RendererInterface  $renderer)
static

Set default Phrase renderer

Parameters
RendererInterface$renderer
Returns
void

Definition at line 46 of file Phrase.php.

47  {
48  self::$renderer = $renderer;
49  }

The documentation for this class was generated from the following file: