ArrayValueByKeyViewHelper.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Install\ViewHelpers\Object;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
use TYPO3\CMS\Install\ViewHelpers\Exception;
use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;

class ArrayValueByKeyViewHelper extends AbstractViewHelper
{
    use CompileWithRenderStatic;

    public function initializeArguments()
    {
        parent::initializeArguments();
        $this->registerArgument('array', 'array', 'The array being processed', true);
        $this->registerArgument('key', 'mixed', 'The key being accessed', true);
    }

    public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
    {
        $array = $arguments['array'];
        $key = $arguments['key'];
        $result = '';
        if (isset($array[$key])) {
            $result = $array[$key];
        }
        if (!is_scalar($result)) {
            throw new Exception(
                'Only scalar return values (string, int, float or double) are supported.',
                1430852128
            );
        }
        return (string)$result;
    }
}