Format/CaseViewHelper.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Fluid\ViewHelpers\Format;

/*                                                                        *
 * This script is backported from the TYPO3 Flow package "TYPO3.Fluid".   *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License, either version 3   *
 *  of the License, or (at your option) any later version.                *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */

use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
use TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException;
use TYPO3\CMS\Core\Charset\CharsetConverter;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Fluid\Core\ViewHelper\Facets\CompilableInterface;
use TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface;

class CaseViewHelper extends AbstractViewHelper implements CompilableInterface
{
    const CASE_LOWER = 'lower';

    const CASE_UPPER = 'upper';

    const CASE_CAPITAL = 'capital';

    const CASE_UNCAPITAL = 'uncapital';

    const CASE_CAPITAL_WORDS = 'capitalWords';

    protected static $charsetConverter = null;

    public function render($value = null, $mode = self::CASE_UPPER)
    {
        return static::renderStatic(
            array(
                'value' => $value,
                'mode' => $mode,
            ),
            $this->buildRenderChildrenClosure(),
            $this->renderingContext
        );
    }

    public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
    {
        $value = $arguments['value'];
        $mode = $arguments['mode'];

        if ($value === null) {
            $value = $renderChildrenClosure();
        }

        if (is_null(static::$charsetConverter)) {
            static::$charsetConverter = GeneralUtility::makeInstance(CharsetConverter::class);
        }
        $charsetConverter = static::$charsetConverter;

        switch ($mode) {
            case self::CASE_LOWER:
                $output = $charsetConverter->conv_case('utf-8', $value, 'toLower');
                break;
            case self::CASE_UPPER:
                $output = $charsetConverter->conv_case('utf-8', $value, 'toUpper');
                break;
            case self::CASE_CAPITAL:
                $output = $charsetConverter->utf8_substr($charsetConverter->convCaseFirst('utf-8', $value, 'toUpper'), 0, 1) . $charsetConverter->utf8_substr($value, 1);
                break;
            case self::CASE_UNCAPITAL:
                $output = $charsetConverter->utf8_substr($charsetConverter->convCaseFirst('utf-8', $value, 'toLower'), 0, 1) . $charsetConverter->utf8_substr($value, 1);
                break;
            case self::CASE_CAPITAL_WORDS:
                // @todo: Implement method once there is a proper solution with using the CharsetConverter
            default:
                throw new InvalidVariableException('The case mode "' . $mode . '" supplied to Fluid\'s format.case ViewHelper is not supported.', 1358349150);
        }

        return $output;
    }
}