1. class
  2. Neos
  3. \
  4. FluidAdaptor
  5. \
  6. ViewHelpers
  7. \
  8. Format
  9. \
  10. JsonViewHelper

JsonViewHelper

class JsonViewHelper extends AbstractViewHelper (View source)

Wrapper for PHPs json_encode function.

= Examples =

{someArray -> f:format.json()}

<output>
["array","values"]
// depending on the value of {someArray}
</output>

<code title="associative array">
{f:format.json(value: {foo: 'bar', bar: 'baz'})}
{"foo":"bar","bar":"baz"}

{f:format.json(value: {0: 'bar', 1: 'baz'}, forceObject: true)}


<output>
{"0":"bar","1":"baz"}
</output>

Properties

protected ControllerContext $controllerContext

Controller Context to use

 from  AbstractViewHelper
protected ObjectManagerInterface $objectManager from  AbstractViewHelper
protected LoggerInterface $logger from  AbstractViewHelper
protected bool $escapeChildren

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 the arguments.

string
render()

Outputs content with its JSON representation. To prevent issues in HTML context, occurrences of greater-than or less-than characters are converted to their hexadecimal representations.

string
compile(string $argumentsName, string $closureName, string $initializationPhpCode, ViewHelperNode $node, TemplateCompiler $compiler)

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 60
void initializeArguments()

Initialize the arguments.

Return Value

void

at line 77
string render()

Outputs content with its JSON representation. To prevent issues in HTML context, occurrences of greater-than or less-than characters are converted to their hexadecimal representations.

If $forceObject is true a JSON object is outputted even if the value is a non-associative array Example: array('foo', 'bar') as input will not be ["foo","bar"] but {"0":"foo","1":"bar"}

Return Value

string

the JSON-encoded string.

See also

http://www.php.net/manual/en/function.json-encode.php

at line 100
string compile(string $argumentsName, string $closureName, string $initializationPhpCode, ViewHelperNode $node, TemplateCompiler $compiler)

No description

Parameters

string $argumentsName
string $closureName
string $initializationPhpCode
ViewHelperNode $node
TemplateCompiler $compiler

Return Value

string