1. class
  2. s9e
  3. \
  4. TextFormatter
  5. \
  6. Renderers
  7. \
  8. Unformatted

Unformatted

class Unformatted extends Renderer

This renderer returns a plain text version of rich text. It is meant to be used as a last resort when every other renderer is unavailable

Properties

protected array $params from  Renderer
protected string $savedLocale from  Renderer

Methods

DOMDocument
loadXML(string $xml)

Create a return a new DOMDocument loaded with given XML

from  Renderer
string
render(string $xml)

Render an intermediate representation

from  Renderer
string
renderPlainText(string $xml)

Render an intermediate representation of plain text

from  Renderer
string
renderRichText(string $xml)

Render an intermediate representation of rich text

string
getParameter(string $paramName)

Get the value of a parameter

from  Renderer
array
getParameters()

Get the values of all parameters

from  Renderer
void
setParameter(string $paramName, mixed $paramValue)

Set the value of a parameter from the stylesheet

from  Renderer
void
setParameters(array $params)

Set the values of several parameters from the stylesheet

from  Renderer
void
checkUnsupported(string $xml)

Test for the presence of unsupported XML and throw an exception if found

from  Renderer
string
decodeSMP(string $str)

Decode encoded characters from the Supplementary Multilingual Plane

from  Renderer
static string
decodeEntity(array $m)

Decode a matched SGML entity

from  Renderer
void
restoreLocale()

Restore the original locale

from  Renderer
void
setLocale()

Temporarily set the locale to C

from  Renderer

Details

in Renderer at line 31
protected DOMDocument loadXML(string $xml)

Create a return a new DOMDocument loaded with given XML

Parameters

string $xml

Source XML

Return Value

DOMDocument

in Renderer at line 58
string render(string $xml)

Render an intermediate representation

Parameters

string $xml

Intermediate representation

Return Value

string

Rendered result

in Renderer at line 76
protected string renderPlainText(string $xml)

Render an intermediate representation of plain text

Parameters

string $xml

Intermediate representation

Return Value

string

Rendered result

at line 21
protected string renderRichText(string $xml)

Render an intermediate representation of rich text

Parameters

string $xml

Intermediate representation

Return Value

string

Rendered result

in Renderer at line 104
string getParameter(string $paramName)

Get the value of a parameter

Parameters

string $paramName

Return Value

string

in Renderer at line 114
array getParameters()

Get the values of all parameters

Return Value

array

Associative array of parameter names and values

in Renderer at line 126
void setParameter(string $paramName, mixed $paramValue)

Set the value of a parameter from the stylesheet

Parameters

string $paramName

Parameter name
mixed $paramValue

Parameter's value

Return Value

void

in Renderer at line 137
void setParameters(array $params)

Set the values of several parameters from the stylesheet

Parameters

array $params

Associative array of [parameter name => parameter value]

Return Value

void

in Renderer at line 151
protected void checkUnsupported(string $xml)

Test for the presence of unsupported XML and throw an exception if found

Parameters

string $xml XML

Return Value

void

in Renderer at line 170
protected string decodeSMP(string $str)

Decode encoded characters from the Supplementary Multilingual Plane

Parameters

string $str

Encoded string

Return Value

string

Decoded string

in Renderer at line 186
static protected string decodeEntity(array $m)

Decode a matched SGML entity

Parameters

array $m

Captures from PCRE

Return Value

string

Decoded entity

in Renderer at line 194
protected void restoreLocale()

Restore the original locale

Return Value

void

in Renderer at line 205
protected void setLocale()

Temporarily set the locale to C

Return Value

void