1. class
  2. Neos
  3. \
  4. FluidAdaptor
  5. \
  6. ViewHelpers
  7. \
  8. TranslateViewHelper

TranslateViewHelper

class TranslateViewHelper extends AbstractViewHelper (View source)

Returns translated message using source message or key ID.

Also replaces all placeholders with formatted versions of provided values.

= Examples =

Unregistered User ``` translation of label with the id "user.unregistered" and a fallback to "Unregistered User" {f:translate(id: 'some.label.id', value: 'fallback result')} ``` translation of label with the id "some.label.id" and a fallback to "fallback result" ``` translation from custom source "SomeLabelsCatalog" for locale "de_DE" ``` translation from custom source "LabelsCatalog" in "OtherPackage" ``` translation of the label "Untranslated foo and 99.9" Untranslated label ``` translation of the label "Untranslated label"

Properties

protected ControllerContext $controllerContext

Controller Context to use

 from  AbstractViewHelper
protected ObjectManagerInterface $objectManager from  AbstractViewHelper
protected LoggerInterface $logger from  AbstractViewHelper
protected Translator $translator

Methods

void
setRenderingContext(RenderingContextInterface $renderingContext)

No description

from  AbstractViewHelper
void
injectObjectManager(ObjectManagerInterface $objectManager)

No description

from  AbstractViewHelper
void
injectLogger(LoggerInterface $logger)

Injects the (system) logger based on PSR-3.

from  AbstractViewHelper
AbstractViewHelper
registerArgument(string $name, string $type, string $description, bool $required = false, mixed $defaultValue = null, bool|null $escape = null)

Register a new argument. Call this method from your ViewHelper subclass inside the initializeArguments() method.

from  AbstractViewHelper
AbstractViewHelper
overrideArgument(string $name, string $type, string $description, bool $required = false, mixed $defaultValue = null, bool|null $escape = null)

Overrides a registered argument. Call this method from your ViewHelper subclass inside the initializeArguments() method if you want to override a previously registered argument.

from  AbstractViewHelper
bool
isEscapingInterceptorEnabled()

No description

from  AbstractViewHelper
void
initializeArguments()

Initialize arguments

string
render()

Renders the translated label.

injectTranslator(Translator $translator)

No description

Details

in AbstractViewHelper at line 52
void setRenderingContext(RenderingContextInterface $renderingContext)

No description

Parameters

RenderingContextInterface $renderingContext

Return Value

void

in AbstractViewHelper at line 65
void injectObjectManager(ObjectManagerInterface $objectManager)

No description

Parameters

ObjectManagerInterface $objectManager

Return Value

void

in AbstractViewHelper at line 76
void injectLogger(LoggerInterface $logger)

Injects the (system) logger based on PSR-3.

Parameters

LoggerInterface $logger

Return Value

void

in AbstractViewHelper at line 97
protected AbstractViewHelper registerArgument(string $name, string $type, string $description, bool $required = false, mixed $defaultValue = null, bool|null $escape = null)

Register a new argument. Call this method from your ViewHelper subclass inside the initializeArguments() method.

This exists only to throw our own exception!

Parameters

string $name

Name of the argument
string $type

Type of the argument
string $description

Description of the argument
bool $required

If true, argument is required. Defaults to false.
mixed $defaultValue

Default value of argument
bool|null $escape

Can be toggled to TRUE to force escaping of variables and inline syntax passed as argument value.

Return Value

AbstractViewHelper

$this, to allow chaining.

Exceptions

Exception

in AbstractViewHelper at line 123
protected AbstractViewHelper overrideArgument(string $name, string $type, string $description, bool $required = false, mixed $defaultValue = null, bool|null $escape = null)

Overrides a registered argument. Call this method from your ViewHelper subclass inside the initializeArguments() method if you want to override a previously registered argument.

This exists only to throw our own exception!

Parameters

string $name

Name of the argument
string $type

Type of the argument
string $description

Description of the argument
bool $required

If true, argument is required. Defaults to false.
mixed $defaultValue

Default value of argument
bool|null $escape

Can be toggled to TRUE to force escaping of variables and inline syntax passed as argument value.

Return Value

AbstractViewHelper

$this, to allow chaining.

Exceptions

Exception

See also

registerArgument()

in AbstractViewHelper at line 134
bool isEscapingInterceptorEnabled()

No description

Return Value

bool

at line 85
void initializeArguments()

Initialize arguments

Return Value

void

at line 105
string render()

Renders the translated label.

Replaces all placeholders with corresponding values if they exist in the translated label.

Return Value

string

Translated label or source label / ID key

Exceptions

Exception

at line 154
injectTranslator(Translator $translator)

No description

Parameters

Translator $translator