class CaseViewHelper extends AbstractViewHelper (View source)

Modifies the case of an input string to upper- or lowercase or capitalization.

The default transformation will be uppercase as in mb_convert_case [1].

Possible modes are:

lower Transforms the input string to its lowercase representation

upper Transforms the input string to its uppercase representation

capital Transforms the input string to its first letter upper-cased, i.e. capitalization

uncapital Transforms the input string to its first letter lower-cased, i.e. uncapitalization

capitalWords Transforms the input string to each containing word being capitalized

Note that the behavior will be the same as in the appropriate PHP function mb_convert_case [1]; especially regarding locale and multibyte behavior.

Constants

CASE_LOWER

Directs the input string being converted to "lowercase"

CASE_UPPER

Directs the input string being converted to "UPPERCASE"

CASE_CAPITAL

Directs the input string being converted to "Capital case"

CASE_UNCAPITAL

Directs the input string being converted to "unCapital case"

CASE_CAPITAL_WORDS

Directs the input string being converted to "Capital Case For Each Word"

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

void
injectObjectManager(ObjectManagerInterface $objectManager)

No description

void
injectLogger(LoggerInterface $logger)

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

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.

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.

void
initializeArguments()

Initialize the arguments.

string
render()

Changes the case of the input string

static string
renderStatic(array $arguments, Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)

No description

Details

void setRenderingContext(RenderingContextInterface $renderingContext)

No description

Parameters

RenderingContextInterface $renderingContext

Return Value

void

void injectObjectManager(ObjectManagerInterface $objectManager)

No description

Parameters

ObjectManagerInterface $objectManager

Return Value

void

void injectLogger(LoggerInterface $logger)

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

Parameters

LoggerInterface $logger

Return Value

void

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

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()

bool isEscapingInterceptorEnabled()

No description

Return Value

bool

void initializeArguments()

Initialize the arguments.

Return Value

void

string render()

Changes the case of the input string

Return Value

string

the altered string.

Exceptions

InvalidVariableException

static string renderStatic(array $arguments, Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)

No description

Parameters

array $arguments
Closure $renderChildrenClosure
RenderingContextInterface $renderingContext

Return Value

string

Exceptions

InvalidVariableException