TYPO3\CMS\Fluid\ViewHelpers\Format\PaddingViewHelper Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\Format\PaddingViewHelper:

Public Member Functions
	render ($padLength, $padString=' ', $padType='right')
Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	setArguments (array $arguments)
	setRenderingContext (\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
	injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
	isEscapingInterceptorEnabled ()
	setViewHelperNode (\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\ViewHelperNode $node)
	setRenderChildrenClosure (\Closure $renderChildrenClosure)
	initializeArgumentsAndRender ()
	initialize ()
	renderChildren ()
	prepareArguments ()
	validateArguments ()
	initializeArguments ()
	compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)
	resetState ()

Additional Inherited Members
Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
static	renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	registerArgument ($name, $type, $description, $required=FALSE, $defaultValue=NULL)
	overrideArgument ($name, $type, $description, $required=FALSE, $defaultValue=NULL)
	callRenderMethod ()
	buildRenderChildrenClosure ()
	hasArgument ($argumentName)
Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	$arguments
	$templateVariableContainer
	$controllerContext
	$renderingContext
	$renderChildrenClosure = NULL
	$viewHelperVariableContainer
	$objectManager
	$escapingInterceptorEnabled = TRUE

Detailed Description

Formats a string using PHPs str_pad function.

See also

http://www.php.net/manual/en/function.str_pad.php

= Examples =

<f:format.padding padLength="10">TYPO3</f:format.padding> <output> TYPO3 (note the trailing whitespace) <output>

<f:format.padding padLength="10" padString="-=">TYPO3</f:format.padding> <output> TYPO3-=-=- </output>

<f:format.padding padLength="10" padString="-" padType="both">TYPO3</f:format.padding> <output> –TYPO3— </output>

Definition at line 43 of file PaddingViewHelper.php.

Member Function Documentation

render()

TYPO3\CMS\Fluid\ViewHelpers\Format\PaddingViewHelper::render	(		$padLength,
			$padString = ' ',
			$padType = 'right'
	)

Pad a string to a certain length with another string

Parameters

integer	$padLength	Length of the resulting string. If the value of pad_length is negative or less than the length of the input string, no padding takes place.
string	$padString	The padding string
string	$padType	Append the padding at this site (Possible values: right,left,both. Default: right)

Returns

string The formatted value

Definition at line 54 of file PaddingViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\renderChildren().