| Current Path : /var/www/surf/TYPO3/vendor/typo3fluid/fluid/src/ViewHelpers/Format/ |
| Current File : /var/www/surf/TYPO3/vendor/typo3fluid/fluid/src/ViewHelpers/Format/PrintfViewHelper.php |
<?php
/*
* This file belongs to the package "TYPO3 Fluid".
* See LICENSE.txt that was shipped with this package.
*/
namespace TYPO3Fluid\Fluid\ViewHelpers\Format;
use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
/**
* A ViewHelper for formatting values with printf. Either supply an array for
* the arguments or a single value.
*
* See http://www.php.net/manual/en/function.sprintf.php
*
* Examples
* ========
*
* Scientific notation
* -------------------
*
* ::
*
* <f:format.printf arguments="{number: 362525200}">%.3e</f:format.printf>
*
* Output::
*
* 3.625e+8
*
* Argument swapping
* -----------------
*
* ::
*
* <f:format.printf arguments="{0: 3, 1: 'Kasper'}">%2$s is great, TYPO%1$d too. Yes, TYPO%1$d is great and so is %2$s!</f:format.printf>
*
* Output::
*
* Kasper is great, TYPO3 too. Yes, TYPO3 is great and so is Kasper!
*
* Single argument
* ---------------
*
* ::
*
* <f:format.printf arguments="{1: 'TYPO3'}">We love %s</f:format.printf>
*
*
* Output::
*
* We love TYPO3
*
* Inline notation
* ---------------
*
* ::
*
* {someText -> f:format.printf(arguments: {1: 'TYPO3'})}
*
*
* Output::
*
* We love TYPO3
*
* @api
*/
class PrintfViewHelper extends AbstractViewHelper
{
use CompileWithContentArgumentAndRenderStatic;
public function initializeArguments()
{
parent::initializeArguments();
$this->registerArgument('value', 'string', 'String to format');
$this->registerArgument('arguments', 'array', 'The arguments for vsprintf', false, []);
}
/**
* Applies vsprintf() on the specified value.
*
* @param array $arguments
* @param \Closure $renderChildrenClosure
* @param \TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface $renderingContext
* @return string
*/
public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
{
return vsprintf($renderChildrenClosure(), $arguments['arguments']);
}
}